The Diagnostics CLI was built, and is maintained, by New Relic Global Technical Support. It is a diagnostic and troubleshooting tool used to find common issues with New Relic Supported Products and Projects. Great for apps not reporting data to New Relic. Issues with connectivity, configuration, and compatibility. If it finds an issue it will suggest resolutions and relevant documentation. If it can’t help you resolve the issue, the information it gathers will help when troubleshooting with New Relic Support.
Diagnostics CLI supports Linux, macOS, and Windows.
To install in a Docker container see here
- Download a zip of the latest version and see changes in our releases notes
- Extract the zip, and select the executable file for your OS.
- Place the executable in your application's root directory. (May not find all issues if located outside the apps root directory)
The Diagnostics CLI can help you troubleshoot issues and confirm that everything is working as expected. If after running the Diagnostics CLI you think you are still having issues review Global Technical Support options that may be available for your issue, the Diagnostics CLI output can help us resolve issues faster so keep it around! Optional, but highly recommended: Temporarily raise the logging level for the New Relic agent for more complete troubleshooting. Instructions can be found in this documentation
- Open an elevated command prompt
- Navigate to root directory of your application (or where ever you placed the binary
nrdiag) - Run
nrdiag
- Target functionality by using cmd line args such as suites to target specific products or issues or see all cmd line argos
- Review results( tips on interpreting output).
If after running the Diagnostics CLI, reviewing the output, and attempting to resolve the issue you are still having difficulties understanding what the issue is, the data gathered by the Diagnostics CLI can be used by Global Technical Support to help resolve the issue, often in quicker time then without the data. Note if you have fixed any issues called out by the Diagnostics CLI, either rerun it or let us know what you tried or changed (up to date results ensure more accurate troubleshooting)
If you have or are going to open a ticket with Global Technical Support, then uploading the data gathered by the Diagnostics CLI will as early as possible will speed up the troubleshooting process.
To upload your results automatically to a New Relic Support ticket all you need to do is run nrdiag binary using the attachment flag -a MY-ATTACHMENT-KEY You can get your attachment key by viewing the ticket in the New Relic Support Portal. You can also request a support engineer to provide you the attachment key.
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. If you have any questions, concerns or issues while running the Diagnostics CLI, reach out to us through our Explorers Hub. Or if the issue has been confirmed as a bug or is a Feature request, please file a Github issue. Either way we'll get back to you soon!
Have you ever dealt with a New Relic installation and/or configuration issue? Do you have suggestions on how to automate those steps to diagnose and solve the issue? Then we would love for you to contribute to the Diagnostics CLI (or at least file a very detailed feature request)! The Diagnostics CLI's main goal is to speed up and simplify the resolution of issues, no matter if you are working on your own or with our Support teams. All the information on how to build a new health check using the Diagnostics CLI, as well as the requirements to submit a PR, can be found in our docs directory. Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
Aditionally, you'll have to fork this repo prior to cloning or you'll get a permissions error.
If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
- Contributing overview
- Coding Guidelines
- Anatomy of a Task
- How To Build A Task
- Testing Overview
- Unit Testing
- Dependency Injection
- Integration Testing
The Diagnostics CLI is licensed under the Apache 2.0 License. The Diagnostics CLI also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.