refactor(di): encapsulate common signal code #11153

P403n1x87 · 2024-10-24T10:45:04Z

We encapsulate common signal boilerplate code to simplify the coding of signals and ensure homogeneous behaviour among them.

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

ddtrace/debugging/_signal/model.py

github-actions · 2024-10-24T10:58:05Z

CODEOWNERS have been resolved as:

ddtrace/debugging/_signal/context.py                                    @DataDog/debugger-python
ddtrace/debugging/_debugger.py                                          @DataDog/debugger-python
ddtrace/debugging/_exception/replay.py                                  @DataDog/debugger-python
ddtrace/debugging/_expressions.py                                       @DataDog/debugger-python
ddtrace/debugging/_origin/span.py                                       @DataDog/debugger-python
ddtrace/debugging/_probe/model.py                                       @DataDog/debugger-python
ddtrace/debugging/_probe/remoteconfig.py                                @DataDog/debugger-python
ddtrace/debugging/_signal/collector.py                                  @DataDog/debugger-python
ddtrace/debugging/_signal/metric_sample.py                              @DataDog/debugger-python
ddtrace/debugging/_signal/model.py                                      @DataDog/debugger-python
ddtrace/debugging/_signal/snapshot.py                                   @DataDog/debugger-python
ddtrace/debugging/_signal/tracing.py                                    @DataDog/debugger-python
tests/debugging/probe/test_remoteconfig.py                              @DataDog/debugger-python
tests/debugging/signal/test_collector.py                                @DataDog/debugger-python
tests/debugging/signal/test_model.py                                    @DataDog/debugger-python
tests/debugging/test_debugger.py                                        @DataDog/debugger-python
tests/debugging/test_debugger_span_decoration.py                        @DataDog/debugger-python
tests/debugging/test_encoding.py                                        @DataDog/debugger-python
tests/debugging/utils.py                                                @DataDog/debugger-python

pr-commenter · 2024-10-24T11:26:51Z

Benchmarks

Benchmark execution time: 2024-10-24 15:35:54

Comparing candidate commit 1d33870 in PR branch refactor/probe-management-boilerplate with baseline commit 26ad98b in branch main.

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

We encapsulate common signal boilerplate code to simplify the coding of signals and ensure homogeneous behaviour among them.

shatzi

Awesome stuff man!!!

I would like to see everything encapsulated under SignalContext, and remove the last few places like in debugger.py that still check for RateLimit and Condtion Mixins.

ddtrace/debugging/_expressions.py

shatzi · 2024-10-24T16:04:41Z

ddtrace/debugging/_exception/replay.py

@@ -188,7 +190,9 @@ def on_span_exception(
                        )

                        # Capture
-                        snapshot.line()
+                        snapshot.line(ChainMap(frame.f_locals, frame.f_globals))


we call this ChainMap multiple locations - I think it better to have an util method e.g; createScopeFromFrame(frame) -> to avoid problems down the line if we decide to limit or remove globals...

or maybe line() should just get the frame object instead.

The arguments are all different so I don't think we can make a single helper in this case 🙁

shatzi · 2024-10-24T16:05:13Z

ddtrace/debugging/_probe/model.py

    DEFAULT = "DEFAULT"
-    ENTER = "ENTER"


The RFC mentions ENTRY as accepted value so I'm aligning with that

shatzi · 2024-10-24T16:09:07Z

ddtrace/debugging/_signal/context.py

+        self._timing = ProbeEvalTiming.ENTRY
+
+        probe = signal.probe
+        if isinstance(probe, TimingMixin):


nit: would easier to read if there is else under this if with self._timing = ProbeEvalTiming.ENTRY

shatzi · 2024-10-24T16:12:40Z

ddtrace/debugging/_signal/context.py

+
+        scope = ChainMap(signal.args, signal.frame.f_globals)
+        if isinstance(probe, ProbeConditionMixin) and not signal._eval_condition(scope):
+            return


if this is a bug?

we can have a probe with a condition, the condition is false. it return without setting signal.state
at the exit() - we check if signal == None - go ahead and capture.

