Skip to content
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.

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

Related Insights #1051

Merged
merged 20 commits into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified images/alert_viewer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/new-vs-original-related-alerts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/related_insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
203 changes: 117 additions & 86 deletions pages/doc/alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ VMware Tanzu Observability (formerly known as VMware Aria Operations for Applica
* The **alert notification** includes an image and a link to see the alert in context.
* Look all alerts in the **Alert Browser** or examine a single firing alert in the **Alert Viewer**.

{% include note.html content="All users can view alerts and perform the tasks on this page. You need [Alerts permissions](permissions_overview.html) to create and modify alerts. If some of the alerts in your environment are under [access control](access.html), you can view or view and modify those alerts only if they've been shared with you." %}
{% include note.html content="All users can view alerts and perform the tasks on this page. You need the [**Alerts** permission](permissions_overview.html) to create and modify alerts. If some of the alerts in your environment are under [access control](access.html), you can view or view and modify those alerts only if they've been shared with you." %}


## How Alerts Work
Expand Down Expand Up @@ -82,86 +82,6 @@ The default **Checking Frequency** interval is 5 minutes. You can adjust this pr
* If an alert condition uses larger moving time windows or aligns to a large interval, you can check less frequently. For example, an alert that compares a `mavg(6h, ...)` to `mavg(48h, ...)` can be safely checked once an hour or even less.
* If an alert is non-critical, you can check only as often as needed.

## Alert Viewer Tutorial

Alert Viewer is for investigating a **single alert**.

When you receive an alert notification, it includes a link to the alert in Alert Viewer. The related information in Alert Viewer can help you determine what's going on.

![annotated alert viewer allowing you to solve the problems listed below](images/alert_viewer.png)

### Step 1: Connect and Get the Big Picture
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">
Click the link in the alert notification and start with the 10-second briefing in the top left. <br /><br/>
Learn about:
<ul>
<li>Alert status and description </li>
<li>Alert settings </li>
<li>Alert targets</li>
<li>When the alert ended (if applicable)</li>
</ul>
</td>
<td width="50%"><img src="/images/alert_viewer_description.png" alt="Description of the alert"></td>
</tr>
</tbody>
</table>

### Step 2: Examine Related Firing Alerts
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">In the top right, examine Related Firing Alerts. <br /><br/>
When an alert fires, we scan all the other alerts that have fired within 30 minutes and correlates them with the initial event using AI/ML algorithms. You can filter by alert severity.</td>
<td width="50%"><img src="/images/alert_viewer_related.png" alt="Related Firing Alerts section supports filters, such as severe, warn, smoke and info."></td>
</tr>
</tbody>
</table>

### Step 3: Investigate Affected Point Tags and Sources
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">
Scroll down and examine the Affected section on the left.<br/><br/>
When an alert fires, we analyze the point tags that are most likely to be related to the firing alert and displays them in ranked order in the Alert Viewer. These point tags are a list of suspects for why the alert is firing. For example, if the alert is caused by an outage in region=us-west-2, this tag is ranked higher than other tags.</td>
<td width="50%"><img src="/images/alert_viewer_point_tags.png" alt="Affected point tags example"></td>
</tr>
</tbody>
</table>

### Step 4: Learn From Other Firings
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%"><strong>Other Firings</strong> shows past firings of the same alert with a link to the corresponding firing in the Alert Viewer. For multi-threshold alerts, you can see the severity. Click the links to see details.
</td>
<td width="50%"><img src="/images/alert_viewer_past_firings.png" alt="Other Firings list with links to the past firings"></td>
</tr>
</tbody>
</table>

### Step 5: Explore Alert Data
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">Scroll to the Data section.<br /><br /> You can have a first look at the alert query, filter what's displayed, and open the alert query.
</td>
<td width="50%"><img src="/images/alert_viewer_data.png" alt="Data section displaying the alert query and condition"></td>
</tr>
</tbody>
</table>

### Alert Viewer Video

In this video, Pierre gives a 2-minute tour of Alert Viewer. Note that this video was created in 2019 and some of the information in it might have changed. It also uses the 2019 version of the UI.

<p>
<iframe id="kmsembed-1_qdr0dtwr" width="608" height="402" src="https://vmwaretv.vmware.com/embed/secure/iframe/entryId/1_qdr0dtwr/uiConfId/49694343/pbc/252649793/st/0" class="kmsembed" allowfullscreen webkitallowfullscreen mozAllowFullScreen allow="autoplay *; fullscreen *; encrypted-media *" referrerPolicy="no-referrer-when-downgrade" frameborder="0" alt="intro to alert viewer"></iframe>
</p>

## Alerts Browser Tutorial

You can view and manage **all alerts** in the Alerts Browser.
Expand Down Expand Up @@ -213,13 +133,13 @@ You can expand each alert to view detailed information. For example, when you ex

Follow these steps for a tour:
1. Click the ellipsis icon to the left for a menu.
2. Click the chart icon under the **State** column for alert details. If the alert is firing, click to examine the alert in Alert Viewer.
3. View the alert condition and points.
4. View details below the severity:
1. Click the chart icon under the State column to examine the [Alert Viewer](#alert-viewer-tutorial) for the current or last firing of an alert.
1. View the alert condition and points.
1. View details below the severity:
- View the last affected series, including the affected sources and point tags.
- View the targets.
For multi-threshold alerts, you see this information for each severity.
4. Examine [alert tags](#step-5-organize-related-alerts-with-tags). You can add a tag to make filtering for the alert easier.
1. Examine [alert tags](#step-5-organize-related-alerts-with-tags). You can add a tag to make filtering for the alert easier.

<!---
### View Alert Details
Expand Down Expand Up @@ -317,6 +237,118 @@ When you create a maintenance window, you can use a wildcard to match tag path c

When you have many and complex tag paths, you can search them by parent. For example, if you have the tag paths `example.network.prod`, `example.network.dev`, `example.latency.prod`, and `example.latency.dev`, you can perform a search by **example** and the search returns all of its children.


## Alert Viewer Tutorial

The Alert Viewer is for investigating a **single alert firing**. You can open the Alert Viewer for a current or past firing.

The related information in the right pane of the Alert Viewer can help you determine what's going on. The related information depends on your [subscription type](subscriptions-differences.html):
* For VMware Cloud services subscriptions, the right pane shows the related insights, which are generated by the VMware Tanzu Observability Insights capability running in the VMware Tanzu Hub platform.
* For original subscriptions, the right pane shows the related firing alerts.

![annotated alert viewer allowing you to solve the problems listed below](images/alert_viewer.png)

### Step 1: Connect and Get the Big Picture
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">Open the Alert Viewer in one of the following ways:
<ul><li>In the <a href="#alerts-browser-tutorial">Alerts Browser</a>, in the State column of the alert, click the chart icon to open the current or most recent firing of that alert.</li>
<li>In the alert notification that you received, click the link to the Alert Viewer.</li>
</ul><br /><br/>
Examine the following:
<ul>
<li>Alert status and description </li>
<li>Alert settings </li>
<li>Alert targets</li>
<li>When the alert firing ended (if applicable)</li>
</ul>
</td>
<td width="50%"><img src="/images/alert_viewer_description.png" alt="Description of the alert"></td>
</tr>
</tbody>
</table>

### Step 2: Examine the Related Information

The related information in the right pane depends on your [subscription type](subscriptions-differences.html).

* For a VMware Cloud services subscription, in the top right, examine the Related Insights pane.

We scan the Tanzu Observability insights in the Tanzu Hub platform and show the insights that include this alert.

{% include note.html content="You must have at least the Tanzu Hub Viewer and the Insights Viewer service roles to see the related insights for an alert. For details, see [Service Roles](https://docs.vmware.com/en/VMware-Tanzu-Hub/SaaS/Using-and-Managing-VMware-Tanzu-Hub/GUID-E58C5DA5-BA2B-4BD8-9CA7-ADF7839C6E7F.html#service-roles-1) in the VMware Tanzu Hub documentation."%}

<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">
In the Related Insights pane, you can:
<ul><li>Filter the insights by severity.</li>
<li>View all Tanzu Observability alert firings aggregated in a related insight.</li>
<li>View a related insight in VMware Tanzu Hub and examine all alerts and events aggregated in that insight, including events from other sources. For details, see <a href="https://docs.vmware.com/en/VMware-Tanzu-Hub/SaaS/Using-and-Managing-VMware-Tanzu-Hub/GUID-B56F48EF-5C60-4D10-BFE6-026BE8C7B96C.html">Monitoring resources for service reliability using VMware Tanzu Observability Insights in Tanzu Hub</a> in the Tanzu Hub documentation.</li>
</ul>
<p><strong>Note</strong>: The Related Insights pane is also available on the <a href="alerts_manage.html#edit-alerts">Alert Edit</a> page.</p>
</td>
<td width="50%"><img src="/images/alert_viewer_insights.png" alt="Related Insights section supports filters, such as active, resolved, critical, warning, and information"></td>
</tr>
</tbody>
</table>

* For an original subscription, in the top right, examine the Related Firing Alerts pane.

<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">
When an alert fires, we scan all the other alerts that have fired within 30 minutes and correlate them with the initial event using AI/ML algorithms. You can filter by alert severity.</td>
<td width="50%"><img src="/images/alert_viewer_related.png" alt="Related Firing Alerts section supports filters, such as severe, warn, smoke and info."></td>
</tr>
</tbody>
</table>

### Step 3: Investigate Affected Point Tags and Sources
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">
Scroll down and examine the Affected section on the left.<br/><br/>
When an alert fires, we analyze the point tags that are most likely to be related to the firing alert and displays them in ranked order in the Alert Viewer. These point tags are a list of suspects for why the alert is firing. For example, if the alert is caused by an outage in region=us-west-2, this tag is ranked higher than other tags.</td>
<td width="50%"><img src="/images/alert_viewer_point_tags.png" alt="Affected point tags example"></td>
</tr>
</tbody>
</table>

### Step 4: Learn From Other Firings
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%"><strong>Other Firings</strong> shows past firings of the same alert with a link to the corresponding firing in the Alert Viewer. For multi-threshold alerts, you can see the severity. Click the links to see details.
</td>
<td width="50%"><img src="/images/alert_viewer_past_firings.png" alt="Other Firings list with links to the past firings"></td>
</tr>
</tbody>
</table>

### Step 5: Explore Alert Data
<table style="width: 100%;">
<tbody>
<tr>
<td width="50%">Scroll to the Data section.<br /><br /> You can have a first look at the alert query, filter what's displayed, and open the alert query.
</td>
<td width="50%"><img src="/images/alert_viewer_data.png" alt="Data section displaying the alert query and condition"></td>
</tr>
</tbody>
</table>

### Alert Viewer Video

In this video, Pierre gives a 2-minute tour of Alert Viewer. Note that this video was created in 2019 and some of the information in it might have changed. It also uses the 2019 version of the UI.

<p>
<iframe id="kmsembed-1_qdr0dtwr" width="608" height="402" src="https://vmwaretv.vmware.com/embed/secure/iframe/entryId/1_qdr0dtwr/uiConfId/49694343/pbc/252649793/st/0" class="kmsembed" allowfullscreen webkitallowfullscreen mozAllowFullScreen allow="autoplay *; fullscreen *; encrypted-media *" referrerPolicy="no-referrer-when-downgrade" frameborder="0" alt="intro to alert viewer"></iframe>
</p>

## Clone an Alert

To make copies of an existing alert, then change the copy, you can clone an alert.
Expand All @@ -337,7 +369,6 @@ We create [events](events.html) as alerts fire, update, and resolve. You can opt

{% include note.html content="If you don't have [access](access.html) to an alert, you also won't see the corresponding alert events." %}


## Do More!

* Watch videos [in the Alerting Videos playlist](https://vmwaretv.vmware.com/playlist/dedicated/252649793/1_r6vcinjj/) on VMware TV.
Expand Down
20 changes: 17 additions & 3 deletions pages/doc/alerts_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,12 +333,26 @@ Users with the **Alerts** permission can change an alert at any time. The option
<td width="60%" markdown="span">![screenshot ellipsis menu to the left of alert in alerts browser](images/edit_alert.png) </td></tr>
<tr>
<td width="40%">
<ol>
<li>Make changes (see next section). </li>
<ul>
<li>Click <strong>Show Firings</strong> at any time to see when the alert fired and fine-tune the behavior based on that information.</li>
</ol>
</ul>
</td>
<td width="60%" markdown="span">![screenshot ellipsis menu to the left of alert in alerts browser](images/show_firings.png) </td></tr>
<tr>
<td width="40%">
<ul>
<li>If your Tanzu Observability service is <a href="subscriptions-differences.html">onboarded</a> to VMware Cloud services, you can also examine the Related Insights pane on the right.
<p>For details, see <a href="alerts.html#step-2-examine-the-related-information">Examine the Related Information</a>.</p></li>
</ul>
</td>
<td width="60%" markdown="span">![screenshot of the Related Insights pane to the left of the Alert Editor](images/related_insights.png) </td></tr>
<tr>
<td width="40%">
<ul>
<li>Make changes (see next section).</li>
</ul>
</td>
<td width="60%" markdown="span"></td></tr>
</tbody>
</table>

Expand Down
14 changes: 14 additions & 0 deletions pages/doc/csp_area_differences.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,5 +481,19 @@ For details, see <a href="metrics_security.html">Metrics Security Policy Rules</
For details, see <a href="csp_metrics_security.html">Metrics Security Policy Rules</a>.</p>
</td>
</tr>
<tr>
<td>Related Information in Alert Viewer and Alert Editor
</td>
<td><strong>Who</strong>: All users.
<p><strong>Where</strong>: In the Tanzu Observability user interface.</p>
<p><strong>How</strong>: The Alert Viewer shows the Related Firing Alerts pane with correlated alerts that have fired within 30 minutes. For details, see <a href="alerts.html#step-2-examine-the-related-information">Examine the Related Information</a>.</p>
<p>The Alert Editor doesn't show related information.</p>
</td>
<td><strong>Who</strong>: All users.
<p><strong>Where</strong>: In the Tanzu Observability user interface.</p>
<p><strong>How</strong>: The Alert Viewer shows the Related Insights pane with the insights that contain this alert. For details, see <a href="alerts.html#step-2-examine-the-related-information">Examine the Related Information</a>.</p>
<p>The Alert Editor also includes the Related Insights pane.</p>
</td>
</tr>
</tbody>
</table>
4 changes: 3 additions & 1 deletion pages/doc/csp_subscription_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,7 @@ VMware Cloud services provides single sign-on (SSO) and identity access manageme
* Interacting with the REST API requires a VMware Cloud services access token, which can be exchanged from a user's API token or server to server app credentials.
* **Improved Multi-Tenancy**: Support of switching between tenants on different clusters. This unlocks better experience in multi-tenant environments.
* **Centralized Billing and Subscriptions**: The VMware Cloud Services Console displays billing and subscriptions details, and allows payment methods management. This brings the billing and subscriptions experience at a completely new level as we had no such ability before.
* **Alerts with Related Insights**: The VMware Tanzu Observability Insights capability, which runs in the VMware Tanzu Hub platform, correlates the Tanzu Observability alerts with events from multiple sources and aggregates them into insights. The Alert Viewer and Alert Editor in the Tanzu Observability user interface:


* Show the insights that are related to the corresponding alert.
* Include a link for each related insight to view it in the VMware Tanzu Hub platform and inspect the complete list of alerts and events aggregated into that insight.
9 changes: 9 additions & 0 deletions pages/doc/csp_ui_differences.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,12 @@ The options for adding default groups for new user and service accounts as well
The option for creating a metrics security policy rule based on roles is removed, because VMware Cloud services subscribers can block or allow access to certain metrics only based on accounts (user accounts and service accounts) and groups.

![An image showing that the Roles option is removed from the UI for new subscribers.](images/new-vs-original-metricspolicy.png)

## Alert Viewer and Alert Editor

The Related Firing Alerts pane in the top right of the Alert Viewer is replaced with the Related Insights pane. VMware Cloud services subscribers have a bidirectional link between the Tanzu Observability UI and the Tanzu Observability Insights UI in the Tanzu Hub platform.

![An image showing that the Roles option is removed from the UI for new subscribers.](images/new-vs-original-related-alerts.png)

The Related Insights pane is also available in the Alert Editor for VMware Cloud services subscribers.

2 changes: 1 addition & 1 deletion pages/doc/hello_wavefront_aws_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ You can now edit the alert directly, but we recommend that you clone the alert s
<td width="50%" markdown="span">![Screenshot of the recipients section of the alert where we've entered the email address](images/aws_specify_recipient.png) </td></tr>
<tr>
<td width="50%" >
When the threshold is exceeded, you'll receive an email that includes a link to the alert in the Alert Viewer. <br/><br/>The annotated screenshot on the right can help you get started with the Alert Viewer. <br/><br/>This <a href="https://vmwaretv.vmware.com/embed/secure/iframe/entryId/1_qdr0dtwr/uiConfId/49694343/pbc/252649793/st/0#">short video</a> shows what you can do. Note that this video was created in 2019 and some of the information in it might have changed. It also uses the 2019 version of the UI.
When the threshold is exceeded, you'll receive an email that includes a link to the alert in the <a href="alerts.html#alert-viewer-tutorial">Alert Viewer</a>. <br/><br/>The annotated screenshot on the right can help you get started with the Alert Viewer. <br/><br/>This <a href="https://vmwaretv.vmware.com/embed/secure/iframe/entryId/1_qdr0dtwr/uiConfId/49694343/pbc/252649793/st/0#">short video</a> shows what you can do. Note that this video was created in 2019 and some of the information in it might have changed. It also uses the 2019 version of the UI.
</td>
<td width="50%" markdown="span">![Annotated screenshot of the alert viewer](images/alert_viewer.png) </td></tr>
</tbody>
Expand Down
Loading
Loading