Like any other New Relic tool, the Diagnostics CLI service is designed to protect you and your customers' data privacy. The Diagnostics CLI inspects system information and New Relic product artifacts (logs and config files) that are relevant for performing diagnostic checks that assess New Relic product configuration and operability.
By default, this data is not transmitted to New Relic. You do have the option to upload this information to a support ticket over HTTPS. For more information about New Relic's security measures, see our security and privacy documentation, or visit the New Relic security website.
License agreements
The use of the Diagnostics CLI is subject to this license agreement, as well as licensing agreements for open-source software used by the Diagnostics CLI.
Data uploaded to account
The Diagnostics CLI allows uploading of this information to a support ticket over HTTPS if you use a specific command-line argument. You will be prompted before the collection of any files that we expect to have sensitive information.
Before the collected files contained within nrdiag-output.zip and nrdiag-output.json are uploaded to New Relic, you will also be prompted. This allows you to review and edit any information that you do not want to provide. (For example, the nrdiag-output.zip will include your user name.) You also have the option to cancel the upload altogether.
Data storage
Any support ticket attachments made using nrdiag or containing nrdiag data that are less than or equal to 20MB are stored by Zendesk. All of these attachments are stored by New Relic. For more information, see Zendesk's privacy and data protection policies.
Environment variables
The Diagnostics CLI examines the following environment variables to perform diagnostic checks. The values of these variables are recorded locally in the nrdiag-output.json file. These include:
- Any environment variable containing
NEWRELICorNEW_RELIC - Any environment variable beginning with
NRIA
A-C:
APP_ENVAPPDATACOR_ENABLE_PROFILERCOR_PROFILERCOR_PROFILER_PATHCORECLR_ENABLE_PROFILINGCORECLR_PROFILERCORECLR_PROFILER_PATH
D-I:
DEFAULT_LOCALE_CFG_FILEDOCKER_API_VERSIONDOCKER_HOSTDOTNET_INSTALL_PATHDOTNET_SDK_VERSIONGLIBC_REPOGLIBC_VERSIONHOME
J-L:
JAVA_HOMEJAVA_JCEJAVA_PACKAGEJAVA_VERSION_BUILDJAVA_VERSION_MAJORJAVA_VERSION_MINORJBOSS_HOMELANGLOCALAPPDATA
M:
MINION_API_ENDPOINTMINION_API_PROXYMINION_API_PROXY_SELF_SIGNED_CERTMINION_CHECK_TIMEOUTMINION_DOCKER_API_VERSIONMINION_DOCKER_HOSTMINION_DOCKER_RUNNER_APPARMORMINION_DOCKER_RUNNER_REGISTRY_ENDPOINTMINION_GROUPMINION_JARMINION_JVM_MBMINION_JVM_OPTSMINION_LOG_LEVELMINION_PROVIDERMINION_USER
N-Z:
PATHProgramFilesProgramDataRACK_ENVRAILS_ENVRUBY_ENVWORKDIR
For more help
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.