Skip to content

Commit 8325ae9

Browse files
lucaspimentelclaude
andcommitted
[docs] Enhance Azure Functions and package architecture documentation
- Add NuGet package architecture section explaining Datadog.Trace vs Datadog.AzureFunctions packages - Document ASP.NET Core integration, HTTP proxying, and trace context propagation - Add comprehensive troubleshooting guide for Azure Functions with log analysis workflows - Include distributed tracing architecture explanation with host/worker process span handling - Add new QueryingDatadogAPIs.md guide for debugging with Datadog APIs - Update AGENTS.md with package references 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 51a3ab6 commit 8325ae9

File tree

3 files changed

+921
-8
lines changed

3 files changed

+921
-8
lines changed

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,25 @@
1919
- Loader/home: Build outputs publish a "monitoring home"; the native loader boots the tracer from there.
2020
- Build system: Nuke coordinates .NET builds and CMake/vcpkg for native components.
2121

22+
## NuGet Package Architecture
23+
24+
### Datadog.Trace Package
25+
The `Datadog.Trace` NuGet package provides the **manual instrumentation API** for customers:
26+
- **Contains**: `Datadog.Trace.Manual.dll` - Public API for manual instrumentation
27+
- **Does NOT contain**: Auto-instrumentation code or native profiler binaries
28+
- **Usage**: Reference in application code for manual tracing (e.g., `Tracer.Instance.StartActive()`)
29+
30+
Auto-instrumentation comes from the tracer "monitoring home" deployed separately (via installers, MSI, container images, or specialized packages like `Datadog.AzureFunctions`).
31+
32+
### Datadog.Trace.dll vs Datadog.Trace.Manual.dll
33+
- `Datadog.Trace.dll` - The full managed tracer with all auto-instrumentation code, loaded by the native profiler into instrumented processes
34+
- `Datadog.Trace.Manual.dll` - Lightweight manual instrumentation API packaged in the `Datadog.Trace` NuGet package for customer reference
35+
36+
### Specialized Packages
37+
- **Datadog.AzureFunctions**: Bundles `Datadog.Trace.dll` and native profiler for Azure Functions (see `docs/development/AzureFunctions.md`)
38+
- **Datadog.Monitoring.Distribution**: MSI installer for Windows (IIS, Windows Services)
39+
- Other serverless/platform-specific packages may bundle the full tracer similarly
40+
2241
## Tracer Structure
2342

2443
- `tracer/src/Datadog.Trace` — Core managed tracer library
@@ -299,6 +318,7 @@ The tracer runs in-process with customer applications and must have minimal perf
299318
- `docs/development/AzureFunctions-Architecture.md` — Azure Functions architecture deep dive
300319
- `docs/development/Serverless.md` — Serverless instrumentation
301320
- `docs/development/UpdatingTheSdk.md` — SDK updates
321+
- `docs/development/QueryingDatadogAPIs.md` — Querying Datadog APIs for debugging (spans, logs)
302322

303323
**CI & Testing:**
304324
- `docs/development/CI/TroubleshootingCIFailures.md` — Investigating build/test failures in Azure DevOps

0 commit comments

Comments
 (0)