Skip to content

Add urllib readthedocs documentation #1510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 20, 2022
Merged

Add urllib readthedocs documentation #1510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4378ae
Add urllib readthedocs documentation
nemoshlag Dec 20, 2022
7f8ac6d
Merge branch 'main' into add/urllib-documentation
nemoshlag Dec 20, 2022
f1f557e
Merge branch 'main' into add/urllib-documentation
nemoshlag Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/instrumentation/urllib/urllib3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
OpenTelemetry urllib Instrumentation
============================================

.. automodule:: opentelemetry.instrumentation.urllib
:members:
:undoc-members:
:show-inheritance:
6 changes: 2 additions & 4 deletions ...opentelemetry-instrumentation-urllib/src/opentelemetry/instrumentation/urllib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.python.org/3/library/urllib>`_ library.

Usage
-----

.. code-block:: python

from urllib import request
Expand All @@ -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):
Expand Down