Skip to content

Fix telemetry docs #794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NickLarsenNZ merged 5 commits into from
Nov 4, 2025
Merged

Fix telemetry docs #794

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
de94d65
Replace warning level with warn.
NickLarsenNZ Nov 4, 2025
c0cfa20
Update help for telemetry level filters
NickLarsenNZ Nov 4, 2025
c9eb595
Update URL for directives
NickLarsenNZ Nov 4, 2025
ee95f36
Use a link variable
NickLarsenNZ Nov 4, 2025
af0cd3a
Open link in new tab
NickLarsenNZ Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions modules/concepts/pages/observability/telemetry.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Telemetry signals in operators
:env-filter-syntax: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax

[NOTE]
====
Expand Down Expand Up @@ -46,9 +47,9 @@ telemetry:
format: null # <3>
----

<1> Boolean: `true, false`
<2> Enum: `error, warning, info, debug, trace`
<3> Enum: `plain, json`
<1> Boolean: `true`, `false`
<2> String: `error`, `warn`, `info`, `debug`, `trace`, `off` (or {env-filter-syntax}[more complex filters,window=_blank])
<3> Enum: `plain`, `json`

== File logs

Expand All @@ -65,9 +66,9 @@ telemetry:
maxFiles: 6 # <4>
----

<1> Boolean: `true, false`
<2> Enum: `error, warning, info, debug, trace`
<3> Enum: `never, daily, hourly, minutely`
<1> Boolean: `true`, `false`
<2> String: `error`, `warn`, `info`, `debug`, `trace`, `off` (or {env-filter-syntax}[more complex filters,window=_blank])
<3> Enum: `never`, `daily`, `hourly`, `minutely`
<4> Unsigned Integer

== OpenTelemetry logs and traces
Expand All @@ -88,6 +89,6 @@ telemetry:
endpoint: null # <3>
----

<1> Boolean: `true, false`
<2> Enum: `error, warning, info, debug, trace`
<3> String: E.g. `my-collector:4317`
<1> Boolean: `true`, `false`
<2> String: `error`, `warn`, `info`, `debug`, `trace`, `off` (or {env-filter-syntax}[more complex filters,window=_blank])
<3> String: E.g. `https://my-collector:4317` (Note: it must contain the scheme)
Loading