RFC | add more environment variables to OTEL exporter #106
Conversation
rfcs/0000-deployment.md
Outdated
| - Connectors can use environment variables as part of their configuration. Configuration that varies between different environments or regions (like connection strings) should be configurable via environment variables. | ||
| - The connector should send any relevant trace spans in the OTLP format to the OTEL collector hosted at the URL provided by the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable. | ||
| - Note: `OTEL_EXPORTER_OTLP_ENDPOINT` indicates the _root URL_ of the collector, and not the `/v1/traces` endpoint. | ||
| - Spans should indicate the service name provided by the `OTEL_SERVICE_NAME` environment variable. | ||
| - The connector can configure additional headers to add in outgoing gRPC or HTTP requests by the `OTEL_EXPORTER_OTLP_HEADERS` environment variables. |
There was a problem hiding this comment.
It's not the connector which configures these though, right? It's the user of the Docker image?
There was a problem hiding this comment.
The connector presumably just needs to respect the OTEL spec and pass them along?
There was a problem hiding this comment.
You're right. My words may cause confusing here
rfcs/0000-deployment.md
Outdated
| - The connector can configure additional headers to add in outgoing gRPC or HTTP requests by the `OTEL_EXPORTER_OTLP_HEADERS` environment variables. | ||
| - The connector also can configure additional resource attributes for requests by the `OTEL_RESOURCE_ATTRIBUTES` environment variables. | ||
| - Note: the value of `OTEL_EXPORTER_OTLP_HEADERS` and `OTEL_RESOURCE_ATTRIBUTES` is key-value pairs, for example, `api-key=key,other-config-value=value`. | ||
| - Other OTLP exporter configurations are optional. However, they must follow the [Environment Variable Specification](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables) and [SDK config](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/). |
There was a problem hiding this comment.
I think we need to be a bit careful here because the environment variable spec says too much IMO. For example, it requires OTEL_PROPAGATORS, but the NDC spec requires tracecontext propagation. There are a lot of other env vars that we don't need to support in full.
There was a problem hiding this comment.
I have added a line to clarify the required tracecontext propagation.
I'm wondering if we should specify a list of individual env vars to support, or to just say "a connector should support OTEL in full" but clarify which parts we actually care about right now.
IMO not all languages implement OTEL SDK. It seems too much to expect the author to support OTEL in full. However, we can clarify that the connector can support other configurations depending on the underlying SDK.
Anyway, it would be great if you could suggest better words to make the proposal clearer.
hgiasac
changed the title
OTEL_EXPORTER_OTLP_HEADERSandOTEL_RESOURCE_ATTRIBUTES)Rendered