Skip to content
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.

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

sdk: decouple logs sdk setup from OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED #4340

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

Conversation

xrmx
Copy link
Contributor

@xrmx xrmx commented Dec 6, 2024

Description

Always setup the logs sdk, keep the handler for python logging module setup under OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED guard

Fixes #4329

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • tox -e py310-test-opentelemetry-sdk

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

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

…TION_ENABLED

Always setup the logs sdk, keep the handler for python logging module
under OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED
@xrmx xrmx requested a review from a team as a code owner December 6, 2024 10:26
@@ -236,6 +236,7 @@ def _init_metrics(
def _init_logging(
exporters: Dict[str, Type[LogExporter]],
resource: Resource = None,
setup_logging_handler: bool = True,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is True to keep compatibility with old callers. I know it's a private function but still.

@@ -364,7 +367,7 @@ def _initialize_components(
sampler: Optional[Sampler] = None,
resource_attributes: Optional[Attributes] = None,
id_generator: IdGenerator = None,
logging_enabled: Optional[bool] = None,
setup_logging_handler: Optional[bool] = None,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will change behavior for custom distro implementors and so I've renamed the param name

Copy link
Member

Choose a reason for hiding this comment

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

Much clearer too 👍

@xrmx xrmx changed the title sdk: decoule logs sdk setup from OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED sdk: decouple logs sdk setup from OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED Dec 9, 2024
Copy link
Member

@aabmass aabmass left a comment

Choose a reason for hiding this comment

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

Thank you @xrmx! Should we include this in the coming release or wait until the following?

@@ -364,7 +367,7 @@ def _initialize_components(
sampler: Optional[Sampler] = None,
resource_attributes: Optional[Attributes] = None,
id_generator: IdGenerator = None,
logging_enabled: Optional[bool] = None,
setup_logging_handler: Optional[bool] = None,
Copy link
Member

Choose a reason for hiding this comment

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

Much clearer too 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal for Log and Event capturing with auto instrumentation
2 participants