opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentati...
OpenTelemetry Bot afd8428997
Update version to 1.19.0.dev/0.40b0.dev (#1797)
Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com>
2023-05-17 10:47:58 -06:00
..
src/opentelemetry/instrumentation/requests Update version to 1.19.0.dev/0.40b0.dev (#1797) 2023-05-17 10:47:58 -06:00
tests Implement request and response hooks in requests library instrumentation (#1717) 2023-03-16 21:24:10 +00:00
LICENSE Fix error in license files (#521) 2021-05-28 09:16:58 -07:00
README.rst Add support for generic OTEL_PYTHON_EXCLUDED_URLS variable (#790) 2021-11-10 22:44:02 +00:00
pyproject.toml Update version to 1.19.0.dev/0.40b0.dev (#1797) 2023-05-17 10:47:58 -06:00

README.rst

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>`_