Skip to content

Commit 6c9057e

Browse files
committed
Add documentation
1 parent 9c30ca9 commit 6c9057e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,16 @@ rather than conform to specific API names or argument patterns in the spec.
204204

205205
For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-specification/issues/165
206206

207+
### Environment Variables
208+
209+
If you are adding a component that introduces new OpenTelemetry environment variables, put them all in a module,
210+
as it is done in `opentelemetry.environment_variables` or in `opentelemetry.sdk.environment_variables`.
211+
212+
Keep in mind that any new environment variable must be declared in all caps and must start with `OTEL_PYTHON_`.
213+
214+
Register this module with the `opentelemetry_environment_variables` entry point to make your environment variables
215+
automatically load as options for the `opentelemetry-instrument` command.
216+
207217
## Style Guide
208218

209219
* docstrings should adhere to the [Google Python Style

0 commit comments

Comments
 (0)