Run the Diagnostics CLI (nrdiag)

Install and run the Diagnostics CLI

The Diagnostics CLI can be installed and run with a single command on Linux and Windows. This installation method will download the Diagnostics CLI binary to the present working directory. The Diagnostics CLI automatically searches its root directory and subdirectories for agent configuration files and other relevant data.

Change directory to the application's root directory.
Execute the following:
```
curl -Ls https://download.newrelic.com/nrdiag/scripts/install.sh | bash && sudo ./nrdiag CLI_OPTIONS
```
Recommendation: Scope your troubleshooting with a task suite (-suites), and upload relevant files to your New Relic account with the attachment flag (-attach).

Change directory to the application's root directory.

Execute the following:

[Net.ServicePointManager]::SecurityProtocol = 'tls12, tls'; (New-Object System.Net.WebClient).DownloadFile("https://download.newrelic.com/nrdiag/scripts/install.ps1", "$env:TEMP\install.ps1"); & PowerShell.exe -ExecutionPolicy Bypass -File $env:TEMP\install.ps1; & '.\nrdiag.exe' CLI_OPTIONS

Recommendation: Scope your troubleshooting with a task suite (-suites), and upload relevant files to your New Relic account with the attachment flag (-attach).

Platform-specific manual installation procedures

To manually install and run the Diagnostics CLI, follow the procedures for your platform:

Ensure you have the Diagnostics CLI:
- From the command line, change the directory to your application's root directory and ensure that the nrdiag.zip file is present.
  OR
