Skip to content

Commit

Permalink
Merge pull request #4194 from cade-conklin/patch-3
Browse files Browse the repository at this point in the history
DO NOT MERGE YET NRDIAG
  • Loading branch information
bradleycamacho committed Oct 21, 2021
2 parents 3ec6006 + 343fafe commit 9322182
Show file tree
Hide file tree
Showing 9 changed files with 85 additions and 58 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Limited technical support to troubleshoot if instrumentation is possible include

## Web app [#web-apps]

Some checks require elevated permissions. For best results, run [New Relic Diagnostics](/docs/agents/manage-apm-agents/troubleshooting/new-relic-diagnostics) from an Admin shell.
Some checks require elevated permissions. For best results, run [New Relic Diagnostics](/docs/agents/manage-apm-agents/troubleshooting/new-relic-diagnostics) from an admin shell.

Limited technical support to troubleshoot running web apps with the .NET agent installed includes:

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
subject: Diagnostics CLI (nrdiag)
releaseDate: '2021-10-13'
version: 2.0.0
downloadLink: 'https://download.newrelic.com/nrdiag/nrdiag_2.0.0.zip'
redirects:
- /docs/release-notes/platform-release-notes/diagnostics-release-notes/diagnostics-cli-200
---

## Changes

**Attachments**

* Command line flag `-a` or `-attachment-key` is now `-ak` or `-attachment-key`
* New command line flag `-a` or `-attach` needs no arguments to be supplied to it
* Uploads Diagnostics output to a New Relic account
* Removed command line flag `-file-upload` for arbitrary single files uploads
* All output is uploaded to S3 if specified with `-attach` or `-attachment-key`

**New Relic APM**

* **Node/Env/Versions** - Node 10 is no longer compatible with New Relic Node.js Agents 8.0.0.0 and above

## Bug Fixes

