mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-08-02 02:52:18 +08:00
d4ad8f57be
* Add support for generic OTEL_PYTHON_EXCLUDED_URLS variable
Use `OTEL_PYTHON_EXCLUDED_URLS` environment variable as a fallback of
`OTEL_PYTHON_{instrumentation}_EXCLUDED_URLS`.
* Only use generic variable when instrumentation-specific is not set
* Change wording on docs
Co-authored-by: Leighton Chen <lechen@microsoft.com>
41 lines
1.2 KiB
ReStructuredText
41 lines
1.2 KiB
ReStructuredText
OpenTelemetry Requests Instrumentation
|
|
======================================
|
|
|
|
|pypi|
|
|
|
|
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-requests.svg
|
|
:target: https://pypi.org/project/opentelemetry-instrumentation-requests/
|
|
|
|
This library allows tracing HTTP requests made by the
|
|
`requests <https://requests.readthedocs.io/en/master/>`_ library.
|
|
|
|
Installation
|
|
------------
|
|
|
|
::
|
|
|
|
pip install opentelemetry-instrumentation-requests
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
Exclude lists
|
|
*************
|
|
To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_REQUESTS_EXCLUDED_URLS``
|
|
(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.
|
|
|
|
For example,
|
|
|
|
::
|
|
|
|
export OTEL_PYTHON_REQUESTS_EXCLUDED_URLS="client/.*/info,healthcheck"
|
|
|
|
will exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.
|
|
|
|
References
|
|
----------
|
|
|
|
* `OpenTelemetry requests Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/requests/requests.html>`_
|
|
* `OpenTelemetry Project <https://opentelemetry.io/>`_
|
|
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
|