docs: telemetry docs to provide endpoint without scheme or path#2179
Conversation
Summary of ChangesHello @Yuan325, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the telemetry documentation to accurately reflect the expected format for OpenTelemetry Protocol (OTLP) endpoints. It clarifies that endpoints should be specified as host and port without a preceding scheme, and introduces the necessary environment variable for enabling insecure connections. These updates ensure the documentation aligns with the underlying OpenTelemetry Go library's behavior, improving user guidance for configuring telemetry. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the telemetry documentation to clarify that the OTLP endpoint should be provided without a scheme. It also explains how to use insecure endpoints by setting the OTEL_EXPORTER_OTLP_INSECURE environment variable. The changes are correct and align with the OpenTelemetry specification. I've provided a couple of suggestions to improve the clarity and user experience of the documentation, mainly by making the instructions more explicit and providing a complete example for using an insecure connection.
69ae36a to
11f5cb3
Compare
|
🧨 Preview deployments removed. |
…th (#2179) ## Description According to the OTEL ([docs](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp#WithEndpoint)), `WithEndpoint()` sets the target endpoint (host and port) the Exporter will connect to. The provided endpoint should resemble "example.com:4318" (no scheme or path). And it requires the endpoint to be secure using `https://`. To provide an insecure endpoint with `http://`, user will need to set `OTEL_EXPORTER_OTLP_INSECURE=true`. This PR update the docs to reflect this. 🛠️ Fixes #1539 6e87349
…th (googleapis#2179) ## Description According to the OTEL ([docs](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp#WithEndpoint)), `WithEndpoint()` sets the target endpoint (host and port) the Exporter will connect to. The provided endpoint should resemble "example.com:4318" (no scheme or path). And it requires the endpoint to be secure using `https://`. To provide an insecure endpoint with `http://`, user will need to set `OTEL_EXPORTER_OTLP_INSECURE=true`. This PR update the docs to reflect this. 🛠️ Fixes googleapis#1539 6e87349
…leapis#2179) ## Description According to the OTEL ([docs](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp#WithEndpoint)), `WithEndpoint()` sets the target endpoint (host and port) the Exporter will connect to. The provided endpoint should resemble "example.com:4318" (no scheme or path). And it requires the endpoint to be secure using `https://`. To provide an insecure endpoint with `http://`, user will need to set `OTEL_EXPORTER_OTLP_INSECURE=true`. This PR update the docs to reflect this. 🛠️ Fixes googleapis#1539
Description
According to the OTEL (docs),
WithEndpoint()sets the target endpoint (host and port) the Exporter will connect to. The provided endpoint should resemble "example.com:4318" (no scheme or path). And it requires the endpoint to be secure usinghttps://.To provide an insecure endpoint with
http://, user will need to setOTEL_EXPORTER_OTLP_INSECURE=true. This PR update the docs to reflect this.🛠️ Fixes #1539