Skip to content

Commit 415d85e

Browse files
authored
Fix telemetry docs (#794)
* Replace warning level with warn. * Update help for telemetry level filters * Update URL for directives * Use a link variable * Open link in new tab I chose not to move the title `[]` bit to the url definition so that it still reads well as text
1 parent 055e48a commit 415d85e

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

modules/concepts/pages/observability/telemetry.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Telemetry signals in operators
2+
:env-filter-syntax: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax
23

34
[NOTE]
45
====
@@ -46,9 +47,9 @@ telemetry:
4647
format: null # <3>
4748
----
4849

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

5354
== File logs
5455

@@ -65,9 +66,9 @@ telemetry:
6566
maxFiles: 6 # <4>
6667
----
6768

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

7374
== OpenTelemetry logs and traces
@@ -88,6 +89,6 @@ telemetry:
8889
endpoint: null # <3>
8990
----
9091

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

0 commit comments

Comments
 (0)