Skip to content

docs: Add telemetry documentation page #731

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.

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions modules/concepts/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*** xref:operations/graceful_shutdown.adoc[]
*** xref:operations/temporary_credentials_lifetime.adoc[]
** Observability
*** xref:labels.adoc[]
*** xref:logging.adoc[]
*** xref:containerdebug.adoc[]
*** xref:labels.adoc[Labels]
*** xref:logging.adoc[Logging]
*** xref:containerdebug.adoc[Container environment]
*** xref:observability/telemetry.adoc[Telemetry]
** xref:container-images.adoc[]
32 changes: 32 additions & 0 deletions modules/concepts/pages/observability/telemetry.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
= Telemetry signals in operators

Since SDP 25.7.0, all Stackable operators emit multiple signals for telemetry data.
Currently supported signals are:

* Console logs in plain and JSON format
* (Rolling) file logs in JSON format
* OpenTelemetry logs exported via OTLP
* OpenTelemetry traces exported via OTLP

Every signal can be toggled and customized using Helm values.
All fields are grouped under the top-level `telemetry` section.
The following sections describe the available fields their default and supported values.

== Console logs

This signal prints log messages at the selected level and in the selected format to STDOUT.
These logs are useful for quick debugging.
For a more complete debugging experience, we recommend the OpenTelemetry signals.

[source,yaml]
----
telemetry:
consoleLog:
enabled: true # true, false
level: null # error, warning, info, debug, trace
format: null # plain, json
----

== File logs

== OpenTelemetry logs and traces
Loading