Add python injection noisy logs section #19944
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kyle-Verhoog
added
Do Not Merge
18 tasks
Contributor
Preview links (active after the
|
emmettbutler
pushed a commit
to DataDog/dd-trace-py
that referenced
this pull request
Sep 29, 2023
The stderr logs are noisy and not actionable when running many Python scripts on a system. It is also possible that the injection breaks scripts and applications that rely on specific stderr output. The logs can still be printed to stderr when using `DD_TRACE_DEBUG=1`. It was considered to write the logs to [system logs](https://docs.python.org/3/library/syslog.html) but opted against until we can better evaluate it as an approach. There are some risks like permission issues, noise and usability that need to be explored a little bit more before going ahead with it. For now we just opt into stderr logs with `DD_TRACE_DEBUG=1`. Public docs PR: DataDog/documentation#19944 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that.
Kyle-Verhoog
added a commit
to DataDog/dd-trace-py
that referenced
this pull request
Oct 4, 2023
The stderr logs are noisy and not actionable when running many Python scripts on a system. It is also possible that the injection breaks scripts and applications that rely on specific stderr output. The logs can still be printed to stderr when using `DD_TRACE_DEBUG=1`. It was considered to write the logs to [system logs](https://docs.python.org/3/library/syslog.html) but opted against until we can better evaluate it as an approach. There are some risks like permission issues, noise and usability that need to be explored a little bit more before going ahead with it. For now we just opt into stderr logs with `DD_TRACE_DEBUG=1`. Public docs PR: DataDog/documentation#19944 - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that.
Merged
18 tasks
emmettbutler
pushed a commit
to DataDog/dd-trace-py
that referenced
this pull request
Oct 4, 2023
….20] (#7165) The stderr logs are noisy and not actionable when running many Python scripts on a system. It is also possible that the injection breaks scripts and applications that rely on specific stderr output. The logs can still be printed to stderr when using `DD_TRACE_DEBUG=1`. It was considered to write the logs to [system logs](https://docs.python.org/3/library/syslog.html) but opted against until we can better evaluate it as an approach. There are some risks like permission issues, noise and usability that need to be explored a little bit more before going ahead with it. For now we just opt into stderr logs with `DD_TRACE_DEBUG=1`. Public docs PR: DataDog/documentation#19944 #7061 - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that.
github-actions bot
pushed a commit
to DataDog/dd-trace-py
that referenced
this pull request
Oct 4, 2023
The stderr logs are noisy and not actionable when running many Python scripts on a system. It is also possible that the injection breaks scripts and applications that rely on specific stderr output. The logs can still be printed to stderr when using `DD_TRACE_DEBUG=1`. It was considered to write the logs to [system logs](https://docs.python.org/3/library/syslog.html) but opted against until we can better evaluate it as an approach. There are some risks like permission issues, noise and usability that need to be explored a little bit more before going ahead with it. For now we just opt into stderr logs with `DD_TRACE_DEBUG=1`. Public docs PR: DataDog/documentation#19944 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that. (cherry picked from commit a050cce)
Merged
18 tasks
emmettbutler
pushed a commit
to DataDog/dd-trace-py
that referenced
this pull request
Oct 4, 2023
….0] (#7167) Backport a050cce from #6978 to 2.0. The stderr logs are noisy and not actionable when running many Python scripts on a system. It is also possible that the injection breaks scripts and applications that rely on specific stderr output. The logs can still be printed to stderr when using `DD_TRACE_DEBUG=1`. It was considered to write the logs to [system logs](https://docs.python.org/3/library/syslog.html) but opted against until we can better evaluate it as an approach. There are some risks like permission issues, noise and usability that need to be explored a little bit more before going ahead with it. For now we just opt into stderr logs with `DD_TRACE_DEBUG=1`. Public docs PR: DataDog/documentation#19944 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that. Co-authored-by: Kyle Verhoog <kyle@verhoog.ca>
jhgilbert
approved these changes
Oct 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Merge instructions
Need to wait for the Python library to release the fix (and see which version it is included in) before merging this PR.It is released in
v1.20.3: https://github.com/DataDog/dd-trace-py/releases/tag/v1.20.3Additional notes