Run the Diagnostics CLI (nrdiag)

To use the Diagnostics CLI:

Review the release notes, to make sure you have the latest version.
Download the latest version, which contains executable files for Linux, macOS, and Windows.
Move the executable for your platform into the location of your application's root directory.
Temporarily raise the logging level for the New Relic agent for more accurate troubleshooting. After you change the logging level, restart your application.
Run the executable. Recommendation: To scope your troubleshooting more easily, run nrdiag with a task suite (CLI option).

The Diagnostics CLI automatically searches its root directory and subdirectories for agent configuration files and other relevant data.

Platform-specific procedures

To 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 an attachment 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 an attachment 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 an attachment 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 an attachment 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 32-bit systems:
```
./nrdiag -suites SUITE NAMES
```
For 64-bit systems:
```
./nrdiag_x64 -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
```

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 32-bit systems:

./nrdiag -include ./path/to/file -attach

For 64-bit systems:

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

Windows:

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

For 32-bit systems:
```
nrdiag -include Path\To\File -attach
```

For 64-bit systems:

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

Upload results to a New Relic account

Important

If your system is configured to not connect to external IP addresses, this method will not work. Instead, attach the output files in an email to New Relic Support. If there is an issue with your license key, you will also need to send your output files in an email to support.

Automatic Account upload

To upload your results automatically to a New Relic account when the Diagnostics CLI is executed, use the -attach or -a command line flag. This will validate any New Relic License Keys found in your environment for upload.

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

Linux and macOS:

For 32-bit systems:
```
./nrdiag -attach
```
For 64-bit systems:
```
./nrdiag_x64 -attach
```

Windows:

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

For 32-bit systems:
```
nrdiag.exe -attach
```
For 64-bit systems:
```
nrdiag_x64.exe -attach
```

Platform-specific procedures

macOS

Windows

Browser monitoring

Docker container

Suites flag (highly recommended CLI option)

Include additional files in the zip

Upload results to a New Relic account

Important

Automatic Account upload