Enum holochain_metrics::HolochainMetricsConfig

pub enum HolochainMetricsConfig {
    Disabled,
    InfluxiveExternal {
        writer_config: InfluxiveWriterConfig,
        otel_config: InfluxiveMeterProviderConfig,
        host: String,
        bucket: String,
        token: String,
    },
    InfluxiveChildSvc {
        child_svc_config: Box<InfluxiveChildSvcConfig>,
        otel_config: InfluxiveMeterProviderConfig,
    },
}

Configuration for holochain metrics.

Variants

Disabled

Metrics are disabled.

InfluxiveExternal

Use influxive to connect to an already running InfluxDB instance. NOTE: this means we cannot initialize any dashboards.

Fields

writer_config: InfluxiveWriterConfig

The writer config for connecting to the external influxdb instance.

otel_config: InfluxiveMeterProviderConfig

The meter provider config for setting up opentelemetry.

host: String

The url for the external influxdb instance.

bucket: String

The bucket to write to in this external influxdb instance.

token: String

The authentication token to use for writing to this external influxdb instance.

InfluxiveChildSvc

Use influxive as a child service to write metrics.

Fields

child_svc_config: Box<InfluxiveChildSvcConfig>

The child service config for running the influxd server.

otel_config: InfluxiveMeterProviderConfig

The meter provider config for setting up opentelemetry.

Implementations

impl HolochainMetricsConfig

pub fn new(root_path: &Path) -> Self

Initialize a new default metrics config.

The output of this function is largely controlled by environment variables, please see the crate-level documentation for usage.

pub async fn init(self)

Initialize holochain metrics based on this configuration.