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

chore: privatizing methods kafka,kombu,langchain,logbook,logging,loguru #9946

Closed

Conversation

rachelyangdog
Copy link
Contributor

@rachelyangdog rachelyangdog commented Jul 25, 2024

The API should just be what is necessary. A lot of integrations expose implementation details through the patch.py We can’t just remove these functions right away as it will break our API so for each we will need to deprecate first and then remove in 2.x.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

@rachelyangdog rachelyangdog added the changelog/no-changelog A changelog entry is not required for this PR. label Jul 25, 2024
@rachelyangdog rachelyangdog requested review from a team as code owners July 25, 2024 20:52
Copy link
Contributor

github-actions bot commented Jul 25, 2024

CODEOWNERS have been resolved as:

releasenotes/notes/deprecate-patch-py-methods-kafka-kombu-langchain-logbook-logging-loguru-fe2c2eb818bb10bf.yaml  @DataDog/apm-python
ddtrace/contrib/kafka/__init__.py                                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/kafka/patch.py                                          @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/kombu/__init__.py                                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/kombu/patch.py                                          @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/langchain/__init__.py                                   @DataDog/ml-observability
ddtrace/contrib/langchain/patch.py                                      @DataDog/ml-observability
ddtrace/contrib/logbook/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/logbook/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/logging/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/logging/patch.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/loguru/__init__.py                                      @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/loguru/patch.py                                         @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/kafka/test_kafka_patch.py                                 @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/kombu/test_kombu_patch.py                                 @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/langchain/test_langchain_patch.py                         @DataDog/ml-observability
tests/contrib/logbook/test_logbook_patch.py                             @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/logging/test_logging_patch.py                             @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/loguru/test_loguru_patch.py                               @DataDog/apm-core-python @DataDog/apm-idm-python

@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jul 25, 2024

Datadog Report

Branch report: rachel.yang/privatize-public-functions-kafka
Commit report: 37932c6
Test service: dd-trace-py

✅ 0 Failed, 2960 Passed, 470 Skipped, 37m 26.69s Total Time

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 0% with 141 lines in your changes missing coverage. Please review.

Project coverage is 10.54%. Comparing base (de35e9a) to head (be7e0af).
Report is 9 commits behind head on main.

Files Patch % Lines
ddtrace/contrib/langchain/patch.py 0.00% 79 Missing ⚠️
ddtrace/contrib/kafka/patch.py 0.00% 28 Missing ⚠️
ddtrace/contrib/kombu/patch.py 0.00% 16 Missing ⚠️
ddtrace/contrib/logbook/patch.py 0.00% 6 Missing ⚠️
ddtrace/contrib/logging/patch.py 0.00% 6 Missing ⚠️
ddtrace/contrib/loguru/patch.py 0.00% 6 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #9946       +/-   ##
===========================================
- Coverage   73.90%   10.54%   -63.36%     
===========================================
  Files        1402     1368       -34     
  Lines      130341   128047     -2294     
===========================================
- Hits        96324    13503    -82821     
- Misses      34017   114544    +80527     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pr-commenter
Copy link

pr-commenter bot commented Jul 25, 2024

Benchmarks

Benchmark execution time: 2024-07-29 23:06:26

Comparing candidate commit 37932c6 in PR branch rachel.yang/privatize-public-functions-kafka with baseline commit d1db200 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 214 metrics, 2 unstable metrics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants