Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Add instrumentation example to logging #3314

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add instrumentation example to logging #3314

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f47f57d
Add instrumentation example to logging
andremm Feb 28, 2025
e15fe99
Add example output to logging instrumentation example
andremm Feb 28, 2025
c6c59e3
Fix logging instrumentation example and output
andremm Mar 5, 2025
857e5c2
Fixing rst syntax for logging instrumentation examples
andremm Mar 10, 2025
02113a4
Merge branch 'main' into logging-snippet
emdneto Mar 10, 2025
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
17 changes: 17 additions & 0 deletions ...entelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,23 @@

# pylint: disable=empty-docstring,no-value-for-parameter,no-member,no-name-in-module

"""
The OpenTelemetry `logging` integration automatically injects tracing context into
log statements.

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

import logging

from opentelemetry.instrumentation.logging import LoggingInstrumentor

LoggingInstrumentor().instrument()

logging.warning('OTel test')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be useful to add an example of the output after the code block

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uhm I think we need an export OTEL_PYTHON_LOG_CORRELATION=true to have the instrumentation do something

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In #2904 there are some sentences regarding this I think we can reuse here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks both for pointing that out. I had missed that. @emdneto I borrowed some sentences from the documentation to improve the examples. :)

"""

import logging # pylint: disable=import-self
from os import environ
from typing import Collection
Expand Down
Loading