Skip to content

Commit

Permalink
docs: notification silence filters
Browse files Browse the repository at this point in the history
  • Loading branch information
adityathebe committed Nov 18, 2024
1 parent b7641f1 commit 8eab9e8
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 20 additions & 3 deletions mission-control/docs/notifications/concepts/silences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
title: Silences
---

Silences prevent notifications from being sent.
Silences are attached to a particular resource (`catalog`, `health check`, or `component`) and are active for a specified duration.
A silence is a way to temporarily suppress notifications. Each silence has:

- A set duration - like an expiration timer
- A scope - it can be applied to either:
- Individual resources (a specific catalog, health check, or component)
- Multiple matching resources using filters

:::note
Notifications that aren't sent due to silence are still visible in the notification history for auditing purposes.
Expand All @@ -22,7 +26,20 @@ on each notification.

![Silence Notification form](./silence-notification-form.png)

### Filters

A silence can optionally contain a filter. A filter is a cel-expression that results in a boolean value.
If a filter returns a truthy value, the notification is silenced.

Check failure on line 32 in mission-control/docs/notifications/concepts/silences.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/notifications/concepts/silences.mdx#L32

[Flanksource.Spelling] Is 'truthy' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'truthy' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/notifications/concepts/silences.mdx", "range": {"start": {"line": 32, "column": 23}}}, "severity": "ERROR"}

Example: `check.type == 'http'` filter will only silence HTTP check related notifications

Check warning on line 34 in mission-control/docs/notifications/concepts/silences.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/notifications/concepts/silences.mdx#L34

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "mission-control/docs/notifications/concepts/silences.mdx", "range": {"start": {"line": 34, "column": 40}}}, "severity": "WARNING"}

#### Template variables

- [CheckEvents](/reference/notifications/template_vars/checks)
- [ConfigEvents](/reference/notifications/template_vars/config)
- [ComponentEvents](/reference/notifications/template_vars/components)

## Recursive mode

When a silence is recursively applied, it applies to all of its children.
So silencing a namespace would silence all deployments, statefulsets, pods, etc in that namespace.
So silencing a namespace would silence all deployments, statefulsets, pods, etc in that namespace.

Check failure on line 45 in mission-control/docs/notifications/concepts/silences.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/notifications/concepts/silences.mdx#L45

[Flanksource.Spelling] Is 'statefulsets' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'statefulsets' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/notifications/concepts/silences.mdx", "range": {"start": {"line": 45, "column": 57}}}, "severity": "ERROR"}

0 comments on commit 8eab9e8

Please sign in to comment.