Skip to content

Commit

Permalink
Merge branch 'Azure:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Brunoga-MS authored Mar 8, 2024
2 parents b6cc7ec + ec8a091 commit bd2523a
Show file tree
Hide file tree
Showing 14 changed files with 1,513 additions and 16 deletions.
14 changes: 7 additions & 7 deletions docs/content/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ The example folder structure below highlights all of the key assets that define
└── Deploy-VM-DataDiskReadLatency-Alert.json
```

**patterns:** *This folder contains assets for pattern/scenario specific guidance that leverages the baseline alerts in this repo. This contribute does not cover contributions to the patterns/services section. There will be specific guides within each pattern/service section.*
**patterns:** *This folder contains assets for pattern/scenario specific guidance that leverages the baseline alerts in this repo. This guide does not cover contributions to the patterns/scenarios section. There will be specific guides within each pattern/scenarios section.*

**services:** *This folder contains the baseline alert definitions, guidance, and example deployment scripts. It is grouped by resource category (e.g. Compute), and then by resource type (e.g. virtualMachines).*
**services:** *This folder contains the baseline alert definitions, guidance, and example deployment scripts. It is grouped by resource provider (e.g. Compute), and then by resource type (e.g. virtualMachines).*

{{< hint type=note >}}
You may need to add new resource category and/or resource type folders as you define new baseline alerts. These folders are case-sensitive and follow the naming conventions defined by the [Azure Resource Reference](https://learn.microsoft.com/azure/templates/) documentation. For example: Alert guidance for Microsoft.Compute/virtualMachines would go under 'services/Compute/virtualMachines'
You may need to add new resource provider and/or resource type folders as you define new baseline alerts. These folders are case-sensitive and follow the naming conventions defined by the [Azure Resource Reference](https://learn.microsoft.com/azure/templates/) documentation. For example: Alert guidance for Microsoft.Compute/virtualMachines would go under 'services/Compute/virtualMachines'
{{< /hint >}}

**_index.md:** *These files control the menu structure and the content layout for GitHub Pages site. There are only two versions of these files, one for the resource categories, which just controls the friendly name in the menu and title. The other version is at the resource type level and it controls the layout of the GitHub Pages site. As you create new folders, just copy the respective versions and change the title in the metadata section at the top of the file.*
**_index.md:** *These files control the menu structure and the content layout for GitHub Pages site. There are only two versions of these files, one for the resource providers, which just controls the friendly name in the menu and title. The other version is at the resource type level and it controls the layout of the GitHub Pages site. As you create new folders, just copy the respective versions and change the title in the metadata section at the top of the file.*

**alerts.yaml:** *This YAML-based file contains the detailed definition and guidance for the baseline alerts within each resource category/type folder. Below is the general structure of the file.*
**alerts.yaml:** *This YAML-based file contains the detailed definition and guidance for the baseline alerts within each resource provider/type folder. Below is the general structure of the file.*

```yaml
- name: <alert name>
Expand Down Expand Up @@ -96,7 +96,7 @@ Please note the following settings in the alert definition:
## Auto-Generated Alert Rules
A script was run to automatically generate alert rules based on top usage and settings trends. These rules have been added to their respective *alerts.yaml* files and have two tags associated with them: *auto-generated* and *agc-xxxx*. The *agc-xxxx* tag indicates the number of results found for that alert rule in the query used to analyze the top trends. This number should be used to evaluate the importance of including that alert rule as guidance in the repo. Once an auto-generated alert rule has been verified and updated with reference documentation, the *visible* property should be set to *true*. This will make the alert rule visible on the site. Resource categories and types that do not have visible alerts are currently hidden from the table of contents. To make those resource categories and types visible, edit their respective *_index.md* files and remove the *geekdocHidden: true* metadata from the top of the file.
A script was run to automatically generate alert rules based on top usage and settings trends. These rules have been added to their respective *alerts.yaml* files and have two tags associated with them: *auto-generated* and *agc-xxxx*. The *agc-xxxx* tag indicates the number of results found for that alert rule in the query used to analyze the top trends. This number should be used to evaluate the importance of including that alert rule as guidance in the repo. Once an auto-generated alert rule has been verified and updated with reference documentation, the *visible* property should be set to *true*. This will make the alert rule visible on the site. Resource providers and types that do not have visible alerts are currently hidden from the table of contents. To make those resource providers and types visible, edit their respective *_index.md* files and remove the *geekdocHidden: true* metadata from the top of the file.
## Context/Background
Expand Down Expand Up @@ -196,4 +196,4 @@ Once you have committed changes to your fork of the AMBA repo, you create a pull

1. Sometimes the local version of the website may show some inconsistencies that don't reflect the content you have created.

