From cd9733cb57df2d59d69bc48ec58cc509fd434093 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Mon, 4 Aug 2025 16:15:46 +0200 Subject: [PATCH 1/5] docs: Document how to ship OTEL traces --- .../opa/pages/usage-guide/OpenTelemetry.adoc | 30 +++++++++++++++++++ .../configuration-environment-overrides.adoc | 2 +- docs/modules/opa/partials/nav.adoc | 1 + 3 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc diff --git a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc new file mode 100644 index 00000000..3defecf3 --- /dev/null +++ b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc @@ -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 of SDP 25.7 we don't support `configOverrides`. +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 `-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" + } + } +---- diff --git a/docs/modules/opa/pages/usage-guide/configuration-environment-overrides.adoc b/docs/modules/opa/pages/usage-guide/configuration-environment-overrides.adoc index fe6a71e6..6ce013dc 100644 --- a/docs/modules/opa/pages/usage-guide/configuration-environment-overrides.adoc +++ b/docs/modules/opa/pages/usage-guide/configuration-environment-overrides.adoc @@ -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 diff --git a/docs/modules/opa/partials/nav.adoc b/docs/modules/opa/partials/nav.adoc index a1a1d0e4..f354d583 100644 --- a/docs/modules/opa/partials/nav.adoc +++ b/docs/modules/opa/partials/nav.adoc @@ -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[] From befda4e9b03dfe7b3801451ddecc81b5a35d7b17 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Tue, 5 Aug 2025 11:19:37 +0200 Subject: [PATCH 2/5] Update docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com> --- docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc index 3defecf3..f3477589 100644 --- a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc +++ b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc @@ -4,7 +4,7 @@ Opa supports sending OpenTelemetry traces as stated in {opa-docs}[the documentation]. -As of SDP 25.7 we don't support `configOverrides`. +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. From 96a5db13b7b6bae5604d1cf165e64cd337150914 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Mon, 11 Aug 2025 12:39:36 +0200 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Andrew Kenworthy <1712947+adwk67@users.noreply.github.com> --- docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc index f3477589..c7d595fa 100644 --- a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc +++ b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc @@ -7,7 +7,7 @@ Opa supports sending OpenTelemetry traces as stated in {opa-docs}[the documentat 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. +WARNING: It's not encouraged to pause the reconciliation more than just temporarily. 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 `-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. From eb93a29fa3b418808dfb79b07aa6e6244558a8dc Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Mon, 11 Aug 2025 13:09:25 +0200 Subject: [PATCH 4/5] Update docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc --- docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc index c7d595fa..b06a34f4 100644 --- a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc +++ b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc @@ -10,7 +10,7 @@ To enable traces you need to modify the config and thus xref:opa:usage-guide/ope WARNING: It's not encouraged to pause the reconciliation more than just temporarily. 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 `-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. +Please check the {opa-docs}[OPA documentation] to see what other settings you can configure. [source,yaml] ---- From f816d4d5e53b3830826cb232fb27f0d734d01269 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Mon, 11 Aug 2025 13:37:35 +0200 Subject: [PATCH 5/5] mention GitHub issue --- docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc index b06a34f4..f592b089 100644 --- a/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc +++ b/docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc @@ -4,7 +4,7 @@ Opa supports sending OpenTelemetry traces as stated in {opa-docs}[the documentation]. -As at SDP 25.7, `configOverrides` are not supported. +As of SDP 25.7, `configOverrides` are (still) not supported, we are tracking the progress in https://github.com/stackabletech/opa-operator/issues/756[this GitHub issue]. 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 more than just temporarily. 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.