Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(Alerts): Improving the alert conditions section #18976

Draft
wants to merge 21 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
c8218c8
fix(Alerts): Improving the alert conditions section
nbaenam Oct 16, 2024
a616cba
fix(Alerts): Modified the nav file
nbaenam Oct 16, 2024
52d1a3b
fix(Alerts): Modified the nav file
nbaenam Oct 16, 2024
e73c7a2
fix(Alerts): Updated the Alert coverage gaps page
nbaenam Oct 16, 2024
9d56c15
style(Alerts): Modified the alert coverage gaps page
nbaenam Oct 16, 2024
f1d0807
fix(Alerts): Updating Streaming alerts
nbaenam Oct 21, 2024
c5599f3
fix(Alerts): Updating Streaming alerts
nbaenam Oct 21, 2024
0a16527
fix(Alerts): Moving the Examples section and navigation changes
nbaenam Oct 22, 2024
586df85
fix(Alerts): Fixed changes of moving files in the i18n folder
nbaenam Oct 22, 2024
fd6e4a0
fix(Alerts): Fixed conflicts with the i18n files
nbaenam Oct 22, 2024
c2a1389
fix(Alerts): Removed the Create an alert section
nbaenam Oct 22, 2024
54f61f0
fix(Alerts): Moving i18n files
nbaenam Oct 22, 2024
245af5a
fix(Alerts): Fixed conflicts with the i18n files
nbaenam Oct 23, 2024
4405908
Merge branch 'develop' into nb-alerts-create-conditions1
nbaenam Oct 23, 2024
99ffedc
fix(Alerts): Added more changes
nbaenam Oct 23, 2024
121fa9e
fix(Alerts): Added more changes
nbaenam Oct 23, 2024
3d20ad0
fix(Alerts): Fixed indentation and navigation modification
nbaenam Oct 23, 2024
1ac0680
Merge branch 'develop' into nb-alerts-create-conditions1
nbaenam Oct 28, 2024
ba12821
Merge branch 'develop' into nb-alerts-create-conditions1
nbaenam Oct 30, 2024
42827d2
fix(Alerts): Updated the Alerts for infrastructure doc
nbaenam Oct 31, 2024
d571631
Merge branch 'develop' into nb-alerts-create-conditions1
nbaenam Oct 31, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ Here are some more details about some of our add-on manager roles:
* Provide [runbook instructions](/docs/alerts/new-relic-alerts/defining-conditions/provide-runbook-instructions-alert-activity).
* Select [product targets](/docs/alerts/new-relic-alerts/defining-conditions/select-product-targets-alert-condition).
* Alter [alert condition thresholds](/docs/alerts/new-relic-alerts/defining-conditions/define-thresholds-trigger-alert#thresholds).
* [Create](/docs/alerts/new-relic-alerts/managing-notification-channels/notification-channels-controlling-where-send-alerts#add-channel), [modify](/docs/alerts/new-relic-alerts/managing-notification-channels/update-alert-notification-channels), or [delete](/docs/alerts/new-relic-alerts/managing-notification-channels/delete-alert-notification-channels) notification channels.
* Create, modify, or delete [notification channels](/docs/alerts/get-notified/intro-notifications/#channels).
</Collapser>

<Collapser
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Alert coverage gaps and condition recommendations
title: Alert coverage gaps
tags:
- Alerts
- Proactive detection
Expand All @@ -8,31 +8,26 @@
redirects:
- /docs/alerts-applied-intelligence/new-relic-alerts/get-started/condition-recommendations
- /docs/alerts-applied-intelligence/applied-intelligence/alert-coverage-gaps
freshnessValidatedDate: never
- /docs/alerts/create-alert/alert-coverage-gaps
freshnessValidatedDate: 2024-10-28
---

Alert coverage gaps highlight areas in your stack where you're missing alert coverage. In our <InlinePopover type="alerts"/> section, [we've created a homepage](https://one.newrelic.com/nrai/detection-gaps/home) that includes uncovered APM, Browser, and Mobile entities, so you can assess what information your team is lacking and address the coverage gap.
Alert coverage gaps highlight areas in your stack where you're missing alert coverage. In our <InlinePopover type="alerts"/> section, [we've created a homepage](https://one.newrelic.com/nrai/detection-gaps/home) that includes uncovered <InlinePopover type="apm" />, <InlinePopover type="browser"/>, and <InlinePopover type="mobile" /> entities, so you can assess what information your team is lacking and address the coverage gap.

In an increasingly dynamic landscape, we know how important it's to stay on top of your stack and be proactively notified if anything goes wrong. But, as your team grows or changes, it can be hard to know if you're getting the alerts you need, when you need them. Alert coverage gaps gives your team a comprehensive list of all entities that your team _is not currently covering_.
In an increasingly dynamic landscape, we know how important it's to stay on top of your stack and be proactively notified if anything goes wrong. But, as your team grows or changes, it can be hard to know if you're getting the alerts you need, when you need them. Alert coverage gaps gives your team a comprehensive list of all entities that your team is not currently covering.

Check failure on line 17 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L17

[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 17, "column": 353}}}, "severity": "ERROR"}

