Skip to content

Commit

Permalink
Merge pull request #15950 from DataDog/esther/docs-4395/service-check…
Browse files Browse the repository at this point in the history
…-update

Update Service check monitor
  • Loading branch information
estherk15 authored Nov 21, 2022
2 parents 4015768 + d4931bf commit a323395
Showing 1 changed file with 23 additions and 25 deletions.
48 changes: 23 additions & 25 deletions content/en/monitors/create/types/custom_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ further_reading:

## Overview

Service check monitors include any service check not reported by one of the [more than {{< translate key="integration_count" >}} integrations][1] included with the Agent. Service checks can be sent to Datadog using a [custom Agent check][2], [DogStatsD][3], or the [API][4].
Service check monitors include any service check not reported by one of the [more than {{< translate key="integration_count" >}} integrations][1] included with the Agent. Service checks can be sent to Datadog using a [custom Agent check][2], [DogStatsD][3], or the [API][4]. For more information, see the [Service Check Overview][5].

## Monitor creation

To create a [service check monitor][5] in Datadog, use the main navigation: *Monitors --> New Monitor --> Service Check*.
To create a [service check monitor][6] in Datadog, use the main navigation: **Monitors** --> **New Monitor** --> **Service Check**.

### Pick a service check

Expand All @@ -47,20 +47,16 @@ A check alert tracks consecutive statuses submitted per check grouping and compa
Set up the check alert:

1. Trigger a separate alert for each `<GROUP>` reporting your check.

Check grouping is specified either from a list of known groupings or by you. For service check monitors, the per-check grouping is unknown, so you must specify it.
* Check grouping is specified either from a list of known groupings or by you. For service check monitors, the per-check grouping is unknown, so you must specify it.

2. Trigger the alert after selected consecutive failures: `<NUMBER>`
* Choose how many consecutive runs with the `CRITICAL` status trigger a notification. For example, to be notified immediately when your check fails, trigger the monitor alert on `1` critical status.

Each check run submits a single status of `OK`, `WARN`, `CRITICAL`, or `UNKNOWN`. Choose how many consecutive runs with the `WARN` and `CRITICAL` status trigger a notification. For example, to be notified immediately when your check fails, trigger the monitor alert on `1` critical status or `1` warning status.

3. Choose `Do not notify` or `Notify` for Unknown status.

If enabled, a state transition to `UNKNOWN` triggers a notification. In the [monitor status page][1], the status bar of a group in `UNKNOWN` state uses `NODATA` grey. The overall status of the monitor stays in `OK`.
3. Select `Do not notify` or `Notify` for Unknown status.
* If `Notify` is selected, a state transition to `UNKNOWN` triggers a notification. In the [monitor status page][1], the status bar of a group in `UNKNOWN` state uses `NODATA` grey. The overall status of the monitor stays in `OK`.

4. Resolve the alert after selected consecutive successes: `<NUMBER>`.

Choose how many consecutive runs with the `OK` status resolve the alert. For example, to ensure an issue is fixed, resolve the monitor on `4` OK statuses.
* Choose how many consecutive runs with the `OK` status resolve the alert. For example, to ensure an issue is fixed, resolve the monitor on `4` `OK` statuses.


[1]: /monitors/manage/status
Expand All @@ -69,27 +65,28 @@ Set up the check alert:

A cluster alert calculates the percent of checks in a given status and compares it to your thresholds.

Set up a cluster alert:

1. Decide whether or not to group your checks according to a tag. `Ungrouped` calculates the status percentage across all sources. `Grouped` calculates the status percentage on a per-group basis.

2. Select the percentage for alert and warn thresholds. Only one setting (alert or warn) is required.

Each check tagged with a distinct combination of tags is considered to be a distinct check in the cluster. Only the status of the last check of each combination of tags is taken into account in the cluster percentage calculation.

{{< img src="monitors/monitor_types/process_check/cluster_check_thresholds.png" alt="Cluster Check Thresholds" style="width:90%;">}}

For example, a cluster check monitor grouped by environment can alert if more that 70% of the checks on any of the environments submit a `CRITICAL` status, and warn if more that 70% of the checks on any of the environments submit a `WARN` status.

To set up a cluster alert:

1. Decide whether or not to group your checks according to a tag. `Ungrouped` calculates the status percentage across all sources. `Grouped` calculates the status percentage on a per-group basis.

2. Select the percentage for alert and warn thresholds. Only one setting (alert or warn) is required.

{{% /tab %}}
{{< /tabs >}}

#### Advanced alert conditions

See the [Monitor configuration][6] documentation for information on [No data][7], [Auto resolve][8], and [New group delay][9] options.
See the [Monitor configuration][7] documentation for information on [No data][8], [Auto resolve][9], and [New group delay][10] options.

### Notifications

For detailed instructions on the **Say what's happening** and **Notify your team** sections, see the [Notifications][10] page.
For detailed instructions on the **Say what's happening** and **Notify your team** sections, see the [Notifications][11] page.

## Further Reading

Expand All @@ -99,9 +96,10 @@ For detailed instructions on the **Say what's happening** and **Notify your team
[2]: /developers/custom_checks/write_agent_check/
[3]: /developers/dogstatsd/
[4]: /api/v1/service-checks/
[5]: https://app.datadoghq.com/monitors#create/custom
[6]: /monitors/create/configuration/#advanced-alert-conditions
[7]: /monitors/create/configuration/#no-data
[8]: /monitors/create/configuration/#auto-resolve
[9]: /monitors/create/configuration/#new-group-delay
[10]: /monitors/notify/
[5]: /developers/service_checks/#overview
[6]: https://app.datadoghq.com/monitors/create/custom
[7]: /monitors/create/configuration/#advanced-alert-conditions
[8]: /monitors/create/configuration/#no-data
[9]: /monitors/create/configuration/#auto-resolve
[10]: /monitors/create/configuration/#new-group-delay
[11]: /monitors/notify/

0 comments on commit a323395

Please sign in to comment.