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.

Sign up for GitHub

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

Use two budgets depending on type #8283

Merged
merged 4 commits into from
Jan 25, 2025
Merged

Use two budgets depending on type #8283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
352efb3
add a tag tracking the overall invocation account
evanchooly Jan 24, 2025
195a0fb
two budgets for capture vs non-capture snapshots
evanchooly Jan 24, 2025
75c7dae
use _ instead of space in case metrics tags don't allow spaces
evanchooly Jan 24, 2025
0df836a
we just need to store the counts
evanchooly Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...er/debugger-bootstrap/src/main/java/datadog/trace/bootstrap/debugger/DebuggerContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ public String tag() {
public String tag() {
return "cause:debug session disabled";
}
},
BUDGET {
@Override
public String tag() {
return "cause:budget_exceeded";
}
};

public abstract String tag();
Expand Down
26 changes: 19 additions & 7 deletions dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/probe/LogProbe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.datadog.debugger.probe;

import static com.datadog.debugger.probe.LogProbe.Capture.toLimits;
import static java.lang.String.format;

import com.datadog.debugger.agent.DebuggerAgent;
import com.datadog.debugger.agent.Generated;
Expand Down Expand Up @@ -62,7 +63,8 @@ public class LogProbe extends ProbeDefinition implements Sampled {
private static final Limits LIMITS = new Limits(1, 3, 8192, 5);
private static final int LOG_MSG_LIMIT = 8192;

public static final int PROBE_BUDGET = 10;
public static final int CAPTURING_PROBE_BUDGET = 10;
public static final int NON_CAPTURING_PROBE_BUDGET = 1000;

/** Stores part of a templated message either a str or an expression */
public static class Segment {
Expand Down Expand Up @@ -575,14 +577,17 @@ public void commit(
CapturedContext exitContext,
List<CapturedContext.CapturedThrowable> caughtExceptions) {
Snapshot snapshot = createSnapshot();
boolean shouldCommit =
inBudget() && fillSnapshot(entryContext, exitContext, caughtExceptions, snapshot);
boolean shouldCommit = fillSnapshot(entryContext, exitContext, caughtExceptions, snapshot);
DebuggerSink sink = DebuggerAgent.getSink();
if (shouldCommit) {
Copy link
Contributor

Choose a reason for hiding this comment

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

we can reverse the if to make it less nested

if (!shouldCommit) {
sink.skipSnapshot(id, DebuggerContext.SkipCause.CONDITION);
return;
}
if (!inBudget()) {
sink.skipSnapshot(id, DebuggerContext.SkipCause.BUDGET);
return;
}
commitSnapshot(....

commitSnapshot(snapshot, sink);
incrementBudget();
if (snapshotProcessor != null) {
snapshotProcessor.accept(snapshot);
if (inBudget()) {
commitSnapshot(snapshot, sink);
if (snapshotProcessor != null) {
snapshotProcessor.accept(snapshot);
}
} else {
sink.skipSnapshot(id, DebuggerContext.SkipCause.BUDGET);
}
} else {
sink.skipSnapshot(id, DebuggerContext.SkipCause.CONDITION);
Expand Down Expand Up @@ -866,7 +871,9 @@ public String toString() {

private boolean inBudget() {
AtomicInteger budgetLevel = getBudgetLevel();
return budgetLevel == null || budgetLevel.get() < PROBE_BUDGET;
return budgetLevel == null
|| budgetLevel.get()
<= (captureSnapshot ? CAPTURING_PROBE_BUDGET : NON_CAPTURING_PROBE_BUDGET);
}

private AtomicInteger getBudgetLevel() {
Expand All @@ -881,6 +888,11 @@ private void incrementBudget() {
AtomicInteger budgetLevel = getBudgetLevel();
if (budgetLevel != null) {
budgetLevel.incrementAndGet();
TracerAPI tracer = AgentTracer.get();
AgentSpan span = tracer != null ? tracer.activeSpan() : null;
if (span != null) {
span.getLocalRootSpan().setTag(format("_dd.ld.probe_id.%s", id), budgetLevel.get());
}
}
}

Expand Down
4 changes: 0 additions & 4 deletions dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/sink/SnapshotSink.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,6 @@ public SnapshotSink(Config config, String tags, BatchUploader snapshotUploader)
this.snapshotUploader = snapshotUploader;
}

public BlockingQueue<Snapshot> getLowRateSnapshots() {
return lowRateSnapshots;
}

public void start() {
if (started.compareAndSet(false, true)) {
highRateScheduled =
Expand Down
61 changes: 53 additions & 8 deletions dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/probe/LogProbeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import com.datadog.debugger.sink.DebuggerSink;
import com.datadog.debugger.sink.ProbeStatusSink;
import com.datadog.debugger.sink.Snapshot;
import datadog.trace.api.Config;
import datadog.trace.api.IdGenerationStrategy;
import datadog.trace.bootstrap.debugger.CapturedContext;
import datadog.trace.bootstrap.debugger.EvaluationError;
Expand Down Expand Up @@ -80,20 +81,28 @@ public void noDebugSession() {

@Test
public void budgets() {
DebuggerSink sink = new DebuggerSink(getConfig(), mock(ProbeStatusSink.class));
BudgetSink sink = new BudgetSink(getConfig(), mock(ProbeStatusSink.class));
DebuggerAgentHelper.injectSink(sink);
assertEquals(0, sink.getSnapshotSink().getLowRateSnapshots().size());

TracerAPI tracer =
CoreTracer.builder().idGenerationStrategy(IdGenerationStrategy.fromName("random")).build();
AgentTracer.registerIfAbsent(tracer);
int runs = 100;
for (int i = 0; i < runs; i++) {
runTrace(tracer);
runTrace(tracer, true);
}
assertEquals(runs * LogProbe.CAPTURING_PROBE_BUDGET, sink.captures);

sink = new BudgetSink(getConfig(), mock(ProbeStatusSink.class));
DebuggerAgentHelper.injectSink(sink);
runs = 1010;
for (int i = 0; i < runs; i++) {
runTrace(tracer, false);
}
assertEquals(runs * LogProbe.PROBE_BUDGET, sink.getSnapshotSink().getLowRateSnapshots().size());
assertEquals(runs * LogProbe.NON_CAPTURING_PROBE_BUDGET, sink.highRate);
}

private void runTrace(TracerAPI tracer) {
private void runTrace(TracerAPI tracer, boolean captureSnapshot) {
AgentSpan span = tracer.startSpan("budget testing", "test span");
span.setTag(Tags.PROPAGATED_DEBUG, "12345:1");
try (AgentScope scope = tracer.activateSpan(span, ScopeSource.MANUAL)) {
Expand All @@ -102,17 +111,23 @@ private void runTrace(TracerAPI tracer) {
createLog("I'm in a debug session")
.probeId(ProbeId.newId())
.tags("session_id:12345")
.captureSnapshot(true)
.captureSnapshot(captureSnapshot)
.build();

CapturedContext entryContext = capturedContext(span, logProbe);
CapturedContext exitContext = capturedContext(span, logProbe);
logProbe.evaluate(entryContext, new LogStatus(logProbe), MethodLocation.ENTRY);
logProbe.evaluate(exitContext, new LogStatus(logProbe), MethodLocation.EXIT);

for (int i = 0; i < 20; i++) {
int budget =
logProbe.isCaptureSnapshot()
? LogProbe.CAPTURING_PROBE_BUDGET
: LogProbe.NON_CAPTURING_PROBE_BUDGET;
int runs = budget + 20;

for (int i = 0; i < runs; i++) {
logProbe.commit(entryContext, exitContext, emptyList());
}
assertEquals(runs, span.getLocalRootSpan().getTag(format("_dd.ld.probe_id.%s", logProbe.id)));
}
}

Expand Down Expand Up @@ -293,4 +308,34 @@ private Builder createLog(String template) {
.probeId(PROBE_ID)
.template(template, parseTemplate(template));
}

private static class BudgetSink extends DebuggerSink {

public int captures;
public int highRate;

public BudgetSink(Config config, ProbeStatusSink probeStatusSink) {
super(config, probeStatusSink);
}

@Override
public void addHighRateSnapshot(Snapshot snapshot) {
highRate++;
}

@Override
public void addSnapshot(Snapshot snapshot) {
captures++;
}

@Override
public void start() {
super.start();
}

@Override
public void stop() {
super.stop();
}
}
}
Loading