-
-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cd9733c
docs: Document how to ship OTEL traces
sbernauer befda4e
Update docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc
sbernauer 96a5db1
Apply suggestions from code review
sbernauer eb93a29
Update docs/modules/opa/pages/usage-guide/OpenTelemetry.adoc
sbernauer f816d4d
mention GitHub issue
sbernauer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 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. | ||
sbernauer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
adwk67 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
sbernauer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [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.
Uh oh!
There was an error while loading. Please reload this page.