README.md
HTTP API Documentation
The HTTP API enables on-demand extraction of diagnostic information and artifacts from discoverable processes.
[!NOTE] Some features are experimental and are denoted as
**[Experimental]**in this document.
The following are the root routes on the HTTP API surface.
| Route | Description | Version Introduced |
|---|---|---|
/processes |
Gets detailed information about discoverable processes. | 6.0 |
/dump |
Captures managed dumps of processes without using a debugger. | 6.0 |
/gcdump |
Captures GC dumps of processes. | 6.0 |
/trace |
Captures traces of processes without using a profiler. | 6.0 |
/metrics |
Captures metrics of a process in the Prometheus exposition format. | 6.0 |
/livemetrics |
Captures live metrics of a process. | 6.0 |
/stacks |
Gets the current callstacks of all .NET threads. | 8.0 Preview 7 |
/exceptions |
Gets a history of first chance exceptions from the default process. | 8.0 Preview 7 |
/logs |
Captures logs of processes. | 6.0 |
/info |
Gets info about dotnet monitor. |
6.0 |
/operations |
Gets egress operation status or cancels operations. | 6.0 |
/collectionrules |
Gets the current state of collection rules. | 6.3 |
/parameters |
Captures parameters for one or more methods each time they are called. | 8.0 RC 1 |
The dotnet monitor tool is able to detect .NET Core 3.1 and .NET 5+ applications. When connecting to a .NET Core 3.1 application, some information may not be available and is called out in the documentation.