docs: Document how to ship OTEL traces #753
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| [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" | ||||||
| } | ||||||
| } | ||||||
| ---- | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this mean that we never supported it but will do in the future (as is suggested below, and which seems to be the case from the changelog), or that we are temporarily not supporting it (but will do again at some point)?