From 2e0ed018ee22b555714f3546c4a958fb384936a1 Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Mon, 14 Jul 2025 15:53:03 +0200 Subject: [PATCH] chore: document metrics config switches as private API (#9865) --- rust/gateway/src/main.rs | 6 ++++++ rust/headless-client/src/main.rs | 3 +++ 2 files changed, 9 insertions(+) diff --git a/rust/gateway/src/main.rs b/rust/gateway/src/main.rs index a0b7a74b4..01d911173 100644 --- a/rust/gateway/src/main.rs +++ b/rust/gateway/src/main.rs @@ -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, /// 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, diff --git a/rust/headless-client/src/main.rs b/rust/headless-client/src/main.rs index 54dc501fd..711de4e81 100644 --- a/rust/headless-client/src/main.rs +++ b/rust/headless-client/src/main.rs @@ -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,