diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml index 51459fa..988cb4d 100644 --- a/.github/workflows/style.yml +++ b/.github/workflows/style.yml @@ -9,9 +9,13 @@ jobs: steps: - uses: actions/checkout@v3 - - name: Get changed files + - name: Get all changed md/mdx files id: changed-files uses: tj-actions/changed-files@v45 + with: + files: | + **/*.md + **/*.mdx - name: List changed fiels run: | diff --git a/mission-control/docs/notifications/concepts/silence-notification-form.png b/mission-control/docs/notifications/concepts/silence-notification-form.png index 6d15c9f..26d58ab 100644 Binary files a/mission-control/docs/notifications/concepts/silence-notification-form.png and b/mission-control/docs/notifications/concepts/silence-notification-form.png differ diff --git a/mission-control/docs/notifications/concepts/silences.mdx b/mission-control/docs/notifications/concepts/silences.mdx index 39452c0..37983d3 100644 --- a/mission-control/docs/notifications/concepts/silences.mdx +++ b/mission-control/docs/notifications/concepts/silences.mdx @@ -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. @@ -11,7 +15,7 @@ Notifications that aren't sent due to silence are still visible in the notificat ## Use cases -- Planned maintenance or deployments. Eg: You can silence a namespace or a helm release and automatically silence notifications from all of their children. +- Planned maintenance or deployments. Eg: You can silence a namespace or a helm release and automatically silence notifications from all their children. - Non-critical resources: Notifications from resources that routinely trigger alerts but are expected and harmless can be silenced. - Known issues: If there's a known issue that can't be immediately resolved (e.g., due to dependencies or resource constraints), you might silence related alerts until a fix can be implemented. @@ -22,7 +26,29 @@ on each notification. ![Silence Notification form](./silence-notification-form.png) -## Recursive mode +### Filters + +A silence can optionally contain a filter. A filter is a cel-expression that results in a boolean value. +If a filter return true, the notification is silenced. + +#### Examples + +| Filter | description | +|--------|-------------| +| `check.type == 'http'` | silences only HTTP check related notifications. | +| `regexp.Match("^check-[0-9]+", check.name)` | matches any check with the prefix `check-` | +| `config.name == "postgresql" && config.type == "Kubernetes::StatefulSet"` | silences notifications from a stateful set named "postgresql" | +| `config.type == "Kubernetes::Pod" && catalog.traverse(config.id, "Kubernetes::Namespace", "incoming").size > 0 && catalog.traverse(config.id, "Kubernetes::Namespace", "incoming")[0].tags.?env.orValue("") == "prod"` | matches kubernetes pod in a prod namespace | + +#### 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 its all children. +So silencing a namespace would silence all deployments, statefulsets, pods, etc in that namespace. + -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. \ No newline at end of file diff --git a/styles/ignore/words-with-suggestions.txt b/styles/ignore/words-with-suggestions.txt index 3241b47..d5c2d34 100644 --- a/styles/ignore/words-with-suggestions.txt +++ b/styles/ignore/words-with-suggestions.txt @@ -316,6 +316,7 @@ src ssl_exporter starttls statefulset +statefulsets Statefulset staticResources storageclass