Skip to content

docs: Document how to ship OTEL traces #753

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Document how to ship OTEL traces #753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd9733c
docs: Document how to ship OTEL traces
sbernauer Aug 4, 2025
befda4e
Update docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc
sbernauer Aug 5, 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
30 changes: 30 additions & 0 deletions docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
= OpenTelemetry
:description: Ship OPA traces and logs to OpenTelemetry
:opa-docs: https://v1-4-2--opa-docs.netlify.app/configuration/#distributed-tracing

Opa supports sending OpenTelemetry traces as stated in {opa-docs}[the documentation].

As at SDP 25.7, `configOverrides` are not supported.
To enable traces you need to modify the config and thus xref:opa:usage-guide/operations/cluster-operations.adoc[pause the reconciliation] of your OpaCluster, so that changes to the ConfigMap aren't immediately overridden by the opa-operator.

WARNING: It's not encouraged to pause the reconciliation longer than temporary. We recommend disabling it while you debug e.g. performance problems and re.enabling it afterwards. This problem will be solved once we support configOverrides for OPA.

Afterwards you can edit the `<stacklet-name>-server-default` ConfigMap and append a `distributed_tracing` section as follows.
Please check the {opa-docs}[OPA documentation] on how other settings you can configure.

[source,yaml]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: opa-server-default
data:
config.json: |-
{
<<< existing JSON >>>
"distributed_tracing": {
"address": "jaeger-collector.default.svc.cluster.local:4317",
"type": "grpc"
}
}
----
2 changes: 1 addition & 1 deletion docs/modules/opa/pages/usage-guide/configuration-environment-overrides.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This will lead to faulty installations.

== Configuration properties

Currently, not supported for `config.yaml`.
Currently, not supported for `config.json`.

== Environment variables

Expand Down
1 change: 1 addition & 0 deletions docs/modules/opa/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
** xref:opa:usage-guide/resources.adoc[]
** xref:opa:usage-guide/logging.adoc[]
** xref:opa:usage-guide/monitoring.adoc[]
** xref:opa:usage-guide/OpenTelemetry.adoc[]
** xref:opa:usage-guide/configuration-environment-overrides.adoc[]
** xref:opa:usage-guide/operations/index.adoc[]
*** xref:opa:usage-guide/operations/cluster-operations.adoc[]
Expand Down