Metric...Adapter(3pm)

💖 Metrics::Any::Adapter 💖

okay so bestie, gather round, because this one is literally the plug for your whole metrics sitch 🫶 it's Metrics::Any::Adapter — the thing that sets the Metrics::Any adapter for the program. that's it, that's the whole job, and she does it flawlessly 💅

---

✨ SYNOPSIS ✨

you drop this bad boy in a program or a top-level program-like module:

use Metrics::Any::Adapter 'Prometheus';

and boom 💥 metrics go brrr. that's the vibe.

---

🌸 DESCRIPTION 🌸

so here's the tea ☕ — the use statement that loads this module sets the adapter module for Metrics::Any so it can report all the metrics generated by the modules your program uses. very main character of it, honestly.

the first value you pass in should be a string with the name of an adapter module, and that name is expected to live under the Metrics::Any::Adapter:: prefix. this module gets loaded and set as the adapter to use, periodt. any additional arguments you tack on get handed straight to the constructor of that adapter instance. slay.

use Metrics::Any::Adapter Custom => "another arg";

# implies
$adapter = Metrics::Any::Adapter::Custom->new( "another arg" );

see how that works? the extra stuff just gets yeeted into new. iconic 💫

---

🌈 ENVIRONMENT 🌈

🦋 METRICS_ANY_ADAPTER

okay so this one's been around since version 0.04 ⭐

it sets the default adapter type to use if the program has not otherwise requested one. like, a lil fallback bestie. a safety net. we love her.

normally this is set to Null, which loads Metrics::Any::Adapter::Null. but if you override it to a different value, you can load a default adapter without modifying the program at all. chef's kiss 🎀 super handy for stuff like running unit tests:

$ METRICS_ANY_ADAPTER=Stderr ./Build test

and yes, you can pass additional arguments after a colon, separated by commas or equals signs. go off:

$ METRICS_ANY_ADAPTER=File:path=metrics.log ./program.pl

⚠️ but heads up bestie: if a program requests a specific adapter, that request will override this variable. the program's choice wins, no cap.

there's also a limited attempt at supporting nested arguments wrapped in square brackets, so the Metrics::Any::Adapter::Tee adapter can do its lil thing via this variable and pass arguments into child adapters:

$ METRICS_ANY_ADAPTER=Tee:Prometheus,[File:path=metrics.log] perl ...

now, this is very much a best-effort scenario — useful for short-term testing and debugging, and that's it. for anything more complex in your script or program, it's better to use the import arguments directly, because then any perl data structures can be passed around. lowkey the superior move, fr fr.

---

👑 AUTHOR 👑

Paul Evans <leonerd@leonerd.org.uk>

---

and that's the whole page, bestie 💜 this was Metric...Adapter(3pm) from perl v5.36.0, dated 2023-09-29 — go forth and instrument everything, you've got this 🌟💖✨