Skip to content

Add dd-autoinstrumentation CLI with LLM-native structured output #8313

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

Draft
bouwkast wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Add dd-autoinstrumentation CLI with LLM-native structured output #8313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72b14d2
Extract Datadog.AutoInstrumentation.Generator.Core shared library
bouwkast Mar 13, 2026
ed7ae68
Add CLI tool for auto-instrumentation code generation
bouwkast Mar 13, 2026
2297185
Make dd-autoinstrumentation CLI LLM-native with structured output and…
bouwkast Mar 16, 2026
9fdbc38
Add documentation for CLI inspect command, structured errors, and LLM…
bouwkast Mar 16, 2026
dd7cbfc
Handle invalid assembly files with structured BAD_ASSEMBLY error
bouwkast Mar 16, 2026
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
9 changes: 8 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,15 @@ Auto-instrumentation comes from the tracer "monitoring home" deployed separately
- Implement `OnMethodBegin` and `OnMethodEnd`/`OnAsyncMethodEnd` handlers
- Use duck typing constraints (`where TReq : IMyShape, IDuckType`) or `obj.DuckCast<IMyShape>()` for third-party types
- Tests: Add under `tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests` with samples in `tracer/test/test-applications/integrations`
- Generate boilerplate: `./tracer/build.ps1 RunInstrumentationGenerator`
- Generate boilerplate (GUI): `./tracer/build.ps1 RunInstrumentationGenerator`
- Generate boilerplate (CLI): `./tracer/build.ps1 RunInstrumentationGeneratorCli --assembly-path <dll> --type-name <type> --method-name <method>`

📖 **Load when**: Creating a new integration or adding instrumentation to an existing library
- **`docs/development/AutomaticInstrumentation.md`** — Complete guide to creating integrations, CallTarget wiring, testing strategies, package version configuration, and CI testing
- **`docs/development/InstrumentationGenerator.md`** — GUI and CLI instrumentation generator tools, Nuke integration, duck typing flags, JSON output, and two-tool workflow with dotnet-inspect

📖 **Load when**: Using the CLI tool programmatically or as an AI agent to inspect assemblies and generate instrumentation code
- **`docs/development/for-ai/InstrumentationGenerator-CLI.md`** — Complete LLM reference: all commands, JSON schemas, error codes, recovery patterns, and recommended autonomous workflow

📖 **Load when**: Working with third-party types that can't be directly referenced or need version-agnostic access
- **`docs/development/DuckTyping.md`** — Duck typing patterns, proxy types, binding attributes, best practices, and performance benchmarks
Expand Down Expand Up @@ -307,6 +312,8 @@ The tracer runs in-process with customer applications and must have minimal perf

