semvec/pypi-packages huggingface dataset:
opentelemetry-instrumentation-urllib3 0.60b1
OpenTelemetry urllib3 instrumentation
Requires Python: >=3.9

OpenTelemetry urllib3 Instrumentation
======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-urllib3.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-urllib3/

This library allows tracing HTTP requests made by the
`urllib3 <https://urllib3.readthedocs.io/>`_ library.

Installation
------------

::

     pip install opentelemetry-instrumentation-urllib3

Usage
-----
.. code-block:: python

    import urllib3
    from opentelemetry.instrumentation.urllib3 import URLLib3Instrumentor

    def strip_query_params(url: str) -> str:
        return url.split("?")[0]

    URLLib3Instrumentor().instrument(
        # Remove all query params from the URL attribute on the span.
        url_filter=strip_query_params,
    )

    http = urllib3.PoolManager()
    response = http.request("GET", "https://www.example.org/")

Configuration
-------------

Request/Response hooks
**********************

The urllib3 instrumentation supports extending tracing behavior with the help of
request and response hooks. These are functions that are called back by the instrumentation
right after a Span is created for a request and right before the span is finished processing a response respectively.
The hooks can be configured as follows:

.. code:: python

    from typing import Any

    from urllib3.connectionpool import HTTPConnectionPool
    from urllib3.response import HTTPResponse

    from opentelemetry.instrumentation.urllib3 import RequestInfo, URLLib3Instrumentor
    from opentelemetry.trace import Span

    def request_hook(
        span: Span,
        pool: HTTPConnectionPool,
        request_info: RequestInfo,
    ) -> Any:
        pass

    def response_hook(
        span: Span,
        pool: HTTPConnectionPool,
        response: HTTPResponse,
    ) -> Any:
        pass

    URLLib3Instrumentor().instrument(
        request_hook=request_hook,
        response_hook=response_hook,
    )

Exclude lists
*************