What does covering an entity mean? A covered entity means that you've set up an [alert](/docs/alerts-applied-intelligence/overview/#concepts-terms) to notify you of how a particular entity is performing. For example, you might have created an alert condition that opens an incident if the throughput of an APM entity exceeds 100 requests per minute. An uncovered entity is part of your system that is unmonitored which means there could be unhealthy behavior that goes unchecked. We created [alert coverage gaps](https://one.newrelic.com/nrai/detection-gaps/home) to highlight uncovered entities so your team doesn't miss valuable data and you can prevent incidents before they happen.

## Find your coverage gaps [#find-your-coverage-gaps]

To open the alert coverage gaps page, go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert coverage gaps**</DNT> in the left navigation pane. There, you will see a list of all your entitites that are not currently covered.

Depending on the covered entities, this page can include these tabs:

* <DNT>**APM**</DNT>.
* <DNT>**Browser**</DNT>.
* <DNT>**Mobile**</DNT>.

If there are no uncovered entities for <DNT>**Browser**</DNT> or <DNT>**Mobile**</DNT>, you won't see that specific tab.
Depending on the covered entities, this page can include these tabs for APM, browser monitoring, mobile monitoring, synthetics, and service level. If there are no uncovered entities for these capabilities, you won't see that specific tab.

<img
title="Alert coverage gaps page"
alt="A screenshot of the alert coverage gaps page"
src="/images/accounts_screenshot-full_alert-coverage-gaps-homepage.webp"
alt="Alert coverage gaps page"
src="/images/alerts_screenshot-crop_coverage-gaps.webp"
/>

<figcaption>
Expand All @@ -41,44 +36,78 @@

## Create an alert from your alert coverage gaps [#create-an-alert]

Once you've selected an entity you'd like to monitor, then you can create an alert condition to notify your team of any abnormal behavior.
Once you've selected an entity you'd like to monitor, then you can create an alert condition to notify your team of any abnormal behavior. Follow these steps to create an alert from your alert coverage gaps:

Check notice on line 39 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L39

[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 39, "column": 46}}}, "severity": "INFO"}

Check notice on line 39 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L39

[new-relic.ComplexWords] Consider using 'tell' instead of 'notify'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'tell' instead of 'notify'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 39, "column": 97}}}, "severity": "INFO"}

New Relic will dynamically suggest the conditions we believe should be monitored based on the selected entity and your specific system. Some of the recommended alerts we might suggest are error percentage, apdex, or response time.
1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert coverage gaps**</DNT> in the left navigation pane.

You'll get recommended alert conditions based on the entity type's defined [Golden Metrics](https://github.com/newrelic/entity-definitions). If you don't get recommended alert conditions, once you select an alert condition you'd like to monitor, then your team will be alerted when this signal deviates from its normal baseline, upper and lower, for at least 5 minutes by 3.00 standard deviations.
2. Select the entity you'd like to monitor. You can select more than one.

Check notice on line 43 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L43

[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 43, "column": 36}}}, "severity": "INFO"}

To create an alert from your alert coverage gaps:
3. Click <DNT>**+ Recommend alert conditions**</DNT>.

1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert coverage gaps**</DNT> in the left navigation pane.
<img
title="Alert coverage gaps page"
alt="Alert coverage gaps page"
src="/images/alerts_screenshot-crop_coverage-gaps-recommend-button.webp"
/>

4. The <DNT>**Add an alert**</DNT> page opens. Select one of these options:

2. Click <DNT>**Add alert**</DNT> on the entity you want to create the alert.
* <DNT>**Response time (ms)**</DNT>: Alert when this signal deviates from its normal baseline, upper only, for at least 5 minutes by 3.00 standard deviation(s).

Check failure on line 55 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L55

