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.

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

wants to merge 2 commits into from

Conversation

sbernauer
Copy link
Member

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

  • Changes are OpenShift compatible
  • CRD changes approved
  • CRD documentation for all fields, following the style guide.
  • Helm chart can be installed and deployed operator works
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible
  • Links to generated (nightly) docs added
  • Release note snippet added

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

@sbernauer sbernauer self-assigned this Aug 4, 2025
@sbernauer sbernauer requested a review from a team August 4, 2025 14:16
@sbernauer sbernauer moved this to Development: Waiting for Review in Stackable Engineering Aug 4, 2025
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should probably hold off this one until we support config overrides.

Apologies if this had already been discussed and agreed on.

@sbernauer
Copy link
Member Author

I see your point, on the other hand I don't think we will get configOverrides in the next year or two 🙈
Reason is that the usual BTreeMap<String, String> approach doesn't work for the json config of OPA.
Would you also hold off that long?

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Please check the {opa-docs}[OPA documentation] on how other settings you can configure.
Please check the {opa-docs}[OPA documentation] to see how you can configure other settings.


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

As at SDP 25.7, `configOverrides` are not supported.
Copy link
Member

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)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Development: Waiting for Review
Development

Successfully merging this pull request may close these issues.

3 participants