To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_URLLIB3_EXCLUDED_URLS``
(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.

For example,

::

    export OTEL_PYTHON_URLLIB3_EXCLUDED_URLS="client/.*/info,healthcheck"

will exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.

References
----------

* `OpenTelemetry urllib3 Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/urllib3/urllib3.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-urllib 0.60b1
OpenTelemetry urllib instrumentation
Requires Python: >=3.9

OpenTelemetry urllib Instrumentation
====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-urllib.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-urllib/

This library allows tracing HTTP requests made by the
`urllib <https://docs.python.org/3/library/urllib.html>`_ library.

Installation
------------

::

     pip install opentelemetry-instrumentation-urllib

Configuration
-------------

Request/Response hooks
**********************

The urllib instrumentation supports extending tracing behavior with the help of
request and response hooks. These are functions that are called back by the instrumentation
right after a Span is created for a request and right before the span is finished processing a response respectively.
The hooks can be configured as follows:

.. code:: python

    from opentelemetry.instrumentation.urllib import URLLibInstrumentor

    # `request_obj` is an instance of urllib.request.Request
    def request_hook(span, request_obj):
        pass

    # `request_obj` is an instance of urllib.request.Request
    # `response` is an instance of http.client.HTTPResponse
    def response_hook(span, request_obj, response):
        pass

    URLLibInstrumentor().instrument(
        request_hook=request_hook, response_hook=response_hook
    )

Exclude lists
*************

To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_URLLIB_EXCLUDED_URLS``
(or ``OTEL_PYTHON_EXCLUDED_URLS`` as fallback) with comma delimited regexes representing which URLs to exclude.

For example,

::

    export OTEL_PYTHON_URLLIB_EXCLUDED_URLS="client/.*/info,healthcheck"

will exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.

References
----------

* `OpenTelemetry urllib Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/urllib/urllib.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-tortoiseorm 0.60b1
OpenTelemetry Instrumentation for Tortoise ORM
Requires Python: >=3.9

OpenTelemetry Tortoise ORM Instrumentation
==========================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-tortoiseorm.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-tortoiseorm/

This library allows tracing queries made by tortoise ORM backends, mysql, postgres and sqlite.

Installation
------------

::

     pip install opentelemetry-instrumentation-tortoiseorm

References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `Tortoise ORM <https://tortoise.github.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-tornado 0.60b1
Tornado instrumentation for OpenTelemetry
Requires Python: >=3.9

OpenTelemetry Tornado Instrumentation
======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-tornado.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-tornado/

This library builds on the OpenTelemetry WSGI middleware to track web requests
in Tornado applications.

Installation
------------

::

    pip install opentelemetry-instrumentation-tornado

References
----------

* `OpenTelemetry Tornado Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/tornado/tornado.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-threading 0.60b1
Thread context propagation support for OpenTelemetry
Requires Python: >=3.9

OpenTelemetry threading Instrumentation
=======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-threading.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-threading/

This library provides instrumentation for the `threading` module to ensure that
the OpenTelemetry context is propagated across threads. It is important to note
that this instrumentation does not produce any telemetry data on its own. It
merely ensures that the context is correctly propagated when threads are used.

Installation
------------

::

    pip install opentelemetry-instrumentation-threading

References
----------

* `OpenTelemetry Threading Tracing <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/threading/threading.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
opentelemetry-instrumentation-system-metrics 0.60b1
OpenTelemetry System Metrics Instrumentation
Requires Python: >=3.9

OpenTelemetry System Metrics Instrumentation
============================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-system-metrics.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-system-metrics/

Instrumentation to collect system performance metrics.


Installation
------------

::

    pip install opentelemetry-instrumentation-system-metrics


References
----------
* `OpenTelemetry System Metrics Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/system_metrics/system_metrics.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
opentelemetry-instrumentation-starlette 0.60b1
OpenTelemetry Starlette Instrumentation
Requires Python: >=3.9

OpenTelemetry Starlette Instrumentation
=======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-starlette.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-starlette/


This library provides automatic and manual instrumentation of Starlette web frameworks,
instrumenting http requests served by applications utilizing the framework.

auto-instrumentation using the opentelemetry-instrumentation package is also supported.

Installation
------------

::

    pip install opentelemetry-instrumentation-starlette

References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-sqlite3 0.60b1
OpenTelemetry SQLite3 instrumentation
Requires Python: >=3.9

OpenTelemetry SQLite3 Instrumentation
=====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-sqlite3.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-sqlite3/

Installation
------------

::

    pip install opentelemetry-instrumentation-sqlite3


References
----------
* `OpenTelemetry SQLite3 Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/sqlite3/sqlite3.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-sqlalchemy 0.60b1
OpenTelemetry SQLAlchemy instrumentation
Requires Python: >=3.9

OpenTelemetry SQLAlchemy Instrumentation
========================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-sqlalchemy.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-sqlalchemy/

This library allows tracing requests made by the SQLAlchemy library.

Installation
------------

::

    pip install opentelemetry-instrumentation-sqlalchemy


References
----------

* `SQLAlchemy Project <https://www.sqlalchemy.org/>`_
* `OpenTelemetry SQLAlchemy Tracing <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/sqlalchemy/sqlalchemy.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-requests 0.60b1
OpenTelemetry requests instrumentation
Requires Python: >=3.9

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>`_
opentelemetry-instrumentation-remoulade 0.60b1
OpenTelemetry Remoulade instrumentation
Requires Python: >=3.9

OpenTelemetry Remoulade Instrumentation
=======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-remoulade.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-remoulade/

This library allows tracing requests made by the Remoulade library.

Installation
------------

::

    pip install opentelemetry-instrumentation-remoulade

References
----------

* `OpenTelemetry Remoulade Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/remoulade/remoulade.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-redis 0.60b1
OpenTelemetry Redis instrumentation
Requires Python: >=3.9

OpenTelemetry Redis Instrumentation
===================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-redis.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-redis/

This library allows tracing requests made by the Redis library.

Installation
------------

::

    pip install opentelemetry-instrumentation-redis

References
----------

* `OpenTelemetry Redis Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/redis/redis.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-pyramid 0.60b1
OpenTelemetry Pyramid instrumentation
Requires Python: >=3.9

OpenTelemetry Pyramid Instrumentation
=====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pyramid.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-pyramid/

Installation
------------

::

    pip install opentelemetry-instrumentation-pyramid

References
----------
* `OpenTelemetry Pyramid Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pyramid/pyramid.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-pymysql 0.60b1
OpenTelemetry PyMySQL instrumentation
Requires Python: >=3.9

OpenTelemetry PyMySQL Instrumentation
=====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pymysql.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-pymysql/

Installation
------------

::

    pip install opentelemetry-instrumentation-pymysql


References
----------
* `OpenTelemetry PyMySQL Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pymysql/pymysql.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-pymssql 0.60b1
OpenTelemetry pymssql instrumentation
Requires Python: >=3.9

OpenTelemetry pymssql Instrumentation
=====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pymssql.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-pymssql/

Installation
------------

::

    pip install opentelemetry-instrumentation-pymssql


References
----------
* `OpenTelemetry pymssql Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pymssql/pymssql.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-pymongo 0.60b1
OpenTelemetry pymongo instrumentation
Requires Python: >=3.9

OpenTelemetry pymongo Instrumentation
=====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pymongo.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-pymongo/

Installation
------------

::

    pip install opentelemetry-instrumentation-pymongo


References
----------
* `OpenTelemetry pymongo Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pymongo/pymongo.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-pymemcache 0.60b1
OpenTelemetry pymemcache instrumentation
Requires Python: >=3.9

OpenTelemetry pymemcache Instrumentation
========================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pymemcache.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-pymemcache/

Installation
------------

::

    pip install opentelemetry-instrumentation-pymemcache


References
----------
* `OpenTelemetry Pymemcache Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pymemcache/pymemcache.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-psycopg2 0.60b1
OpenTelemetry psycopg2 instrumentation
Requires Python: >=3.9

OpenTelemetry Psycopg2 Instrumentation
======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-psycopg2.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-psycopg2/

Installation
------------

::

    pip install opentelemetry-instrumentation-psycopg2


References
----------
* `OpenTelemetry Psycopg2 Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/psycopg2/psycopg2.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-psycopg 0.60b1
OpenTelemetry psycopg instrumentation
Requires Python: >=3.9

OpenTelemetry Psycopg Instrumentation
=====================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-psycopg.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-psycopg/

Installation
------------

::

    pip install opentelemetry-instrumentation-psycopg


References
----------
* `OpenTelemetry Psycopg Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/psycopg/psycopg.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-pika 0.60b1
OpenTelemetry pika instrumentation
Requires Python: >=3.9

OpenTelemetry pika Instrumentation
==================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pika.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-pika/

This library allows tracing requests made by the pika library.

Installation
------------

::

    pip install opentelemetry-instrumentation-pika

References
----------

* `OpenTelemetry pika/ Tracing <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/pika/pika.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
opentelemetry-instrumentation-mysqlclient 0.60b1
OpenTelemetry mysqlclient instrumentation
Requires Python: >=3.9

OpenTelemetry mysqlclient Instrumentation
=========================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-mysqlclient.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-mysqlclient/

Installation
------------

::

    pip install opentelemetry-instrumentation-mysqlclient


References
----------
* `OpenTelemetry mysqlclient Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/mysqlclient/mysqlclient.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-mysql 0.60b1
OpenTelemetry MySQL instrumentation
Requires Python: >=3.9

OpenTelemetry MySQL Instrumentation
===================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-mysql.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-mysql/

Instrumentation with MySQL that supports the mysql-connector library and is
specified to trace_integration using 'MySQL'.


Installation
------------

::

    pip install opentelemetry-instrumentation-mysql


References
----------
* `OpenTelemetry MySQL Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/mysql/mysql.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-logging 0.60b1
OpenTelemetry Logging instrumentation
Requires Python: >=3.9

OpenTelemetry logging integration
=================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-logging.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-logging/

Installation
------------

::

    pip install opentelemetry-instrumentation-logging


References
----------

* `OpenTelemetry logging integration <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/logging/logging.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
opentelemetry-instrumentation-kafka-python 0.60b1
OpenTelemetry Kafka-Python instrumentation
Requires Python: >=3.9

OpenTelemetry kafka-python integration
======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-kafka-python.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-kafka-python/

Installation
------------

::

    pip install opentelemetry-instrumentation-kafka-python


References
----------

* `OpenTelemetry kafka-python Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/kafka_python/kafka_python.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_