chore: document metrics config switches as private API (#9865)

This commit is contained in:
Thomas Eizinger
2025-07-14 15:53:03 +02:00
committed by GitHub
parent f5425ac8e4
commit 2e0ed018ee
2 changed files with 9 additions and 0 deletions

View File

@@ -283,12 +283,18 @@ struct Cli {
tun_threads: NumThreads,
/// Where to export metrics to.
///
/// This configuration option is private API and has no stability guarantees.
/// It may be removed / changed anytime.
#[arg(long, hide = true, env = "FIREZONE_METRICS")]
metrics: Option<MetricsExporter>,
/// Send metrics to a custom OTLP collector.
///
/// By default, Firezone's hosted OTLP collector is used.
///
/// This configuration option is private API and has no stability guarantees.
/// It may be removed / changed anytime.
#[arg(long, env, hide = true)]
otlp_grpc_endpoint: Option<String>,

View File

@@ -102,6 +102,9 @@ struct Cli {
no_telemetry: bool,
/// Dump internal metrics to stdout every 60s.
///
/// This configuration option is private API and has no stability guarantees.
/// It may be removed / changed anytime.
#[arg(long, hide = true, env = "FIREZONE_METRICS")]
metrics: Option<MetricsExporter>,