Skip to content

Commit cd9733c

Browse files
committed
docs: Document how to ship OTEL traces
1 parent fa1cc76 commit cd9733c

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
= OpenTelemetry
2+
:description: Ship OPA traces and logs to OpenTelemetry
3+
:opa-docs: https://v1-4-2--opa-docs.netlify.app/configuration/#distributed-tracing
4+
5+
Opa supports sending OpenTelemetry traces as stated in {opa-docs}[the documentation].
6+
7+
As of SDP 25.7 we don't support `configOverrides`.
8+
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.
9+
10+
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.
11+
12+
Afterwards you can edit the `<stacklet-name>-server-default` ConfigMap and append a `distributed_tracing` section as follows.
13+
Please check the {opa-docs}[OPA documentation] on how other settings you can configure.
14+
15+
[source,yaml]
16+
----
17+
apiVersion: v1
18+
kind: ConfigMap
19+
metadata:
20+
name: opa-server-default
21+
data:
22+
config.json: |-
23+
{
24+
<<< existing JSON >>>
25+
"distributed_tracing": {
26+
"address": "jaeger-collector.default.svc.cluster.local:4317",
27+
"type": "grpc"
28+
}
29+
}
30+
----

docs/modules/opa/pages/usage-guide/configuration-environment-overrides.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This will lead to faulty installations.
88

99
== Configuration properties
1010

11-
Currently, not supported for `config.yaml`.
11+
Currently, not supported for `config.json`.
1212

1313
== Environment variables
1414

docs/modules/opa/partials/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
** xref:opa:usage-guide/resources.adoc[]
99
** xref:opa:usage-guide/logging.adoc[]
1010
** xref:opa:usage-guide/monitoring.adoc[]
11+
** xref:opa:usage-guide/OpenTelemetry.adoc[]
1112
** xref:opa:usage-guide/configuration-environment-overrides.adoc[]
1213
** xref:opa:usage-guide/operations/index.adoc[]
1314
*** xref:opa:usage-guide/operations/cluster-operations.adoc[]

0 commit comments

Comments
 (0)