Skip to content

Commit b0f4318

Browse files
authored
Added OTEL contributor docs (#39285)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #38607
1 parent 2935236 commit b0f4318

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/Contributing/reference/configuration-for-contributors.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,36 @@ If set to `true`, Fleet allows users to add the [SoftwareUpdateEnforcementSpecif
210210
enable_custom_os_updates_and_filevault: true
211211
```
212212

213+
### logging.tracing_enabled
214+
215+
Enables OpenTelemetry tracing and metrics export. When enabled, traces and metrics are sent to the OTLP endpoint configured via the standard `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable.
216+
217+
By default, OpenTelemetry is used. Set `tracing_type` to `elasticapm` only if you want to use Elastic APM instead.
218+
219+
- Default value: `false`
220+
- Environment variable: `FLEET_LOGGING_TRACING_ENABLED`
221+
- Config file format:
222+
```yaml
223+
logging:
224+
tracing_enabled: true
225+
# tracing_type: elasticapm # Only set if using Elastic APM instead of OpenTelemetry
226+
```
227+
228+
### logging.otel_logs_enabled
229+
230+
Enables exporting logs to an OpenTelemetry collector in addition to stderr output. When enabled, logs are sent to the OTLP endpoint configured via the standard `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable. Logs are automatically correlated with traces via `trace_id` and `span_id` attributes.
231+
232+
> **Note:** This option requires `logging.tracing_enabled` to be set to `true`. Fleet will fail to start if `otel_logs_enabled` is `true` but `tracing_enabled` is `false`.
233+
234+
- Default value: `false`
235+
- Environment variable: `FLEET_LOGGING_OTEL_LOGS_ENABLED`
236+
- Config file format:
237+
```yaml
238+
logging:
239+
tracing_enabled: true
240+
otel_logs_enabled: true
241+
```
242+
213243
### FLEET_ENABLE_POST_CLIENT_DEBUG_ERRORS
214244

215245
Use this environment variable to allow `fleetd` to report errors to the server using the [endpoint to report an agent error](./API-for-contributors.md#report-an-agent-error). `fleetd` agents will always report vital errors to Fleet.

0 commit comments

Comments
 (0)