diff options
author | S. Solomon Darnell | 2025-03-28 21:52:21 -0500 |
---|---|---|
committer | S. Solomon Darnell | 2025-03-28 21:52:21 -0500 |
commit | 4a52a71956a8d46fcb7294ac71734504bb09bcc2 (patch) | |
tree | ee3dc5af3b6313e921cd920906356f5d4febc4ed /.venv/lib/python3.12/site-packages/opentelemetry_instrumentation_urllib-0.52b1.dist-info/METADATA | |
parent | cc961e04ba734dd72309fb548a2f97d67d578813 (diff) | |
download | gn-ai-master.tar.gz |
Diffstat (limited to '.venv/lib/python3.12/site-packages/opentelemetry_instrumentation_urllib-0.52b1.dist-info/METADATA')
-rw-r--r-- | .venv/lib/python3.12/site-packages/opentelemetry_instrumentation_urllib-0.52b1.dist-info/METADATA | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/opentelemetry_instrumentation_urllib-0.52b1.dist-info/METADATA b/.venv/lib/python3.12/site-packages/opentelemetry_instrumentation_urllib-0.52b1.dist-info/METADATA new file mode 100644 index 00000000..d27c5802 --- /dev/null +++ b/.venv/lib/python3.12/site-packages/opentelemetry_instrumentation_urllib-0.52b1.dist-info/METADATA @@ -0,0 +1,94 @@ +Metadata-Version: 2.4 +Name: opentelemetry-instrumentation-urllib +Version: 0.52b1 +Summary: OpenTelemetry urllib instrumentation +Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-urllib +Project-URL: Repository, https://github.com/open-telemetry/opentelemetry-python-contrib +Author-email: OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io> +License-Expression: Apache-2.0 +License-File: LICENSE +Classifier: Development Status :: 4 - Beta +Classifier: Intended Audience :: Developers +Classifier: License :: OSI Approved :: Apache Software License +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 3 +Classifier: Programming Language :: Python :: 3.8 +Classifier: Programming Language :: Python :: 3.9 +Classifier: Programming Language :: Python :: 3.10 +Classifier: Programming Language :: Python :: 3.11 +Classifier: Programming Language :: Python :: 3.12 +Classifier: Programming Language :: Python :: 3.13 +Requires-Python: >=3.8 +Requires-Dist: opentelemetry-api~=1.12 +Requires-Dist: opentelemetry-instrumentation==0.52b1 +Requires-Dist: opentelemetry-semantic-conventions==0.52b1 +Requires-Dist: opentelemetry-util-http==0.52b1 +Provides-Extra: instruments +Description-Content-Type: text/x-rst + +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>`_ |