Skip to content
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

Add OTLP authentication section to ./java/sdk.md #5866

Merged
merged 7 commits into from
Jan 6, 2025

Conversation

jack-berg
Copy link
Member

@jack-berg jack-berg commented Jan 2, 2025

In opentelemetry-java, we receive recurring questions about how to accommodate various authentication requirements with OTLP exporters. This PR adds a new "Appendix -> OTLP exporters -> Authentication" section, including a code snippet demonstrating how programmatic config can be used to provide a dynamic authentication credential, such as a JWT.

Depends on first merging open-telemetry/opentelemetry-java-examples#565 and updating this PR with the updated opentelemetry-java-examples hash.


Preview: https://deploy-preview-5866--opentelemetry.netlify.app/docs/languages/java/sdk/

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Quick question: is the update of content-modules/opentelemetry-java-examples intentional, and essential in the scope of this doc addition?

As you can see from https://github.com/open-telemetry/opentelemetry.io/actions/runs/12588143748/job/35085436884?pr=5866, the check is failing because the submodule isn't pinned right (or it is pinned right and the submodule update needs to be rolled back).

(Oops, I just read the rest of your opening comment and see that the submodule update is likely intentional, and pending committed changes to that repo. Once the repo is updated, this PR will need to update the submodule PIN ID.)

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

See inline for comments on the prose.

content/en/docs/languages/java/sdk.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/sdk.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/sdk.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/sdk.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/sdk.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/sdk.md Outdated Show resolved Hide resolved
@chalin chalin force-pushed the otlp-authentication branch from e97d94d to dfd71eb Compare January 4, 2025 17:32
@opentelemetrybot opentelemetrybot requested a review from a team January 4, 2025 17:32
@jack-berg
Copy link
Member Author

Thanks @chalin!

@opentelemetrybot opentelemetrybot requested review from a team January 6, 2025 17:18
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

LGTM.

Are we waiting for any other java-*-approvers?

@jack-berg
Copy link
Member Author

Are we waiting for any other java-*-approvers?

I don't think we need to since this is low stakes. If any have recommendations for changes, we can make them in a followup.

@chalin chalin added this pull request to the merge queue Jan 6, 2025
Merged via the queue into open-telemetry:main with commit ca171b7 Jan 6, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants