open-telemetry / open-telemetry/opentelemetry-python-contrib
Documentation for OTEL_PYTHON_CONFIGURATOR
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Hi everyone,
In the docs it mentions that you can pass a "OTEL_PYTHON_CONFIGURATOR" variable (see https://github.com/open-telemetry/opentelemetry-python-contrib/blob/e318c947a23152c8ff1700f0aad44261be0588cd/opentelemetry-instrumentation/README.rst#installation). However i can't find any documentation on how to define a custom python configurator.
Would it be possible to add documentation or link to where you can find documnetation on how do add a custom python configurator (i'm presuming this is a function that can be called to setup opentelemetry exporters etc for a given service which would be super useful).
Thanks in advance
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the installation section of opentelemetry-instrumentation/README.rst linked in the issue and inspect the OTEL_PYTHON_CONFIGURATOR reference. Clarify how a custom configurator is defined and used, then document that workflow or link to its documentation; done means readers can configure it without guessing its interface.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100