Native AOT Diagnostics in .NET 8

[LakshanF]

Goal: Full Diagnostic Capability in NativeAOT Applications

• Logging
  • EventSource
    • Runtime library EventSource need to work
    • EventSource events can be read from Windows and Linux platforms
    • Create a plan for general EventSource to work (cut from .NET8). New APIs added in .NET8 to enable primitive payloads to be AOT compliant
  • DiagnosticSource can be used for in-proc logging (no serialization) and as out-proc (with serialization) via the EventSource bridge for Runtime libraries
  • ETW Events
    • GC, Contention, Exception, Heap Snapshot (cut from .NET8), Rundown (cut from .NET8)
• Diagnostic tool support
  • Following dotnet-* tools need to work
    • dotnet-trace, dotnet-counter, dotnet-monitor
• Open telemetry Plan
• Debugging support

Work that is needed in .NET 8 to make the above happen

• Port EventPipe to NativeAot (and make it possible to be used as an optional feature)
  • EventPipe support for Native AOT #83051
  • Will allow Linux to read EventSource events
  • Will allow Diagnostic tools to work seamlessly
  • Bring up plan
    • Use a tracing sample application (A dotnet-trace like client from here and a target process like here) to bring up EventPipe in NativeAOT. Specifically, enable CollectTracing2 on the IPC protocol.
    • EventPipe in NativeAOT works in both Linux and Windows
    • Enable tracing via environment variables
    • Use common container code from the EventPipe library
    • Dotnet-* tools (trace, monitor and counter) work with NativeAOT applications. Enable other relevant CommandSet
  • Measure perf
• EventSource & DiagnosticSource
  • Work with runtime library owners to ensure that trimming does not break
  • Work on a plan for EventSource source generator for the long-term solution (In .NET 8, compiler warnings will show problems)
• ETW Events
  • Contention events (Issues Emit Contention/Start and Contention/Stop Events on Native AOT Apps #76754 and [NativeAOT] Implement thin locks #75108 track this)
• Debugging support
  • Produce correct symbols NativeAOT: dwarfdump --verify produces thousands of warnings and errors #72552
  • Validate Native AOT experience in native debuggers #83037

Potential other improvements:

• NativeAOT Populate source link information in the final PDB #81415

[ghost]

Tagging subscribers to this area: @agocke, @MichalStrehovsky, @jkotas
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Goal: Full Diagnostic Capability in NativeAOT Applications

• Logging
  • EventSource
    • Runtime library EventSource need to work
    • EventSource events can be read from Windows and Linux platforms
    • Create a plan for general EventSource to work
  • DiagnosticSource can be used for in-proc logging (no serialization) and as out-proc (with serialization) via the EventSource bridge for Runtime libraries
  • ETW Events
    • GC, Contention, Exception, Heap Snapshot, Rundown
• Diagnostic tool support
  • Following dotnet-* tools need to work
    • dotnet-trace, dotnet-counter, dotnet-monitor
• Open telemetry Plan
• Debugging support

Work that is needed in .NET 8 to make the above happen

• Port EventPipe to NativeAot (and make it possible to be used as an optional feature)
  • Will allow Linux to read EventSource events
  • Will allow Diagnostic tools to work seamlessly
  • Bring up plan
    • Use a tracing sample application (A dotnet-trace like client from here and a target process like here) to bring up EventPipe in NativeAOT
    • EventPipe in NativeAOT works in both Linux and Windows
    • Dotnet-* tools (trace, monitor and counter) work with NativeAOT applications
• EventSource & DiagnosticSource
  • Work with runtime library owners to ensure that trimming does not break
  • Work on a plan for EventSource source generator for the long-term solution (In .NET 8, compiler warnings will show problems)
• ETW Events
  • Contention events (Issues Emit Contention/Start and Contention/Stop Events on Native AOT Apps #76754 and [NativeAOT] Implement thin locks #75108 track this)

Author:	LakshanF
Assignees:	LakshanF
Labels:	area-NativeAOT-coreclr
Milestone:	8.0.0

[agocke]

Closing out, as work is done for .NET 8

[filipnavara]

Heap Snapshot (cut from .NET8), Rundown (cut from .NET8)

Is there a new issue to follow for these?