RFC: connector deployment spec #94
Conversation
| - The following environment variables are reserved, and should not be used for connector-specific configuration: | ||
| - `HASURA_*` | ||
| - `OTEL_EXPORTER_*` | ||
| - 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. |
There was a problem hiding this comment.
Is there a "namespace" for these? Perhaps CONNECTOR_*?
There was a problem hiding this comment.
Not currently, but maybe there should be. I was actually thinking that we could remove any reserved variables by using command line args, and leave all environment variables available for use. But OpenTelemetry stops us from doing that, since they require env vars.
There was a problem hiding this comment.
Perhaps we can leave this for now and add it as a "best practice" if we feel the need.
|
LGTM |
|
|
||
| ### Open Questions | ||
|
|
||
| - Do we want to reserve environment variables `OTEL_*` for possible future use of the [OTLP exporter spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md)? |
There was a problem hiding this comment.
I think we can avoid worrying about this and let connector devs suffer if they decide to intrude on another's namespace.
Fine with just pointing it out as a "probably don't do this".
| - `HASURA_*` | ||
| - `OTEL_EXPORTER_*` | ||
| - 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. |
There was a problem hiding this comment.
This should be changed, per the spec the OTEL_EXPORTER_OTLP_ENDPOINT is a base url, and
For the per-signal variables (OTEL_EXPORTER_OTLP__ENDPOINT), the URL MUST be used as-is without any modification. The only exception is that if an URL contains no path part, the root path / MUST be used (see Example > 2).
If signals are sent that have no per-signal configuration from the previous point, OTEL_EXPORTER_OTLP_ENDPOINT is used as a base URL and the signals are sent to these paths relative to that:
Traces: v1/traces
Metrics: v1/metrics.
Logs: v1/logs.
So the URL for traces would be specified with either OTEL_EXPORTER_OTLP_TRACES_ENDPOINT or <OTEL_EXPORTER_OTLP_ENDPOINT>/v1/traces
There was a problem hiding this comment.
to the OTEL collector hosted at the URL provided by the
OTEL_EXPORTER_OTLP_ENDPOINT
I think this is compatible with what the SDK does, and what the spec says? The OTEL collector root URL is provided in the OTEL_EXPORTER_OTLP_ENDPOINT variable. I will add a sentence clarifying this.
This is extracted from #89 in order to come to consensus on the aspects of packaging which are relevant only to deployment, while we figure out some of the specifics on the CLI side (watch mode etc.) in the existing RFC.
Rendered
Note: I reverted some of the changes from the other PR:
PORTtoHASURA_CONNECTOR_PORT. The SDKs abstract this away from the user.