Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for supported environment variables #1147

Closed
ocelotl opened this issue Sep 23, 2020 · 7 comments
Closed

Add documentation for supported environment variables #1147

ocelotl opened this issue Sep 23, 2020 · 7 comments
Assignees
Labels
doc Documentation-related good first issue Good first issue help wanted release:required-for-ga To be resolved before GA release triaged

Comments

@ocelotl
Copy link
Contributor

ocelotl commented Sep 23, 2020

More and more environment variables are being supported by this project. It would be a good idea to figure out how to keep them organized and documented in a single place where users can easily find documentation for the supported environment variables.

@ocelotl ocelotl added the doc Documentation-related label Sep 23, 2020
@ocelotl ocelotl self-assigned this Sep 23, 2020
@aabmass
Copy link
Member

aabmass commented Sep 24, 2020

The sphinx envvar role seems to work pretty well, I used it for OTEL_RESOURCE_ATTRIBUTES:

.. envvar:: OTEL_RESOURCE_ATTRIBUTES
The :envvar:`OTEL_RESOURCE_ATTRIBUTES` environment variable allows resource
attributes to be passed to the SDK at process invocation. The attributes from
:envvar:`OTEL_RESOURCE_ATTRIBUTES` are merged with those passed to
`Resource.create`, meaning :envvar:`OTEL_RESOURCE_ATTRIBUTES` takes *lower*
priority. Attributes should be in the format ``key1=value1,key2=value2``.
Additional details are available `in the specification
<https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable>`_.

And here's how it shows in the docs: https://opentelemetry-python.readthedocs.io/en/latest/sdk/resources.html#envvar-OTEL_RESOURCE_ATTRIBUTES

srikanthccv pushed a commit to srikanthccv/opentelemetry-python that referenced this issue Nov 1, 2020
* ci: add markdown linting

Signed-off-by: Naseem <[email protected]>

* fix: lint markdown files

Signed-off-by: Naseem <[email protected]>

* docs: add markdown lint configuration

Signed-off-by: Naseem <[email protected]>

* docs: lint change log

Signed-off-by: Naseem <[email protected]>
@codeboten codeboten added release:required-for-ga To be resolved before GA release 1.0.0rc2 release candidate 2 for tracing GA labels Nov 26, 2020
@codeboten
Copy link
Contributor

codeboten commented Feb 25, 2021

This is where they should show up https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html, missing docstrings for this though.

@aabmass
Copy link
Member

aabmass commented Mar 16, 2021

#1680 added docstrings. The remaining work is filling in the docstrings with missing details.

I'm unassigning myself and someone else can flesh those out if I don't get to it

@aabmass aabmass removed their assignment Mar 16, 2021
@codeboten codeboten removed the 1.0.0rc2 release candidate 2 for tracing GA label Mar 17, 2021
@codeboten codeboten changed the title Find a solution to keep supported environment variables well documented Add documentation for supported environment variables Mar 17, 2021
@codeboten
Copy link
Contributor

Renaming this as the work left here is to document supported variables.

@github-actions
Copy link

This issue was marked stale due to lack of activity. It will be closed in 30 days.

@rnishtala
Copy link
Contributor

Hello, I would like to work on this and add some documentation to the environment variables.

@lzchen
Copy link
Contributor

lzchen commented Jun 28, 2021

@lzchen lzchen closed this as completed Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related good first issue Good first issue help wanted release:required-for-ga To be resolved before GA release triaged
Projects
None yet
Development

No branches or pull requests

6 participants