Skip to content

Commit

Permalink
make config-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pkcll committed Nov 8, 2024
1 parent 0e98e5d commit 8bc9e7f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
4 changes: 2 additions & 2 deletions core/config/docs/core.toml
Original file line number Diff line number Diff line change
Expand Up @@ -706,9 +706,9 @@ CACertFile = 'cert-file' # Example
InsecureConnection = false # Default
# TraceSampleRatio is the rate at which to sample traces. Must be between 0 and 1.
TraceSampleRatio = 0.01 # Default
# Enables batching for telemetry events
# EmitterBatchProcessor enables batching for telemetry events
EmitterBatchProcessor = true # Default
# Sets export timeout for telemetry events
# EmitterExportTimeout sets timeout for exporting telemetry events
EmitterExportTimeout = "1s" # Default

# ResourceAttributes are global metadata to include with all telemetry.
Expand Down
14 changes: 14 additions & 0 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -1905,6 +1905,8 @@ Endpoint = 'example.com/collector' # Example
CACertFile = 'cert-file' # Example
InsecureConnection = false # Default
TraceSampleRatio = 0.01 # Default
EmitterBatchProcessor = true # Default
EmitterExportTimeout = "1s" # Default
```
Telemetry holds OTEL settings.
This data includes open telemetry metrics, traces, & logs.
Expand Down Expand Up @@ -1942,6 +1944,18 @@ TraceSampleRatio = 0.01 # Default
```
TraceSampleRatio is the rate at which to sample traces. Must be between 0 and 1.

### EmitterBatchProcessor
```toml
EmitterBatchProcessor = true # Default
```
EmitterBatchProcessor enables batching for telemetry events

### EmitterExportTimeout
```toml
EmitterExportTimeout = "1s" # Default
```
EmitterExportTimeout sets timeout for exporting telemetry events

## Telemetry.ResourceAttributes
```toml
[Telemetry.ResourceAttributes]
Expand Down

0 comments on commit 8bc9e7f

Please sign in to comment.