Skip to content

Alerts/Monitors tags #4605

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 1, 2024
Merged

Alerts/Monitors tags #4605

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e13966
Alerts/Monitors tags
kimsauce Oct 1, 2024
a583e6c
more edits
kimsauce Oct 1, 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
63 changes: 22 additions & 41 deletions docs/alerts/monitors/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: settings
title: Monitor Settings and Activity
title: Monitor and Alert Settings
sidebar_label: Monitor Settings
description: Monitors continuously query your logs or metrics and send notifications when specific events occur, such as critical, warning, and missing data.
description: Monitors continuously query your logs or metrics and send alert notifications when specific events occur, such as critical, warning, and missing data.
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand All @@ -13,7 +13,6 @@ The **Monitors** page allows you to view, create, manage, and organize your moni

[**New UI**](/docs/get-started/sumo-logic-ui/). To access the Monitors page, in the main Sumo Logic menu select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.


The page displays the following information:
* **Name**. Name of the monitor.
* **Status**. A monitor is considered **Normal** when none of the trigger conditions are met and your data is actively being monitored.
Expand Down Expand Up @@ -89,54 +88,36 @@ Note that the same threshold translating functionality supports to [Creating Mon

## Tags

Tagging monitors and alerts can help you categorize, search, filter, and correlate data. These tags are key/value pairs that allow you to apply additional metadata to your monitors and alerts beyond their names and descriptions. Example tag: `team=alerting`, where key is `team` and value is `alerting`.

### Create a tag
Tags allow you to categorize, search, filter, and correlate your monitors and alerts more effectively. They are key/value pairs that add metadata beyond the basic name and description of your monitors and alerts. Example tag: `team=alerting`, where the key is `team` and the value is `alerting`.

To add a tag while creating a new monitor, see [Create a Monitor > Monitor details](/docs/alerts/monitors/create-monitor/#step-5-monitor-details).
### Creating tags

To add a tag to an existing monitor:
You can create and use tags at different stages:

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
1. Double-click on any monitor in your list.
1. In the side panel, click **Edit**.
1. Under the **Monitor details** step, create a tag using the `key=value` format.
1. Click **Save**.
#### Adding tags while creating a monitor

### Syntax
When setting up a new monitor, follow the steps in the [Monitor Details](/docs/alerts/monitors/create-monitor/#step-5-monitor-details) section to add tags in the `key=value` format.

- Tag keys cannot start with the prefixes `sumo.` or `_`
- Tag keys must only contain letters, numbers, and/or the symbols `_`, `.`, `/`, `+`, `-`, `@`
- Tag values can only contain letters, white spaces, numbers, and/or the symbols `_`, `.`, `/`, `=`, `+`, `-`, `@`
- You can associate a maximum of 50 tags per monitor

### Using tags

:::note
After you create a tag from a Monitor, it will appear on future alerts triggered by that monitor. Tags are not retroactively applied to past alerts.
:::
#### Adding tags to existing monitors

#### From the Monitors page
You can also add tags to monitors that are already created.

To view tags from your Monitors page:

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
1. You'll see a **Tags** column, and you can filter by tags at the top.<br/><img src={useBaseUrl('img/alerts/monitors-tags.png')} alt="Monitors page showing a column labeled 'Tags' next to alert details" style={{border: '1px solid gray'}} width="800" />


#### From the Alert List page

To view tags from your Alert List:

1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). Navigate to the **Alerts** section by clicking the notification bell icon at the top of your Sumo Logic dashboard.<br/> [**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Alert List**. You can also click the **Go To...** menu at the top of the screen and select **Alert List**.
1. You'll see a **Tags** column, and you can filter by tags at the top.<br/><img src={useBaseUrl('img/alerts/alerts-list-tags.png')} alt="Alerts list page showing a column labeled 'Tags' next to alert details" style={{border: '1px solid gray'}} width="800" />
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. [**New UI**](/docs/get-started/sumo-logic-ui). Go to **Alerts > Monitors** from the main menu, or use the **Go To...** menu at the top of the screen to navigate to **Monitors**.
1. Select a monitor from the list and double-click on it.
1. In the side panel, click **Edit**.
1. Under the **Monitor details** step, create a tag using the `key=value` format, following these syntax rules:
- Tag keys cannot start with the prefixes `sumo.` or `_`
- Tag keys can only contain letters, numbers, and/or the symbols `_`, `.`, `/`, `+`, `-`, `@`
- Tag values can only contain letters, white spaces, numbers, and/or the symbols `_`, `.`, `/`, `=`, `+`, `-`, `@`
- A maximum of 50 tags can be associated with each monitor.
1. Click **Save**.

#### From Alert Response pages
### Using tags in alerts

You can also see your tags on Alert Response pages:
After you’ve created tags for a monitor, these tags will be applied to future alerts generated by the monitor. You can view and use tags in different places:

1. Click on any alert from your **Alerts List** page (like those shown in the previous screenshot).
1. Go to the **Tags** section.<br/><img src={useBaseUrl('img/alerts/alert-response-tags.png')} alt="Alert Response page displaying graphs with tags shown in the tags section" style={{border: '1px solid gray'}} width="800" />
* **Alert List**. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). Navigate to the **Alerts** section by clicking the notification bell icon at the top of your Sumo Logic dashboard. [**New UI**](/docs/get-started/sumo-logic-ui). Select **Alerts > Alert List** or click the **Go To...** menu at the top of the screen and select **Alert List**. You'll see a **Tags** column, and you can filter by tags at the top.<br/><img src={useBaseUrl('img/alerts/alerts-list-tags.png')} alt="Alerts list page showing a column labeled 'Tags' next to alert details" style={{border: '1px solid gray'}} width="800" />
* **Alert Response**. Click on any alert in your **Alerts List** page to see more details, including tags in the **Tags** section.<br/><img src={useBaseUrl('img/alerts/alert-response-tags.png')} alt="Alert Response page displaying graphs with tags shown in the tags section" style={{border: '1px solid gray'}} width="800" />


## Monitor folder permissions
Expand Down