opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

Create a human-readable environment variable reference

Open austinlparker opened this issue 1 year ago • 7 comments

While it's great that we have all of the env vars in the spec section of docs, it'd be nice if there was a general 'human-friendly' reference page of environment variables as a top-level docs item.

austinlparker avatar Jan 19 '24 16:01 austinlparker

When you say top-level you mean something like opentelemetry.io/docs/environment-variables ? or are you looking for an extended version of these 2 pages:

https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/ https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/

svrnm avatar Jan 19 '24 16:01 svrnm

Basically taking the content in those two pages and making it top-level, yeah.

austinlparker avatar Jan 19 '24 16:01 austinlparker

hm, since we have ongoing efforts for configuration files, should we do something like

opentelemetry.io/configuration and kick that off with environment files?

svrnm avatar Jan 19 '24 16:01 svrnm

that would work yeah

austinlparker avatar Jan 19 '24 19:01 austinlparker

Cool, then let's do that.

svrnm avatar Jan 19 '24 19:01 svrnm

I would be in favor of a general config section

cartermp avatar Jan 19 '24 23:01 cartermp

I like this idea and I'd be happy to help.

theletterf avatar Jan 23 '24 10:01 theletterf