Skip to content

chore(telemetry): integration error telemetry logs are sent through a function call #13510

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

Merged
merged 2 commits into from
Jun 23, 2025

Conversation

dubloom
Copy link
Contributor

@dubloom dubloom commented May 27, 2025

Motivation

Integration related error telemetry logs were added in #11732. However, it is using a LogHandler. Therefore, to be able to report integration error logs to telemetry you needed to enable debug logs (as in the integration the errors are logged using debug level). However, telemetry activation should not be tied to the log level.

The log handler will stay for the error part as it allows to reduce circular import (see the quoted PR above).

What does this PR do ?

  • Add a call tied to the writer to report integration error logs to telemetry
  • Bump the level of the telemetry logs to error (so it appears in telemetry).
  • Modification to the redaction process: add <REDACTED> for every lines we are redacting (before we were only adding one <REDACTED> for the redaction of two lines)

What this PR doesn't do

  • The PR does not effectively report any errors to telemetry. A discussion should take place in IDM to chose which errors are worth reporting to telemetry.

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

@dubloom dubloom requested review from a team as code owners May 27, 2025 14:40
Copy link
Contributor

github-actions bot commented May 27, 2025

CODEOWNERS have been resolved as:

ddtrace/internal/telemetry/logging.py                                   @DataDog/apm-core-python
ddtrace/internal/telemetry/writer.py                                    @DataDog/apm-core-python
tests/telemetry/test_writer.py                                          @DataDog/apm-python

@dubloom dubloom added the changelog/no-changelog A changelog entry is not required for this PR. label May 27, 2025
Copy link
Contributor

github-actions bot commented May 27, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 286 ± 4 ms.

The average import time from base is: 286 ± 4 ms.

The import time difference between this PR and base is: 0.3 ± 0.2 ms.

The difference is not statistically significant (z = 1.43).

Import time breakdown

The following import paths have grown:

ddtrace.auto 0.118 ms (0.04%)
ddtrace 0.072 ms (0.03%)
ddtrace._logger 0.037 ms (0.01%)
ddtrace.internal.telemetry 0.037 ms (0.01%)
ddtrace.internal.telemetry.writer 0.037 ms (0.01%)
ddtrace._monkey 0.034 ms (0.01%)
ddtrace.bootstrap.sitecustomize 0.046 ms (0.02%)
ddtrace.bootstrap.preload 0.028 ms (0.01%)
ddtrace.internal.remoteconfig._connectors 0.028 ms (0.01%)
ddtrace._trace.trace_handlers 0.018 ms (0.01%)
ddtrace.contrib.trace_utils 0.018 ms (0.01%)
ddtrace.contrib.internal.redis_utils 0.018 ms (0.01%)

The following import paths have shrunk:

ddtrace.auto 1.885 ms (0.66%)
ddtrace.bootstrap.sitecustomize 1.171 ms (0.41%)
ddtrace.bootstrap.preload 1.171 ms (0.41%)
ddtrace.internal.remoteconfig.client 0.590 ms (0.21%)
ddtrace 0.713 ms (0.25%)
ddtrace._logger 0.037 ms (0.01%)
ddtrace.internal.telemetry 0.037 ms (0.01%)
ddtrace.internal.telemetry.writer 0.037 ms (0.01%)
ddtrace.internal.telemetry.logging 0.037 ms (0.01%)
ddtrace.internal._unpatched 0.031 ms (0.01%)
json 0.031 ms (0.01%)
json.decoder 0.031 ms (0.01%)
re 0.031 ms (0.01%)
enum 0.031 ms (0.01%)
types 0.031 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented May 27, 2025

Benchmarks

Benchmark execution time: 2025-06-23 09:48:02

Comparing candidate commit 0ddaf04 in PR branch dubloom/integration-telemetry-logs-refactoring with baseline commit 04cdf7f in branch main.

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

scenario:iastaspectsospath-ospathsplitdrive_aspect

  • 🟥 execution_time [+392.704ns; +449.575ns] or [+10.893%; +12.471%]

scenario:iastaspectsospath-ospathsplitext_aspect

  • 🟥 execution_time [+523.280ns; +649.564ns] or [+11.627%; +14.433%]

@dubloom dubloom marked this pull request as draft May 27, 2025 15:36
@dubloom dubloom marked this pull request as ready for review May 28, 2025 08:23
@dubloom dubloom force-pushed the dubloom/integration-telemetry-logs-refactoring branch 2 times, most recently from 4c81fcd to 74378d8 Compare May 28, 2025 08:45
@dubloom dubloom marked this pull request as draft May 28, 2025 09:32
@dubloom dubloom force-pushed the dubloom/integration-telemetry-logs-refactoring branch from 85ab73a to c459880 Compare June 19, 2025 14:19
@dubloom dubloom marked this pull request as ready for review June 20, 2025 08:30
Copy link
Member

@brettlangdon brettlangdon left a comment

Choose a reason for hiding this comment

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

missing some type hints, otherwise lgtm

@dubloom dubloom merged commit 6fae86b into main Jun 23, 2025
303 checks passed
@dubloom dubloom deleted the dubloom/integration-telemetry-logs-refactoring branch June 23, 2025 09:49
sydney-tung pushed a commit that referenced this pull request Jun 24, 2025
… function call (#13510)

## Motivation

Integration related error telemetry logs were added in #11732. However,
it is using a LogHandler. Therefore, to be able to report integration
error logs to telemetry you needed to enable debug logs (as in the
integration the errors are logged using debug level). However, telemetry
activation should not be tied to the log level.

The log handler will stay for the error part as it allows to reduce
circular import (see the quoted PR above).

## What does this PR do ? 
- Add a call tied to the writer to report integration error logs to
telemetry
- Bump the level of the telemetry logs to error (so it appears in
telemetry).
- Modification to the redaction process: add `<REDACTED>` for every
lines we are redacting (before we were only adding one `<REDACTED>` for
the redaction of two lines)

## What this PR doesn't do

- The PR does not effectively report any errors to telemetry. A
discussion should take place in IDM to chose which errors are worth
reporting to telemetry.

## Checklist
- [X] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
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.

3 participants