-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
base: main
Are you sure you want to change the base?
Conversation
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.
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.)
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.
See inline for comments on the prose.
The [span exporter](#spanexporter), [metric exporter](#metricexporter), and | ||
[log exporter](#logrecordexporter) discuss OTLP exporters of the form: |
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.
The [span exporter](#spanexporter), [metric exporter](#metricexporter), and | |
[log exporter](#logrecordexporter) discuss OTLP exporters of the form: | |
The [span exporter](#spanexporter), [metric exporter](#metricexporter), and | |
[log exporter](#logrecordexporter) sections describe OTLP exporters of the form: |
@@ -1371,11 +1368,21 @@ The [span exporter](#spanexporter), [metric exporter](#metricexporter), and | |||
- `OtlpGrpc{Signal}Exporter`s export data via OTLP `grpc`. |
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.
- `OtlpGrpc{Signal}Exporter`s export data via OTLP `grpc`. | |
- `OtlpGrpc{Signal}Exporter`, which export data via OTLP `grpc` |
(If you agree with this change, please make the corresponding change to the previous line (which I can't seem to edit via the web i/f).
protocol, and between signals. The following sections elaborate on certain key | ||
concepts: |
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.
protocol, and between signals. The following sections elaborate on certain key | |
concepts: | |
protocol, and between signals. The following sections elaborate on these key | |
concepts: |
- [Senders](#senders): The sender abstraction allows for a different HTTP / gRPC | ||
client libraries, catering to various use cases. |
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.
- [Senders](#senders): The sender abstraction allows for a different HTTP / gRPC | |
client libraries, catering to various use cases. | |
- [Senders](#senders): an abstraction for different HTTP / gRPC | |
client libraries. |
- [Authentication](#authentication): Discusses authentication options for OTLP | ||
exporters. |
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.
- [Authentication](#authentication): Discusses authentication options for OTLP | |
exporters. | |
- [Authentication](#authentication) options for OTLP exporters. |
with environment variables and system properties, see | ||
[relevant properties](../configuration/#properties-exporters): |
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.
with environment variables and system properties, see | |
[relevant properties](../configuration/#properties-exporters): | |
with environment variables and [relevant system properties](../configuration/#properties-exporters): |
e97d94d
to
dfd71eb
Compare
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/