Skip to content

docs(instrumentation): add cross-cutting advice patterns reference doc#11456

Draft
jandro996 wants to merge 1 commit into
masterfrom
alejandro.gonzalez/docs-instrumentation
Draft

docs(instrumentation): add cross-cutting advice patterns reference doc#11456
jandro996 wants to merge 1 commit into
masterfrom
alejandro.gonzalez/docs-instrumentation

Conversation

@jandro996
Copy link
Copy Markdown
Member

Summary

  • Adds docs/instrumentation/advice-patterns.md: cross-cutting rules for @Advice instrumentation derived from 210+ PR reviews -- helperClassNames() nested class requirement, muzzleDirective() non-null constraint in assertInverse modules, @Advice.FieldValue typing, suppress = Throwable.class loop limitation, Config.get() muzzle failure in @RequiresRequestContext classes, reflection cache for version-variant return types, and business logic extraction rule.
  • Adds dd-java-agent/instrumentation/AGENTS.md as a lean index pointing to the extended docs.
  • Updates top-level AGENTS.md with instrumentation patterns entry.

No functional code changes.

Test plan

  • Docs-only PR - no tests required

@datadog-prod-us1-5

This comment has been minimized.

Adds docs/instrumentation/advice-patterns.md covering helperClassNames nested
class requirement, muzzleDirective non-null constraint, FieldValue typing,
suppress-Throwable loop limitation, Config.get() muzzle failure, reflection
cache for version-variant return types, and business logic extraction rule.
Adds dd-java-agent/instrumentation/AGENTS.md as a lean index.
@jandro996 jandro996 force-pushed the alejandro.gonzalez/docs-instrumentation branch 2 times, most recently from 3a07186 to 792d8b7 Compare May 25, 2026 12:16
@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented May 25, 2026

🟢 Java Benchmark SLOs — All performance SLOs passed

Suite Status
Startup 🟢 pass

SLO thresholds are defined here based on automatically generated metrics. A warning is raised when results are within 5% of the threshold.

PR vs. master results

Startup Time

Scenario This PR master Change
insecure-bank / iast 14,087 ms 13,951 ms +1.0%
insecure-bank / tracing 12,984 ms 12,969 ms +0.1%
petclinic / appsec 16,462 ms 16,310 ms +0.9%
petclinic / iast 16,405 ms 16,516 ms -0.7%
petclinic / profiling 16,465 ms 15,598 ms +5.6%
petclinic / tracing 15,923 ms 15,234 ms +4.5%

Commit: 792d8b7d · CI Pipeline · Benchmarking Platform UI


Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant