Skip to content

docs: update logs example to use opentelemetry-instrumentation-logging#5344

Merged
xrmx merged 7 commits into
open-telemetry:mainfrom
avinab-neogy:docs/update-logging-sdk-readme
Jul 10, 2026
Merged

docs: update logs example to use opentelemetry-instrumentation-logging#5344
xrmx merged 7 commits into
open-telemetry:mainfrom
avinab-neogy:docs/update-logging-sdk-readme

Conversation

@avinab-neogy

@avinab-neogy avinab-neogy commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Description

Update the logs example documentation to reflect that LoggingHandler
has moved from the SDK to the contrib package.

Refs #4738

Changes made:

  • Add Installation section with correct pip installs including opentelemetry-instrumentation-logging
  • Add Run the Example section for better structure
  • Add note that LoggingHandler has moved to opentelemetry-instrumentation-logging (deprecated in opentelemetry-sdk: deprecate logging handler #4919)
  • Add propagate=True with explanation comment in example.py

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • Built docs locally with tox -e docs — build succeeded with no warnings
  • Ran tox -e spellcheck — passed
  • Verified rendered HTML output looks correct

Does This PR Require a Contrib Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@avinab-neogy avinab-neogy requested a review from a team as a code owner June 23, 2026 13:49
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jun 23, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: avinab-neogy / name: avinab-neogy (0ddf26c)

Comment thread docs/examples/logs/README.rst
@github-project-automation github-project-automation Bot moved this to Reviewed PRs that need fixes in Python PR digest Jun 23, 2026
@xrmx

xrmx commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

I think your changes are not very relevant with #4738 but the changes regarding the LoggingHandler move are good

Comment thread docs/examples/logs/example.py Outdated
@avinab-neogy avinab-neogy requested a review from xrmx June 25, 2026 05:46
@avinab-neogy avinab-neogy force-pushed the docs/update-logging-sdk-readme branch from 987a3af to 9258631 Compare June 25, 2026 05:48
avinab-neogy added a commit to avinab-neogy/opentelemetry-python that referenced this pull request Jun 25, 2026
Comment thread docs/examples/logs/README.rst Outdated
Comment thread docs/examples/logs/example.py Outdated
@xrmx xrmx moved this from Reviewed PRs that need fixes to Ready for review in Python PR digest Jul 8, 2026
@avinab-neogy avinab-neogy force-pushed the docs/update-logging-sdk-readme branch from 05a4adf to b634af7 Compare July 8, 2026 17:20

@hectorhdzg hectorhdzg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Comment thread docs/examples/logs/example.py Outdated
Comment thread docs/examples/logs/example.py Outdated
@xrmx xrmx enabled auto-merge July 10, 2026 09:59
@xrmx xrmx added this pull request to the merge queue Jul 10, 2026
Merged via the queue into open-telemetry:main with commit 4a2ef8c Jul 10, 2026
546 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants