Skip to content

Commit 9f996a9

Browse files
committed
wip: Add telemetry docs
1 parent af50313 commit 9f996a9

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

modules/concepts/nav.adoc

+4-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
*** xref:operations/graceful_shutdown.adoc[]
2323
*** xref:operations/temporary_credentials_lifetime.adoc[]
2424
** Observability
25-
*** xref:labels.adoc[]
26-
*** xref:logging.adoc[]
27-
*** xref:containerdebug.adoc[]
25+
*** xref:labels.adoc[Labels]
26+
*** xref:logging.adoc[Logging]
27+
*** xref:containerdebug.adoc[Container environment]
28+
*** xref:observability/telemetry.adoc[Telemetry]
2829
** xref:container-images.adoc[]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
= Telemetry signals in operators
2+
3+
Since SDP 25.7.0, all Stackable operators emit multiple signals for telemetry data.
4+
Currently supported signals are:
5+
6+
* Console logs in plain and JSON format
7+
* (Rolling) file logs in JSON format
8+
* OpenTelemetry logs exported via OTLP
9+
* OpenTelemetry traces exported via OTLP
10+
11+
Every signal can be toggled and customized using Helm values.
12+
All fields are grouped under the top-level `telemetry` section.
13+
The following sections describe the available fields their default and supported values.
14+
15+
== Console logs
16+
17+
This signal prints log messages at the selected level and in the selected format to STDOUT.
18+
These logs are useful for quick debugging.
19+
For a more complete debugging experience, we recommend the OpenTelemetry signals.
20+
21+
[source,yaml]
22+
----
23+
telemetry:
24+
consoleLog:
25+
enabled: true # true, false
26+
level: null # error, warning, info, debug, trace
27+
format: null # plain, json
28+
----
29+
30+
== File logs
31+
32+
== OpenTelemetry logs and traces

0 commit comments

Comments
 (0)