- If this happens, kill the Hugo local web server by pressing <kbd>CTRL</kbd>+<kbd>C</kbd> and then restart the Hugo web server by running `hugo server -D` from the root of the repo.
- If this happens, kill the Hugo local web server by pressing <kbd>CTRL</kbd>+<kbd>C</kbd> and then restart the Hugo web server by running `hugo server -D` from the root of the repo.
46 changes: 45 additions & 1 deletion docs/content/visualizations/Azure Workbooks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,50 @@ geekdocCollapseSection: true
---

## Overview

[Azure Workbooks](https://learn.microsoft.com/azure/azure-monitor/visualize/workbooks-overview) provide a flexible canvas for data analysis and the creation of rich visual reports. You can use workbooks to tap into multiple data sources from across Azure and combine them into unified interactive experiences.

## Under Construction
Listed below are some examples of workbooks that you can use to visualize alerts and key metrics from Azure resources. These workbooks templates can be saved to your workbook gallery in Azure.

You can also find information below on [how to save workbook templates](#import-workbook-templates-quick-start-guide)

## Azure Monitor Community

The Azure Monitor Team utilizes [this](https://github.com/microsoft/AzureMonitorCommunity/tree/master/Azure%20Services) github repo to share workbooks for various azure services. Below are some workbooks to highlight alert management and ExpressRoute/network monitoring.

## [Alert Management Workbook](https://github.com/microsoft/AzureMonitorCommunity/blob/master/Azure%20Services/Azure%20Monitor/Workbooks/Alerts%20Management.workbook)

A summary of alerts by your filtered subscription. This workbook contains visualizations of alerts triggered by type, serverity and top 5 noisiest objects.![alert management](../../img/alert-management-wb.png)

## [ExpressRoute Monitoring Workbook](https://github.com/microsoft/AzureMonitorCommunity/blob/master/Azure%20Services/Azure%20Monitor/Workbooks/Azure%20Network%20Monitoring.workbook)

This workbook addresses a common challenge to effectively visualize the health and availability of ExpressRoute components. This is an interactive workbook that provides comprehensive monitoring and troubleshooting for ExpressRoute, including the monitoring of key metrics such as: ExpressRoute Circuit Status, BGP availablity, total throughput, and more.

For full details see:
[Monitoring ExpressRoute: A Workbook Solution](https://techcommunity.microsoft.com/t5/azure-observability-blog/monitoring-expressroute-a-workbook-solution/ba-p/4038130).

![image3](https://techcommunity.microsoft.com/t5/image/serverpage/image-id/545394i89157D8B217AA777/image-dimensions/2000?v=v2&px=-1)
![image4](https://techcommunity.microsoft.com/t5/image/serverpage/image-id/545405i13A8ECBF9B370BB4/image-dimensions/2000?v=v2&px=-1)
![image5](https://techcommunity.microsoft.com/t5/image/serverpage/image-id/545407i490AE5C9D99AECEE/image-dimensions/2000?v=v2&px=-1)

## Import Workbook Templates: quick start guide

Want to see these workbooks live in your Azure environment? Follow these steps to add gallery templates to your saved workbooks.

1. Copy the raw file:
- In the examples above, the titles of the workbooks are hyperlinks to the raw files. From there you can explore other workbooks in the github repo.
![image6](../../img/copy-raw-file.png)

2. Open Azure Monitor, and navigate to Workbooks:
- Once here, click "new".

![image7](../../img/new-workbook.png)

3. Open the advanced editor (</>):
- Paste the raw code, which was copied in step one, in the gallery template.
- Once finished, click apply.
![image10](../../img/gallery-template.png)

4. View your workbook and save it to your gallery:

![image11](../../img/save-workbook.png)
2 changes: 1 addition & 1 deletion docs/content/welcome/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 0
Welcome to the Azure Monitor Baseline Alerts (AMBA) site! The purpose of this site is to provide best practice guidance around key alerts metrics and their thresholds.

This sites is broken down into two main sections:
1. **Services:** This section provides guidance for individual Azure services. For each service, there is a list of key alert metrics and the recommended thresholds.
1. **Azure Resources:** This section provides guidance for individual Azure resources. For each service, there is a list of key alert metrics and the recommended thresholds.

2. **Patterns / Scenarios:** This section provides guidance for common patterns / scenarios (like Azure Landing Zones), as well as policy definition and initiatives for deploying the alerts in your environment.

Expand Down
Binary file added docs/static/img/alert-management-wb.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 docs/static/img/copy-raw-file.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 docs/static/img/gallery-template.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 docs/static/img/new-workbook.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 docs/static/img/save-workbook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions services/DesktopVirtualization/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: DesktopVirtualization
geekdocCollapseSection: true
geekdocHidden: true
---

7 changes: 7 additions & 0 deletions services/DesktopVirtualization/hostPools/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: HostPools
geekdocCollapseSection: true
geekdocHidden: true
---

{{< alertList name="alertList" >}}
Loading

0 comments on commit bd2523a

Please sign in to comment.