diff --git a/docs/instrumentation/urllib/urllib3.rst b/docs/instrumentation/urllib/urllib3.rst new file mode 100644 index 0000000000..f5664fbea9 --- /dev/null +++ b/docs/instrumentation/urllib/urllib3.rst @@ -0,0 +1,7 @@ +OpenTelemetry urllib Instrumentation +============================================ + +.. automodule:: opentelemetry.instrumentation.urllib + :members: + :undoc-members: + :show-inheritance: diff --git a/instrumentation/opentelemetry-instrumentation-urllib/src/opentelemetry/instrumentation/urllib/__init__.py b/instrumentation/opentelemetry-instrumentation-urllib/src/opentelemetry/instrumentation/urllib/__init__.py index b57304f762..b73a1cacc9 100644 --- a/instrumentation/opentelemetry-instrumentation-urllib/src/opentelemetry/instrumentation/urllib/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-urllib/src/opentelemetry/instrumentation/urllib/__init__.py @@ -12,14 +12,12 @@ # See the License for the specific language governing permissions and # limitations under the License. - """ This library allows tracing HTTP requests made by the -`urllib https://docs.python.org/3/library/urllib.html>`_ library. +`urllib `_ library. Usage ----- - .. code-block:: python from urllib import request @@ -43,7 +41,7 @@ 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 +.. code:: python # `request_obj` is an instance of urllib.request.Request def request_hook(span, request_obj):