Skip to content

Commit

Permalink
fix(Alerts): Removed the Create an alert section
Browse files Browse the repository at this point in the history
  • Loading branch information
nbaenam committed Oct 22, 2024
1 parent fd6e4a0 commit c2a1389
Show file tree
Hide file tree
Showing 12 changed files with 269 additions and 72 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ metaDescription: Learn how alert coverage gaps in New Relic help you identify ga
redirects:
- /docs/alerts-applied-intelligence/new-relic-alerts/get-started/condition-recommendations
- /docs/alerts-applied-intelligence/applied-intelligence/alert-coverage-gaps
- /docs/alerts/create-alert/alert-coverage-gaps
freshnessValidatedDate: 2024-10-28
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ redirects:
- /docs/alerts/create-alert/create-alert-condition/create-alert-conditions
- /docs/alerts/create-alert/create-alert-condition/update-or-disable-policies-conditions
- /docs/alerts/new-relic-alerts-beta/configuring-alert-policies/define-alert-conditions
- /docs/alerts/create-alert/create-alert-condition/alert-conditions
freshnessValidatedDate: 2024-10-28
---

Expand Down
71 changes: 56 additions & 15 deletions src/content/docs/alerts/alert-conditions/customize-incidents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,53 @@ Here are some key things to note before you use our title template:
* **Lost signal incidents**: For incidents triggered by a lost signal, the default title will always be used. To learn more about signal loss, see [Loss of signal and gap filling](/docs/alerts/alert-conditions/nrql-tips/#signal-loss).

Check notice on line 33 in src/content/docs/alerts/alert-conditions/customize-incidents.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/customize-incidents.mdx#L33

[Microsoft.Passive] 'be used' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'be used' looks like passive voice.", "location": {"path": "src/content/docs/alerts/alert-conditions/customize-incidents.mdx", "range": {"start": {"line": 33, "column": 102}}}, "severity": "INFO"}


<img
title="Add a title template"
alt="Add a title template"
src="/images/alerts_screenshot-crop_conditions-title-template.webp"
/>

<figcaption>
Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert Conditions**</DNT> in the left navigation. Click <DNT>**+ New alert condition**</DNT> and select an option or edit an alert condition. You can find the <DNT>**Title template**</DNT> field in the <DNT>**Add details**</DNT> step.
</figcaption>


### Understand the title template [#title-example]

Let's say you run an e-commerce site and you have created an alert condition to trigger an incident when networks errors are high. You can use a title template to make incidents from this condition easily identifiable.

Check notice on line 49 in src/content/docs/alerts/alert-conditions/customize-incidents.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/customize-incidents.mdx#L49

[new-relic.Adverbs] Consider removing 'easily'.
Raw output
{"message": "[new-relic.Adverbs] Consider removing 'easily'.", "location": {"path": "src/content/docs/alerts/alert-conditions/customize-incidents.mdx", "range": {"start": {"line": 49, "column": 199}}}, "severity": "INFO"}

You have named this alert condition `High Network Errors`. But you want the incident title to reflect more information about the entity and priority. See this example:

```handlebars
{{conditionName}} Affecting {{entity.name}} - {{entity.type}} - {{priority}}
```

This template would generate the following incident title:

```
High Network Errors Affecting Entity123 - Kubernetes Pod - Critical
```

### Use attributes to further define your condition [#attributes]

You can include a subset of incident event attributes in your title templates to add more context.

Here's how:

* **Use the format `{{AN_ATTRIBUTE}}`**. For example:

```handlebars
{{conditionName}} has triggered an incident
```
* **Tag attributes**: For tags, use the format `{{tags.TAG_NAME}}`.
* **Facet clause tags**: If a NRQL condition uses a `FACET` clause, you can use `tags` formatting to use those values in your title template. For example, if the NRQL query included `FACET hostName, cluster`, you could then use this:

```handlebars
Host {{tags.hostName}}, cluster {{tags.cluster}} incident
```

Tag names cannot contain spaces, but the expanded values can. For a full list of available attributes, see [Incident event attributes](/docs/alerts/incident-management/incident-event-attributes).

Check failure on line 81 in src/content/docs/alerts/alert-conditions/customize-incidents.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/customize-incidents.mdx#L81

[Microsoft.Contractions] Use 'can't' instead of 'cannot'.
Raw output
{"message": "[Microsoft.Contractions] Use 'can't' instead of 'cannot'.", "location": {"path": "src/content/docs/alerts/alert-conditions/customize-incidents.mdx", "range": {"start": {"line": 81, "column": 11}}}, "severity": "ERROR"}


## Description template for alert conditions [#description-template]

Expand All @@ -59,24 +106,18 @@ The hostname is : ip-123-45-67-89.us-west-1.compute.internal

## Add a description template [#create-description]

To add a description template in an alert condition, you need to [create an alert condition](/docs/alerts/alert-conditions/create-alert-conditions). When you'


To add a description template in an alert condition, you need to [create an alert condition](/docs/alerts/alert-conditions/create-alert-conditions) or edit an alert condition. You can find the <DNT>**Description template**</DNT> field in the <DNT>**Add details**</DNT> step.

<img
title="description template"
alt="A screenshot displaying a sample description template"
src="/images/alerts_screenshot-full_custom-incident-description-alerts.webp"
title="Add a description template"
alt="Add a description template"
src="/images/alerts_screenshot-crop_conditions-description-template.webp"
/>

<figcaption>
<DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts & AI > Alert conditions (Policies) > (select a policy) > (select a condition)**</DNT>: Click <DNT>**+ Add description template**</DNT> to open the field.
Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert Conditions**</DNT> in the left navigation. Click <DNT>**+ New alert condition**</DNT> and select an option or edit an alert condition. You can find the <DNT>**Description template**</DNT> field in the <DNT>**Add details**</DNT> step.
</figcaption>

You can create a description template using [the dedicated field for NRQL alerts](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/), or the [Describe this condition section for infrastructure alerts](/docs/infrastructure/new-relic-infrastructure/infrastructure-alert-conditions/infrastructure-alerts-add-edit-or-view-host-alert-information/).

## Description template template example [#example]

Here's a description template template example:

```handlebars
Expand All @@ -102,20 +143,20 @@ EC2 Root Device Type: {{tags.aws.ec2RootDeviceType}}

The attributes you can use in a description template are a subset of attributes attached to the [incident event](/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/understand-technical-concepts/incident-event-attributes). Here are some details about the available attributes and how to use them:

* Incident event attributes: For any of the [standard attributes available for use in a description template](/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/understand-technical-concepts/incident-event-attributes), use the format `{{AN_ATTRIBUTE}}`. For example:
* Incident event attributes: For any of the standard attributes available for use in a description template, use the format `{{AN_ATTRIBUTE}}`. For example:

```handlebars
The target name is : {{targetName}}
```
* Tag attributes: For tags, you would use the format `{{tags.TAG_NAME}}`. There are two types of tags:

* Entity-related tags: <DNT>**For infrastructure conditions only.**</DNT> You can find available [entity-related tags](/docs/new-relic-one/use-new-relic-one/core-concepts/tagging-use-tags-organize-group-what-you-monitor#) by going to the [entity explorer](/docs/new-relic-one/use-new-relic-one/ui-data/new-relic-one-entity-explorer-view-performance-across-apps-services-hosts) and looking under a service's <DNT>**Metadata and tags**</DNT>, or by viewing incident details. Here's an example of using tags in a description template:
* Entity-related tags: For infrastructure conditions only. You can find available [entity-related tags](/docs/new-relic-one/use-new-relic-one/core-concepts/tagging-use-tags-organize-group-what-you-monitor#) by going to the [entity explorer](/docs/new-relic-one/use-new-relic-one/ui-data/new-relic-one-entity-explorer-view-performance-across-apps-services-hosts) and looking under a service's <DNT>**Metadata and tags**</DNT>, or by viewing incident details. Here's an example of using tags in a description template:

```handlebars
The AWS region is : {{tags.aws.awsRegion}}
Responsible team : {{tags.label.owning_team}}
```
* Facet clause tags: <DNT>**For NRQL conditions only.**</DNT> If a NRQL condition uses a `FACET` clause, you can use `tags` formatting to use those values in your description template. For example, if the NRQL query included `FACET hostName, cluster`, you could then use this:
* Facet clause tags: For NRQL conditions only. If a NRQL condition uses a `FACET` clause, you can use `tags` formatting to use those values in your description template. For example, if the NRQL query included `FACET hostName, cluster`, you could then use this:

```handlebars
The host is : {{tags.hostName}}
Expand Down Expand Up @@ -158,7 +199,7 @@ mutation {

* For more information on NRQL conditions and using the NerdGraph API, go to [NerdGraph API: NRQL condition alerts](/docs/alerts/alerts-nerdgraph/nerdgraph-examples/nerdgraph-api-alerts-nrql-conditions).
* For infrastructure monitoring conditions, you can create the description template when [creating an Infrastructure monitoring alert condition](/docs/infrastructure/new-relic-infrastructure/infrastructure-alert-conditions/infrastructure-alerts-add-edit-or-view-host-alert-information).
* To learn about how to structure a description template, see the [example template](#example) and the [attribute/tag instructions](#attributes-tags).


## Mentioning users or notifying channel in Slack [#mention-in-slack]

Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/alerts/alert-conditions/nrql-tips.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ If, in the aggregation window, there's at least one instance of `MyCoolEvent` an

### Example: Null vs. zero value returned [#example-null-zero]

To find how we handle `NULL` values, adjust the loss of signal and gap filling settings in the [Alert conditions UI](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/#signal-loss).
To find how we handle `NULL` values, adjust the [loss of signal](/docs/alerts/alert-conditions/create-alert-conditions/#lost-signal) and [gap filling](/docs/alerts/alert-conditions/create-alert-conditions/#gap-filling-strategy) settings in the alert conditions.

You can avoid `NULL` values entirely with a query order of operations shortcut. To do this, use a `filter` sub-clause, then include all filter elements within that sub-clause. The main body of the query should include a `WHERE` clause that defines at least one entity so, for any aggregation window where the system performs a check, the signal will have an association with that entity. The `SELECT` clause will then run and apply the filter elements to the data returned by the main body of the query. It will return a value of `0` if the filter elements result in no matching data.

Check notice on line 437 in src/content/docs/alerts/alert-conditions/nrql-tips.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/nrql-tips.mdx#L437

[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/nrql-tips.mdx", "range": {"start": {"line": 437, "column": 177}}}, "severity": "INFO"}

Expand Down Expand Up @@ -563,7 +563,7 @@ Here are some tips for creating and using a NRQL condition:
<td>
NRQL conditions evaluate data based on how it's aggregated, using aggregation windows from 30 seconds to 120 minutes, in increments of 15 seconds. For best results, we recommend using the event flow or event timer aggregation methods.

For the cadence aggregation method, the implicit `SINCE ... UNTIL` clause specifying which minute to evaluate is controlled by your [delay/timer](#delay-timer) setting. Since very recent data may be incomplete, you may want to query data from 3 minutes ago or longer, especially for:
For the cadence aggregation method, the implicit `SINCE ... UNTIL` clause specifying which minute to evaluate is controlled by your [delay and timer](#delay-timer) setting. Since very recent data may be incomplete, you may want to query data from 3 minutes ago or longer, especially for:

* Applications that run on multiple hosts.
* `SyntheticCheck` data: Timeouts can take 3 minutes, so 5 minutes or more is recommended.
Expand Down Expand Up @@ -834,9 +834,9 @@ Once enabled, set the "slide by interval" to control how much overlap time your

Choose between [three streaming aggregation methods](/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/understand-technical-concepts/streaming-alerts-key-terms-concepts/#aggregation-methods) to get the best evaluation results for your conditions.

### Delay/timer [#delay-timer]
### Delay and timer [#delay-timer]

You can adjust the [delay/timer](/docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/understand-technical-concepts/streaming-alerts-key-terms-concepts/#delay-timer) to coordinate [our streaming alerting algorithm](/docs/new-relic-solutions/get-started/glossary/#streaming-algorithm) with your data's behavior. If your data is sparse or inconsistent, you may want to use the event timer aggregation method.
You can adjust the [delay and timer](/docs/alerts/alert-conditions/streaming-alerts-key-terms-concepts/#delay-timer) to coordinate [our streaming alerting algorithm](/docs/new-relic-solutions/get-started/glossary/#streaming-algorithm) with your data's behavior. If your data is sparse or inconsistent, you may want to use the event timer aggregation method.

For the cadence method, the total supported latency is the sum of the aggregation window duration and the delay.

Expand Down
41 changes: 41 additions & 0 deletions src/content/docs/alerts/alert-conditions/provide-runbook.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Provide runbook instructions for alert activity
tags:
- Alerts
- Alert conditions
metaDescription: Read about how to add a runbook URL to your alerts policy condtion.
redirects:
- /docs/alerts/new-relic-alerts-beta/reviewing-alert-incidents/providing-runbook-instructions-alerts
- /docs/alerts/new-relic-alerts-beta/reviewing-alert-incidents/provide-runbook-instructions-alerts
- /docs/alerts/new-relic-alerts-beta/reviewing-alert-incidents/provide-runbook-instructions-alert-activity
- /docs/alerts/new-relic-alerts/reviewing-alert-incidents/provide-runbook-instructions-alert-activity
- /docs/alerts/new-relic-alerts/defining-conditions/provide-runbook-instructions-alert-activity
- /docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/provide-runbook-instructions-alert-activity
- /docs/alerts-applied-intelligence/new-relic-alerts/advanced-alerts/understand-technical-concepts/provide-runbook-instructions-alert-activity
- /docs/alerts/create-alert/condition-details/provide-runbook-instructions-alert-activity
freshnessValidatedDate: 2024-10-28
---

Alert [conditions](/docs/alerts/alert-conditions/create-alert-conditions) include the option to identify the URL for your [runbook](/docs/using-new-relic/welcome-new-relic/get-started/glossary#alert-runbook) instructions. This allows you to link to information or standard procedures for handling an incident opened when a situation breaches the condition's [critical threshold](/docs/alerts/new-relic-alerts-beta/configuring-alert-policies/define-thresholds-trigger-alert).

<img
title="Add a runbook"
alt="Add a runbook"
src="/images/alerts_screenshot-crop_conditions-runbook.webp"
/>

<figcaption>
Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert Conditions**</DNT> in the left navigation. Click <DNT>**+ New alert condition**</DNT> and select an option or edit an alert condition. You can find the <DNT>**Runbook URL**</DNT> field in the <DNT>**Add details**</DNT> step. You can add a runbook URL so that personnel handling the incident that triggered the alert will know what to do.
</figcaption>


To edit the runbook URL associated with a condition:

1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Alerts**</DNT> and select <DNT>**Alert Conditions**</DNT> in the left navigation.
2. Click <DNT>**+ New alert condition**</DNT> and select an option or edit an alert condition.
3. Follow the steps until the <DNT>**Add details**</DNT> step.
4. In the <DNT>**Runbook URL**</DNT> field, provide the full path for your runbook URL (runbook URL, URL to internal wiki page, etc.).Provide the full path for your runbook URL (runbook URL, URL to internal wiki page, etc.).

Check notice on line 37 in src/content/docs/alerts/alert-conditions/provide-runbook.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/provide-runbook.mdx#L37

[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/provide-runbook.mdx", "range": {"start": {"line": 37, "column": 38}}}, "severity": "INFO"}

Check notice on line 37 in src/content/docs/alerts/alert-conditions/provide-runbook.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/provide-runbook.mdx#L37

[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.", "location": {"path": "src/content/docs/alerts/alert-conditions/provide-runbook.mdx", "range": {"start": {"line": 37, "column": 45}}}, "severity": "INFO"}

Check notice on line 37 in src/content/docs/alerts/alert-conditions/provide-runbook.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/alerts/alert-conditions/provide-runbook.mdx#L37

[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'Provide'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'Provide'.", "location": {"path": "src/content/docs/alerts/alert-conditions/provide-runbook.mdx", "range": {"start": {"line": 37, "column": 135}}}, "severity": "INFO"}
5. Toggle <DNT>**Enable on save**</DNT> and click <DNT>**Save condition**</DNT>.


We'll include your runbook URL in <DNT>**Incident**</DNT> details and in email notifications so that personnel will know exactly what to do.
Loading

0 comments on commit c2a1389

Please sign in to comment.