- Manually download the latest version.
Unzip nrdiag.zip if necessary.
From the nrdiag_1.2.3/linux directory, move nrdiag into the application's root directory.
Run nrdiag (along with any CLI options
```
./nrdiag CLI_OPTIONS
```
The Diagnostics CLI outputs any issues it discovers, and uploads relevant files to your New Relic account if you include the -attach flag.

Ensure you have the Diagnostics CLI:
- From the command line, change directory to the application's root directory, and ensure that the nrdiag.zip file is present.
  OR
- Manually download the latest version.
Unzip nrdiag.zip if necessary.
From the nrdiag_1.2.3/win directory, move nrdiag.exe or nrdiag_x64.exe into the application's root directory.
For troubleshooting web applications, ensure you are running the executable from your project's parent directory, or specify your config file location with the -c option.
Run the executable (along with any CLI options from the directory you placed the binary. Since some checks require elevated permissions, for best results run from an admin shell.
Run via PowerShell if you add any CLI_OPTIONS:
```
./nrdiag.exe CLI_OPTIONS
```
OR, for x64 systems:
```
./nrdiag_x64.exe CLI_OPTIONS
```
The Diagnostics CLI outputs any issues it discovers, and uploads relevant files to New Relic account if you include the -attach flag.

Ensure you have the Diagnostics CLI:
- From the command line, change directory to the application's root directory and ensure that the nrdiag.zip file is present.
  OR
- Manually download the latest version.
Unzip nrdiag.zip if necessary.
From the nrdiag_1.2.3/mac directory, move nrdiag into the application's root directory.
Run nrdiag (along with any CLI options
```
./nrdiag CLI_OPTIONS
```
The Diagnostics CLI outputs any issues it discovers and uploads relevant files to your New Relic account if you include the -attach flag.

Ensure you have the latest version of the Diagnostics CLI. If necessary, manually download the latest version.
Unzip nrdiag.zip if necessary.
From the nrdiag_1.2.3/OS directory, run nrdiag (along with any CLI options:
```
./nrdiag -browser-url WEBSITE_URL CLI_OPTIONS
```
The Diagnostics CLI outputs any issues it discovers and uploads relevant files to your New Relic account if you include the -attach flag.

To troubleshoot your New Relic-instrumented application running in a Docker container, use the docker exec command:

Download and unzip the nrdiag_latest.zip file.
Copy the binary to the container. Replace IMAGE_NAME with the name of your docker container:
```
docker cp nrdiag/linux/nrdiag IMAGE_NAME:/bin
```
Run the nrdiag command in the docker container. Replace IMAGE_NAME as above, and replace APPLICATION_ROOT with the root directory of your application, where you installed the New Relic agent:
```
docker exec -it -w APPLICATION_ROOT IMAGE_NAME nrdiag
```
(Optional) Remove the nrdiag binary when finished:
```
docker exec IMAGE_NAME rm /bin/nrdiag
```

Suites flag (highly recommended CLI option)

A suite is a collection of health checks that target specific products or issues. Using a suite can help narrow the scope of troubleshooting and reduce the occurrence of false positives.

To review a list of available suites, run the Diagnostics CLI with the -help suites option:

./nrdiag -help suites

To run suites with nrdiag, provide the -suites flag and one or more suite names (for example, java) to run as arguments.

Linux and macOS:

For 64-bit systems:
```
./nrdiag_x64 -suites SUITE NAMES
```
For ARM64 systems:
```
./nrdiag_arm64 -suites SUITE NAMES
```

Windows:

To run from PowerShell, add ./ to the start of cmd.

For 32-bit systems:
```
nrdiag.exe -suites SUITE NAMES
```
For 64-bit systems:
```
nrdiag_x64.exe -suites SUITE NAMES
```
For ARM64 systems:
```
nrdiag_arm64.exe -suites SUITE NAMES
```

Scripts

Scripts provide an additional datasource for information that isn't collected by a task. The catalog of available scripts can be found in the Diagnostic CLI's github repository.

Script output

Script output is printed to the screen and is saved in a file based on the name of the script (for example, name-of-script.out). This is saved in the directory specified by -output-path, defaulting to the current directory.

Scripts can also output files, either to the current working directory or the directory specified by -output-path. All output files are included in the results zip in the ScriptOutput/ directory.

Script results

The results of running a script can be found in the nrdiag-output.json file with the following schema:

"Script": {
    "Name": "example",
    "Description": "Example Description",
    "Output": "example output",
    "OutputFiles": [
        "/path/to/example.out",
        "/path/to/another-file.out"
    ],
    "OutputTruncated": false
}

The Output field contains the stdout output. If it is over 20000 characters, it is truncated and the OutputTruncated field is set to true. Even if trucated, the full output is still available in the ScriptOutput/ directory in the zip file.

A list of files the script created can be found in the Outputfiles field.

List, view, and run a script

Include additional files in the zip

If you have additional files that you would like to share with support, you can include them in the nrdiag-output.zip file using the -include command line flag. This can be used with a single file or a directory. If a directory is provided, all of its subdirectories are included. The total size limit of the files included is 4GB.

Use this in combination with -attach to upload the files to your New Relic account.

Linux and macOS:

For 64-bit systems:

./nrdiag_x64 -include /entire/directory/ -attach

For ARM64 systems:

./nrdiag_arm64 -include /entire/directory/ -attach

Windows:

To run from PowerShell, add ./ to the start of cmd.

For 32-bit systems:

nrdiag.exe -include Path\To\File -attach

For 64-bit systems:

nrdiag_x64.exe -include \Entire\Directory\ -attach

For ARM64 systems:

nrdiag_arm64.exe -include \Entire\Directory\ -attach

Upload results to a New Relic account

Important

If your system is not configured to connect to external IP addresses, this method will not work. Instead, attach the output files in an email to New Relic Support.

Automatic account upload

To upload your results automatically to a New Relic account when the Diagnostics CLI is executed, use either the -attach or -api-key command line flags. The -attach flag will validate any New Relic license keys found in your environment and upload the run to the account associated with the license key. Alternatively, the -api-key flag will use the provided to upload the run, regardless of the presence of a valid license key.

Uploading your results to an account will automatically upload the contents of the nrdiag-output.json and nrdiag-output.zip.

To run from PowerShell, add ./ to the start of cmd.

For 32-bit systems:

nrdiag.exe -attach

nrdiag.exe -api-key ${API_KEY}

For 64-bit systems:

nrdiag_x64.exe -attach

nrdiag_x64.exe -api-key ${API_KEY}

For ARM64 systems:

nrdiag_arm64.exe -attach

nrdiag_arm64.exe -api-key ${API_KEY}

Region Selection

By default, the Diagnostics CLI uploads results to New Relic accounts hosted in the US data center. If your account is hosted in the EU data center, ensure to add -region eu to the command.

./nrdiag -region eu ...

Install and run the Diagnostics CLI

Linux

Windows

Platform-specific manual installation procedures

Linux

Windows

macOS

Browser monitoring

Docker container

Suites flag (highly recommended CLI option)

Scripts

Script output

Script results

List, view, and run a script

List available scripts

View a script

Run a script

Run a script with arguments

Run a script along with suites

Include additional files in the zip

Upload results to a New Relic account

Important

Automatic account upload

Linux and macOS

Windows

Region Selection