Add common language-agnostic environment variable configuration docs #1432
Conversation
This file contains 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
austinlparker
requested changes
Jun 8, 2022
content/en/docs/concepts/sdk-configuration/exporter-selection-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/exporter-selection-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/general-sdk-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/otlp-exporter-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/otlp-exporter-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/otlp-exporter-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/otlp-exporter-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/otlp-exporter-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/otlp-exporter-configuration.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Austin Parker <austin@ap2.io>
pellared
reviewed
Jun 9, 2022
content/en/docs/concepts/sdk-configuration/exporter-selection-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/exporter-selection-configuration.md
Outdated
Show resolved
Hide resolved
content/en/docs/concepts/sdk-configuration/exporter-selection-configuration.md
Outdated
Show resolved
Hide resolved
…configuration.md Co-authored-by: Robert Pająk <pellared@hotmail.com>
austinlparker
approved these changes
Jun 10, 2022
|
this lgtm -- g2g @cartermp? |
|
Yep, I can always add more in future PRs |
pellared
reviewed
Jun 13, 2022
|
|
||
| ## Endpoint Configuration | ||
|
|
||
| The following environment variables let you configure an OTLP/gRPC or OTLP/HTTP |
There was a problem hiding this comment.
Following env vars are not documented:
OTEL_EXPORTER_OTLP_PROTOCOLOTEL_EXPORTER_OTLP_TRACES_PROTOCOLOTEL_EXPORTER_OTLP_METRICS_PROTOCOL
|
|
||
| **Example:** | ||
|
|
||
| * gRPC: `export OTEL_EXPORTER_OTLP_ENDPOINT="my-api-endpoint:443"` |
There was a problem hiding this comment.
Suggested change
| * gRPC: `export OTEL_EXPORTER_OTLP_ENDPOINT="my-api-endpoint:443"` | |
| * gRPC: `export OTEL_EXPORTER_OTLP_ENDPOINT="https://my-api-endpoint"` |
AFAIK all (or most) of the languages require http or https prefix do determine if secure on insecure gRPC connection should be used
| **Example:** | ||
|
|
||
| * gRPC: `export OTEL_EXPORTER_OTLP_ENDPOINT="my-api-endpoint:443"` | ||
| * HTTP: `export OTEL_EXPORTER_OTLP_ENDPOINT="https://my-api-endpoint/"` |
There was a problem hiding this comment.
I think it would be safer to set
Suggested change
| * HTTP: `export OTEL_EXPORTER_OTLP_ENDPOINT="https://my-api-endpoint/"` | |
| * HTTP: `export OTEL_EXPORTER_OTLP_ENDPOINT="https://my-api-endpoint"` |
|
|
||
| ### `OTEL_EXPORTER_OTLP_ENDPOINT` | ||
|
|
||
| A base endpoint URL for any signal type, with an optionall-specified port |
There was a problem hiding this comment.
Suggested change
| A base endpoint URL for any signal type, with an optionall-specified port | |
| A base endpoint URL for any signal type, with an optionally-specified port |
|
|
||
| ### `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | ||
|
|
||
| Endpoint URL for trace data only, with an optionall-specified port number. Must |
There was a problem hiding this comment.
Suggested change
| Endpoint URL for trace data only, with an optionall-specified port number. Must | |
| Endpoint URL for trace data only, with an optionally-specified port number. Must |
|
|
||
| ### `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` | ||
|
|
||
| Endpoint URL for trace data only, with an optionall-specified port number. Must |
There was a problem hiding this comment.
Suggested change
| Endpoint URL for trace data only, with an optionall-specified port number. Must | |
| Endpoint URL for trace data only, with an optionally-specified port number. Must |
|
|
||
| ### `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` | ||
|
|
||
| Endpoint URL for trace data only, with an optionall-specified port number. Must |
There was a problem hiding this comment.
Suggested change
| Endpoint URL for trace data only, with an optionall-specified port number. Must | |
| Endpoint URL for trace data only, with an optionally-specified port number. Must |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Preview: https://deploy-preview-1432--opentelemetry.netlify.app/docs/concepts/sdk-configuration/
Okay, so I used the word "common" here, but this is mostly based on what I've seen people need to configure to successfully send data to a backend. There's a lot more stuff in the spec that could be pulled in here, but since perfect is the enemy of good, I figured I'd get some docs going that aren't just links to the spec.