Enum twitch_irc::MetricsConfig
source · pub enum MetricsConfig {
Disabled,
Enabled {
constant_labels: HashMap<String, String>,
metrics_registry: Option<Registry>,
},
}
Expand description
Used to configure the options around metrics collection using the prometheus
crate.
Variants§
Disabled
Metrics are not collected. Metrics are not registered with any registry.
Useful if an application only requires monitoring on some of its running twitch-irc
clients.
Enabled
Fields
constant_labels: HashMap<String, String>
Add these “constant labels” to all metrics produced by this client. This allows you to, for example, differentiate between multiple clients by naming them, or you may wish to place other relevant metadata pertaining to the whole client on all the metrics.
This defaults to an empty map.
metrics_registry: Option<Registry>
Specifies what Registry
to register all metrics for this
client with.
Defaults to None
, in which case the metrics are registered with the
global default registry of the prometheus
crate.
Metrics are collected. The metrics are immediately registered when
TwitchIRCClient::new
is called.