Skip to content

Commit

Permalink
Update CONFIG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
george-dorin committed Oct 12, 2023
1 parent 1f6896d commit 58cf793
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
4 changes: 4 additions & 0 deletions core/config/docs/core.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 14 additions & 0 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 58cf793

Please sign in to comment.