Skip to content

localmachine.md

Latest commit

 

History

History
54 lines (36 loc) · 2.67 KB

localmachine.md

File metadata and controls

54 lines (36 loc) · 2.67 KB

Was this documentation helpful? Share feedback

Running on a local machine

dotnet monitor can be installed as a global tool providing observability, diagnostics artifact collection, and triggering in local development and testing scenarios. You can run dotnet tool install -g dotnet-monitor to install the latest version, see the full details here.

Local authentication options

If you are using dotnet monitor as a local development tool on Windows you have the option to use Windows Authentication which requires no additional configuration.

There are a number of local development scenarios that are much more efficient without authentication; dotnet monitor can be explicitly configured to disable authentication. Additional security details can be reviewed here.

Local configuration

To monitor a specific local process you can use the settings file to define a default process. This ensures dotnet monitor automatically collects artifacts and logs based on a process criteria you have identified (e.g., process name, process id, etc.).

Defining a default process on Windows requires creating a settings file in the user path (%USERPROFILE%\.dotnet-monitor\settings.json). In the following example the default process has a process name of BuggyDemoWeb.

{
    "$schema": "https://aka.ms/dotnet-monitor-schema",
    "DefaultProcess": {
        "Filters": [{
            "Key": "ProcessName",
            "Value": "BuggyDemoWeb"
        }]
    }
}

dotnet monitor collection

To start using dotnet monitor, run the following command from a PowerShell or Command prompt:

dotnet-monitor collect

Assuming your default process is running, you can use the endpoints exposed by dotnet monitor to view metrics and logs or to download traces and memory dumps. When using Windows Authentication, your browser will automatically handle the Windows authentication challenge, allowing you to navigate to these endpoints directly.

HTTP /dump API

/dump

HTTP /trace API

/trace

Alternatively, if you are using an API Key, you must specify it via the Authorization header, you can accomplish that with a CLI tool like CURL.

In addition to downloading artifacts directly over HTTP, artifacts can be output to specific local directories by configuring egress file providers in the settings file.