so, probe with eval==ENTRY will capture always on exit. I think we should mark this as SKIP_COND?

_eval_condition sets the state

dd-trace-py/ddtrace/debugging/_signal/model.py

Line 83 in 1d33870

self.state = SignalState.SKIP_COND

so we should be good

shatzi · 2024-10-24T16:16:19Z

ddtrace/debugging/_debugger.py

@@ -412,13 +426,28 @@ def _dd_debugger_hook(self, probe: Probe) -> None:
                log.error("Unsupported probe type: %r", type(probe))
                return

-            signal.line()
+            scope = ChainMap(actual_frame.f_locals, actual_frame.f_globals)


would love to see this also get moved under SignalContext - so there is only one place in our code that deal with those Mixin-s, what do you think?

Hmm but we don't need a context for a line probe 🤔

shatzi · 2024-10-24T16:17:38Z

ddtrace/debugging/_exception/replay.py

-                        snapshot.line()
+                        snapshot.line(ChainMap(frame.f_locals, frame.f_globals))
+
+                        snapshot.state = SignalState.DONE

                        # Collect
                        self.__uploader__.get_collector().push(snapshot)


where does the rate-limit of exception replay happen?

rate-limiting is done at the very beginning

dd-trace-py/ddtrace/debugging/_exception/replay.py

Lines 156 to 157 in 1d33870

if span.get_tag(DEBUG_INFO_TAG) == "true" or not can_capture(span):

# Debug info for span already captured or no budget to capture

P403n1x87 added changelog/no-changelog A changelog entry is not required for this PR. Dynamic Instrumentation Dynamic Instrumentation/Live Debugger labels Oct 24, 2024

P403n1x87 self-assigned this Oct 24, 2024

datadog-datadog-prod-us1 bot reviewed Oct 24, 2024

View reviewed changes

ddtrace/debugging/_signal/model.py Show resolved Hide resolved

P403n1x87 force-pushed the refactor/probe-management-boilerplate branch 2 times, most recently from 397d10d to ee8aa65 Compare October 24, 2024 10:57

P403n1x87 force-pushed the refactor/probe-management-boilerplate branch from ee8aa65 to 29823fb Compare October 24, 2024 14:26

refactor(di): encapsulate common signal code

1d33870

We encapsulate common signal boilerplate code to simplify the coding of signals and ensure homogeneous behaviour among them.

P403n1x87 force-pushed the refactor/probe-management-boilerplate branch from 29823fb to 1d33870 Compare October 24, 2024 14:50

P403n1x87 marked this pull request as ready for review October 24, 2024 14:57

P403n1x87 requested a review from a team as a code owner October 24, 2024 14:57

shatzi approved these changes Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(di): encapsulate common signal code #11153

refactor(di): encapsulate common signal code #11153

P403n1x87 commented Oct 24, 2024

github-actions bot commented Oct 24, 2024 •

edited

Loading

pr-commenter bot commented Oct 24, 2024 •

edited

Loading

shatzi left a comment

shatzi Oct 24, 2024

P403n1x87 Oct 24, 2024

shatzi Oct 24, 2024

P403n1x87 Oct 24, 2024

shatzi Oct 24, 2024

shatzi Oct 24, 2024

P403n1x87 Oct 24, 2024

shatzi Oct 24, 2024

P403n1x87 Oct 24, 2024

shatzi Oct 24, 2024

P403n1x87 Oct 24, 2024

	if span.get_tag(DEBUG_INFO_TAG) == "true" or not can_capture(span):
	# Debug info for span already captured or no budget to capture

refactor(di): encapsulate common signal code #11153

Are you sure you want to change the base?

refactor(di): encapsulate common signal code #11153

Conversation

P403n1x87 commented Oct 24, 2024

Checklist

Reviewer Checklist

github-actions bot commented Oct 24, 2024 • edited Loading

pr-commenter bot commented Oct 24, 2024 • edited Loading

Benchmarks

shatzi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 24, 2024 •

edited

Loading

pr-commenter bot commented Oct 24, 2024 •

edited

Loading