[Microsoft.Plurals] Don't add '(s)' to a singular noun. Use plural instead.
Raw output
{"message": "[Microsoft.Plurals] Don't add '(s)' to a singular noun. Use plural instead.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 55, "column": 161}}}, "severity": "ERROR"}

3. Add the recommended conditions you want.
* <DNT>**Throughput**</DNT>: Alert when this signal deviates from its normal baseline, upper and lower, for at least 5 minutes by 3.00 standard deviation(s).

Check failure on line 57 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L57

[Microsoft.Plurals] Don't add '(s)' to a singular noun. Use plural instead.
Raw output
{"message": "[Microsoft.Plurals] Don't add '(s)' to a singular noun. Use plural instead.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 57, "column": 158}}}, "severity": "ERROR"}

<img
width="80%;"
title="Create an alert"
alt="A screenshot of creating an alert from the alert coverage gap page"
src="/images/accounts_screenshot-crop_add-an-alert.webp"
/>
* <DNT>**Error (%)**</DNT>: Alert when this signal deviates from its normal baseline, upper only, for at least 5 minutes by 3.00 standard deviation(s).

Check failure on line 59 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L59

[Microsoft.Plurals] Don't add '(s)' to a singular noun. Use plural instead.
Raw output
{"message": "[Microsoft.Plurals] Don't add '(s)' to a singular noun. Use plural instead.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 59, "column": 152}}}, "severity": "ERROR"}

<figcaption>
To create an alert for an unmonitored entity, go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT>, select <DNT>**Alert coverage gaps**</DNT> in the left navigation pane, and click <DNT>**Add alert**</DNT>.
</figcaption>
<img
title="Add an alert from the alert coverage gaps page"
alt="Add an alert from the alert coverage gaps page"
src="/images/alerts_screenshot-crop_coverage-gaps-add-an-alert.webp"
/>

<figcaption>
To create an alert for an unmonitored entity, go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT>, click <DNT>**Alert coverage gaps**</DNT> in the left navigation pane. Select an entity and click <DNT>**+ Recommend alert conditions**</DNT>.
</figcaption>

<Callout variant="tip">
Click the <Icon name="fe-edit-2"/> button to edit the alert condition and modify the query and thresholds.

Check notice on line 72 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L72

[new-relic.ComplexWords] Consider using 'change' instead of 'modify'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'change' instead of 'modify'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 72, "column": 81}}}, "severity": "INFO"}
</Callout>

4. Click <DNT>**Next**</DNT>.

5. Select a policy to get notified. Every alert condition needs to be routed through a [policy](/docs/alerts-applied-intelligence/new-relic-alerts/alert-policies/create-edit-or-find-alert-policy/) so you have to either select an existing policy or create a new one. Once you've selected or created a policy attached to the alert condition, then you might need to add a [destination](/docs/alerts-applied-intelligence/notifications/destinations). Destinations are where we send notifications about your New Relic data. You can link your notifications to third-party tools like Slack, Atlassian Jira, email, and more.

<img
width="80%;"
title="Create a policy for alert coverage gaps."
alt="A screenshot of the alert coverage gap policy selection"
src="/images/accounts_screenshot-crop_create-a-policy-alert-coverage-gaps.webp"
/>

<figcaption>
When you create an alert you will select which policy the alert will be grouped with.
</figcaption>
<img
title="Create a policy for alert coverage gaps."
alt="A screenshot of the alert coverage gap policy selection"
src="/images/alerts_screenshot-crop_coverage-gaps-add-an-alert-policy.webp"
/>

6. Click <DNT>**Activate conditions**</DNT> to save the conditions. If the policy is new, you'll see the <DNT>**Save & set up notifications**</DNT> button. Use this button if you want to save the conditions and the notifications.


## Adding recommended alerts [#adding-recommended-alerts]

New Relic will dynamically suggest the conditions we believe should be monitored based on the selected entity and your specific system. Some of the recommended alerts we might suggest are error percentage, apdex, or response time.

Check notice on line 90 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L90

[Microsoft.Passive] 'be monitored' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be monitored' looks like passive voice.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 90, "column": 69}}}, "severity": "INFO"}

Check notice on line 90 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L90

[Microsoft.Wordiness] Consider using 'some' instead of 'Some of the'.
Raw output
{"message": "[Microsoft.Wordiness] Consider using 'some' instead of 'Some of the'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 90, "column": 137}}}, "severity": "INFO"}

You'll get recommended alert conditions based on the entity type's defined as [Golden Metrics](https://github.com/newrelic/entity-definitions/blob/main/docs/entities/golden_metrics.md). If you don't get recommended alert conditions, once you select an alert condition you'd like to monitor, then your team will be alerted when this signal deviates from its normal baseline, upper and lower, for at least 5 minutes by 3.00 standard deviations.

Check notice on line 92 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L92

[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
Raw output
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 92, "column": 187}}}, "severity": "INFO"}

Check notice on line 92 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L92

[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 92, "column": 283}}}, "severity": "INFO"}

Check notice on line 92 in src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx#L92

[Microsoft.Passive] 'be alerted' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be alerted' looks like passive voice.", "location": {"path": "src/content/docs/alerts/alert-conditions/alert-coverage-gaps.mdx", "range": {"start": {"line": 92, "column": 312}}}, "severity": "INFO"}

To see which services need alert coverage, follow these steps:

1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert coverage gaps**</DNT> in the left navigation pane.

2. Click <DNT>**See what to instrument**</DNT>.

<img
width="60%;"
title="See what to instrument in the alert coverage gaps page"
alt="See what to instrument in the alert coverage gaps page"
src="/images/alerts_screenshot-crop_coverage-gaps-add-an-alert-see-what-instrument.webp"
/>

3. The coverage gaps page opens. You can group your coverage gaps by integration or by account.

<img
title="See what to instrument in the alert coverage gaps page"
alt="See what to instrument in the alert coverage gaps page"
src="/images/alerts_screenshot-crop_coverage-gaps-recommended.webp"
/>
Loading
Loading