Struct ckb_metrics_config::Config

pub struct Config {
    pub threads: usize,
    pub histogram_window: u64,
    pub histogram_granularity: u64,
    pub upkeep_interval: u64,
    pub exporter: HashMap<String, Exporter>,
}

The whole CKB metrics configuration.

This struct is used to configure CKB metrics service: builds one metrics_runtime::Receiver and any number of exporters

An example which is used in ckb.toml:

[metrics]
threads = 3
histogram_window = 60
histogram_granularity = 1
upkeep_interval = 500
[metrics.exporter.prometheus]
target = { type = "http", listen_address = "127.0.0.1:8100" }
format = { type = "prometheus" }
[metrics.exporter.log_yaml]
target = { type = "log", level = "warn", interval = 600 }
format = { type = "yaml" }
[metrics.exporter.log_json]
target = { type = "log", level = "error", interval = 900 }
format = { type = "json" }

Fields

threads: usize

How many threads are required for metrics service.

histogram_window: u64

Sets the histogram window configuration in seconds.

histogram_granularity: u64

Sets the histogram granularity configuration in seconds.

upkeep_interval: u64

Sets the upkeep interval configuration in milliseconds.

exporter: HashMap<String, Exporter>

Stores all exporters configurations.

Trait Implementations

impl Clone for Config

pub fn clone(&self) -> Config

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

pub fn default() -> Config

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Config

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.