* **Infra/Config/IntegrationsValidateJson** - JSON validation of OHIS is now compatible with the new and old format for validation of OHIS
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ You acknowledge and agree that your use of the HIPAA Covered Services may occasi
- You may only use the services listed under "HITRUST CSF" set forth in our [regulatory audits documentation](/docs/security/security-privacy/compliance/regulatory-audits-new-relic-services/)
- You must select the [U.S. data region](/docs/using-new-relic/welcome-new-relic/get-started/our-eu-us-region-data-centers/) for all your HIPAA-enabled Accounts. Accounts in different geographical regions are ineligible for HIPAA-enabled Accounts.
- You must use [TLS 1.2](/docs/using-new-relic/cross-product-functions/install-configure/networks/#tls) to encrypt data in transit when using [New Relic Browser](/docs/browser/browser-monitoring/getting-started/introduction-browser-monitoring/).
- You must disable [Log Patterns](/docs/logs/log-management/ui-data/find-unusual-logs-log-patterns/#availability) any New Relic Accounts that contain PHI.
- You must disable [Log Patterns](/docs/logs/log-management/ui-data/find-unusual-logs-log-patterns/#availability) any New Relic accounts that contain PHI.
- You may not create an [Alert Policy](/docs/alerts-applied-intelligence/new-relic-alerts/alert-policies/) with any PHI in any [Alert Conditions](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/) or Alert Policy which uses email as a notification channel.
- You may not use such existing New Relic Account for your HIPAA-compliance needs if you have enabled Incident Intelligence for an existing New Relic Account. Instead, you must create a new New Relic HIPAA-enabled Account before sending any PHI.
- You may not use such existing New Relic account for your HIPAA-compliance needs if you have enabled Incident Intelligence for an existing New Relic account. Instead, you must create a new New Relic HIPAA-enabled Account before sending any PHI.
- When using New Relic’s iOS or Android mobile applications, you must enable mobile-device security controls sufficient for your compliance needs, such as device-level encryption, device-login access set to the highest setting, or disabling notifications on locked screens.

### Global Technical Support [#GTS]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ By default, this data is not transmitted to New Relic. You do have the option to

The use of the Diagnostics CLI is subject to this [license agreement](/docs/licenses/license-information/other-licenses/new-relic-diagnostics-licenses), as well as licensing agreements for open-source software used by the Diagnostics CLI.

## Data uploaded to support tickets [#support-tickets]
## Data uploaded to account [#uploaded-account-data]

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`](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/interpret-nrdiag-output) 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.
Before the collected files [contained within `nrdiag-output.zip` and `nrdiag-output.json`](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/interpret-nrdiag-output) 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. Otherwise these attachments are stored by New Relic. For more information, see [Zendesk's privacy and data protection policies](https://www.zendesk.com/company/privacy-and-data-protection/).
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](https://www.zendesk.com/company/privacy-and-data-protection/).

## Environment variables

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ redirects:
Download latest version
</ButtonLink>

The Diagnostics CLI (`nrdiag`) is a utility that automatically detects common problems with New Relic products. If the Diagnostics CLI detects a problem, it suggests troubleshooting steps. The Diagnostics CLI can also automatically attach troubleshooting data to a New Relic Support ticket.
The Diagnostics CLI (`nrdiag`) is a utility that automatically detects common problems with New Relic products. If the Diagnostics CLI detects a problem, it suggests troubleshooting steps. The Diagnostics CLI can automatically upload troubleshooting data to a New Relic account.

The Diagnostics CLI is open source and is located in [GitHub](https://github.com/newrelic/newrelic-diagnostics-cli).

Expand Down Expand Up @@ -49,7 +49,7 @@ The Diagnostics CLI does not require `superuser` or `admin` permissions to run,
To use the Diagnostics CLI:

1. Run the Diagnostics CLI, including [task suites](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/run-diagnostics-cli-nrdiag#suites) and [command line options](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/pass-command-line-options-nrdiag) as needed.
2. Include an [attachment key](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/run-diagnostics-cli-nrdiag#attachment-key) when you upload the results to your [Support ticket](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/run-diagnostics-cli-nrdiag#attach-ticket-results).
2. Supply the [-attach](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/pass-command-line-options-nrdiag) flag for uploading results to your New Relic account.
3. Optional: Validate your [config file settings](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/validate-config-file-settings-nrdiag).
4. Interpret the [output](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/interpret-nrdiag-output).

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
metaDescription: Three output files and status codes used with New Relic Diagnostics (nrdiag).
---

After executing the Diagnostics CLI from your terminal, you will see the results for each task as they are completed. Tasks that result in a `Warning` or `Failure` status code will log additional details regarding possible issues found during execution, along with troubleshooting suggestions and relevant links to documentation.
After executing the Diagnostics CLI from your terminal, you will see the results for each task as they are completed. Tasks that result in a `Warning` or `Failure` status code will log additional details regarding possible issues found during execution, along with troubleshooting suggestions and relevant links to documentation. If you use the `-attach` flag, you will be able to view your results in [New Relic One](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/interpret-nrdiag-output/#diag-in-nr1)

![screen-nrdiag-output.png](./images/screen-nrdiag-output_0.png "screen-nrdiag-output.png")

Expand Down Expand Up @@ -39,7 +39,7 @@ The Diagnostics CLI outputs three files:
</td>

<td>
A flattened folder structure with one or more config files and any existing New Relic logs. Attach this file to support tickets. This archive also contains a copy of `nrdiag-output.json`
A flattened folder structure with one or more config files and any existing New Relic logs. Attach this file to your New Relic account. This archive also contains a copy of `nrdiag-output.json`
</td>
</tr>

Expand All @@ -49,7 +49,7 @@ The Diagnostics CLI outputs three files:
</td>

<td>
Output of the individual tests. Attach this output to tickets.
Output of the individual tests. Attach this output to your New Relic account.
</td>
</tr>

Expand All @@ -59,7 +59,7 @@ The Diagnostics CLI outputs three files:
</td>

<td>
A list of files found. The `nrdiag-output.zip` file that you attach to support tickets automatically includes this list. You do not need to attach this `.txt` file separately.
A list of files found. The `nrdiag-output.zip` file that you attach to your New Relic account automatically includes this list. You do not need to attach this `.txt` file separately.
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -134,3 +134,16 @@ The Diagnostics CLI returns the following status codes after running:
</tr>
</tbody>
</table>

## Diagnostics CLI Output in NR1 [#diag-in-nr1]
* To examine the output of `nrdiag-output.json` in NR1, go to Apps -> then search for Diagnostics CLI Output
* Click the star next to the icon to add to your favorites
* Select an account from the dropdown
* This account is associated with the the license key that was validated by the Diagnostics CLI for upload
* Select a from a list of your previous Diagnostics CLI runs for that account
* For each task, a list of results each result status will be available to filter between
* Click on each button to list the specific results by status code for each task
* The right-hand of the screen will display a raw JSON of your results

![The Diagnostics CLI Output Application for NR1](./images/left-sidebar-nerdlet-diag.png "left-sidebar-nerdlet-diag.png")`

Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,29 @@ To use the following command line options with the Diagnostics CLI:
<td>
Attachment endpoint to include with the support ticket.
</td>
</tr>
<tr>
<td>
`-a`

`-attach`
</td>

<td>
Attach for automatic upload to a New Relic account. This uses a validated license key from your environment.
</td>
</tr>
<tr>
<td>
`-a STRING`
**DEPRECATED**

`-ak STRING`

`-attachment-key STRING`
</td>

<td>
Attachment key for [automatic upload to a support ticket](/docs/using-new-relic/cross-product-functions/diagnostics-cli-nrdiag/run-diagnostics-cli-nrdiag/#attach-ticket-results). This gets the attachment key from an existing ticket.
Attachment key for automatic upload to a support ticket. This gets the attachment key from an existing ticket. (Note: this functionality will be removed soon. Please use the automatic upload option above)
</td>
</tr>

Expand Down Expand Up @@ -70,18 +83,6 @@ To use the following command line options with the Diagnostics CLI:
</td>
</tr>

<tr>
<td>
`-file-upload STRING`
</td>

<td>
Diagnostics CLI version 1.1.8 or higher

**Requires running with `-a` option**. Allows upload of a single file at the path specified for the support ticket. This is in addition to files collected by default.
</td>
</tr>

<tr>
<td>
`--filter STRING`
Expand Down

0 comments on commit 9322182

Please sign in to comment.