**Development guides:**
- `docs/development/AutomaticInstrumentation.md` — Creating integrations
- `docs/development/InstrumentationGenerator.md` — GUI and CLI instrumentation generator tools
- `docs/development/for-ai/InstrumentationGenerator-CLI.md` — LLM reference for the CLI (commands, JSON schemas, error handling)
- `docs/development/DuckTyping.md` — Duck typing guide
- `docs/development/TracerDebugging.md` — Local debugging, IDE configuration, path issues, and troubleshooting
- `docs/development/AzureFunctions.md` — Azure Functions integration
Expand Down
14 changes: 14 additions & 0 deletions Datadog.Trace.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Datadog.FeatureFlags.OpenFe
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Samples.LifetimeManager.TerminationSignals", "tracer\test\test-applications\integrations\Samples.LifetimeManager.TerminationSignals\Samples.LifetimeManager.TerminationSignals.csproj", "{0E3E1069-80FF-99C9-D29F-936D96D5F516}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Datadog.AutoInstrumentation.Generator.Core", "tracer\src\Datadog.AutoInstrumentation.Generator.Core\Datadog.AutoInstrumentation.Generator.Core.csproj", "{B3A07CA3-3536-4D43-81A3-A5A73FB76F22}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Datadog.AutoInstrumentation.Generator.Cli", "tracer\src\Datadog.AutoInstrumentation.Generator.Cli\Datadog.AutoInstrumentation.Generator.Cli.csproj", "{8D722514-8BAD-4069-84D0-15797026E0ED}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -1549,6 +1553,14 @@ Global
{0E3E1069-80FF-99C9-D29F-936D96D5F516}.Debug|Any CPU.Build.0 = Debug|Any CPU
{0E3E1069-80FF-99C9-D29F-936D96D5F516}.Release|Any CPU.ActiveCfg = Release|Any CPU
{0E3E1069-80FF-99C9-D29F-936D96D5F516}.Release|Any CPU.Build.0 = Release|Any CPU
{B3A07CA3-3536-4D43-81A3-A5A73FB76F22}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{B3A07CA3-3536-4D43-81A3-A5A73FB76F22}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B3A07CA3-3536-4D43-81A3-A5A73FB76F22}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B3A07CA3-3536-4D43-81A3-A5A73FB76F22}.Release|Any CPU.Build.0 = Release|Any CPU
{8D722514-8BAD-4069-84D0-15797026E0ED}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8D722514-8BAD-4069-84D0-15797026E0ED}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8D722514-8BAD-4069-84D0-15797026E0ED}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8D722514-8BAD-4069-84D0-15797026E0ED}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -1801,6 +1813,8 @@ Global
{64258238-DE63-4A0F-A618-DF51735BA22A} = {8CEC2042-F11C-49F5-A674-2355793B600A}
{CFECF8D4-3A46-35A8-7CB1-BA359974A1A9} = {9E5F0022-0A50-40BF-AC6A-C3078585ECAB}
{0E3E1069-80FF-99C9-D29F-936D96D5F516} = {BAF8F246-3645-42AD-B1D0-0F7EAFBAB34A}
{B3A07CA3-3536-4D43-81A3-A5A73FB76F22} = {9E5F0022-0A50-40BF-AC6A-C3078585ECAB}
{8D722514-8BAD-4069-84D0-15797026E0ED} = {9E5F0022-0A50-40BF-AC6A-C3078585ECAB}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {160A1D00-1F5B-40F8-A155-621B4459D78F}
Expand Down
24 changes: 17 additions & 7 deletions docs/development/AutomaticInstrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,19 +291,29 @@ Additional information regarding the specific limitations with these can be foun

### AutoInstrumentation Generator

There's a tool to help developers in the process of creating all the boilerplate code for new instrumentations.
There are two tools to help developers create the boilerplate code for new instrumentations: an interactive **GUI** and a scriptable **CLI**. See [InstrumentationGenerator.md](./InstrumentationGenerator.md) for full documentation.

To run the tool use: `./tracer/build.ps1 RunInstrumentationGenerator`
**GUI** (interactive browsing and generation):

#### Nuke command:
```bash
./tracer/build.ps1 RunInstrumentationGenerator
```

![nuke command](./images/gen01.jpg)
**CLI** (scriptable, CI-friendly, AI-assisted workflows):

#### Main window:
```bash
# Via Nuke
.\tracer\build.cmd RunInstrumentationGeneratorCli --assembly-path "path/to/MyLib.dll" --type-name "MyLib.MyClass" --method-name "DoSomething"

![tool main window](./images/gen02.jpg)
# Via dotnet run
dotnet run --project tracer/src/Datadog.AutoInstrumentation.Generator.Cli/ --framework net8.0 -- generate path/to/MyLib.dll -t MyLib.MyClass -m DoSomething
```

#### GUI screenshots:

#### Creating a new Instrumentation class with the DuckType proxies:
![nuke command](./images/gen01.jpg)

![tool main window](./images/gen02.jpg)

![tool main window](./images/gen03.jpg)

Expand Down
Loading
Loading