diff --git a/core/config/docs/core.toml b/core/config/docs/core.toml index 39a7369ccc2..ce268f169ad 100644 --- a/core/config/docs/core.toml +++ b/core/config/docs/core.toml @@ -88,6 +88,10 @@ LeaseRefreshInterval = '1s' # Default UniConn = true # Default # Logging toggles verbose logging of the raw telemetry messages being sent. Logging = false # Default +# ServerPubKey is the public key of the telemetry server. This field will be removed in a furture version +ServerPubKey = 'test-pub-key' # Example +# URL is where to send telemetry. This field will be removed in a furture version +URL = 'https://prom.test' # Example # BufferSize is the number of telemetry messages to buffer before dropping new ones. BufferSize = 100 # Default # MaxBatchSize is the maximum number of messages to batch into one telemetry request. diff --git a/docs/CONFIG.md b/docs/CONFIG.md index a8c97eff969..2efc6062627 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -244,6 +244,8 @@ LeaseRefreshInterval determines how often to refresh the lease lock. Also contro [TelemetryIngress] UniConn = true # Default Logging = false # Default +ServerPubKey = 'test-pub-key' # Example +URL = 'https://prom.test' # Example BufferSize = 100 # Default MaxBatchSize = 50 # Default SendInterval = '500ms' # Default @@ -264,6 +266,18 @@ Logging = false # Default ``` Logging toggles verbose logging of the raw telemetry messages being sent. +### ServerPubKey +```toml +ServerPubKey = 'test-pub-key' # Example +``` +ServerPubKey is the public key of the telemetry server. This field will be removed in a furture version + +### URL +```toml +URL = 'https://prom.test' # Example +``` +URL is where to send telemetry. This field will be removed in a furture version + ### BufferSize ```toml BufferSize = 100 # Default