Skip to content

Commit 979ece6

Browse files
authored
Merge pull request #236512 from vishiy/main
Changes & updates to Azure managed Prometheus docs
2 parents 329a1b5 + b010935 commit 979ece6

21 files changed

+773
-445
lines changed

articles/azure-monitor/containers/container-insights-prometheus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.reviewer: aul
1010
# Collect Prometheus metrics with Container insights
1111
[Prometheus](https://aka.ms/azureprometheus-promio) is a popular open-source metric monitoring solution and is the most common monitoring tool used to monitor Kubernetes clusters. Container insights uses its containerized agent to collect much of the same data that Prometheus typically collects from the cluster without requiring a Prometheus server. This data is presented in Container insights views and available to other Azure Monitor features such as [log queries](container-insights-log-query.md) and [log alerts](container-insights-log-alerts.md).
1212

13-
Container insights can also scrape Prometheus metrics from your cluster and send the data to either Azure Monitor Logs or to Azure Monitor managed service for Prometheus. This requires exposing the Prometheus metrics endpoint through your exporters or pods and then configuring one of the addons for the Azure Monitor agent used by Container insights as shown the following diagram.
13+
Container insights can also scrape your custom Prometheus metrics from your application on your cluster and send the data to either Azure Monitor Logs or to Azure Monitor managed service for Prometheus (preview). This requires exposing the Prometheus metrics endpoint through your exporters or pods and then configuring one of the addons for the Azure Monitor agent used by Container insights as shown the following diagram. Metrics sent to the Log Analytics workspace are queried through log queries, whereas Metrics sent through Azure Monitor managed Prometheus are queried through PromQL and Prometheus recording rules and alerts are supported.
1414

1515
:::image type="content" source="media/container-insights-prometheus/monitoring-kubernetes-architecture.png" lightbox="media/container-insights-prometheus/monitoring-kubernetes-architecture.png" alt-text="Diagram of container monitoring architecture sending Prometheus metrics to Azure Monitor Logs." border="false":::
1616

@@ -40,14 +40,14 @@ Use the following procedure to add Prometheus collection to your cluster that's
4040

4141
6. Click **Configure** to complete the configuration.
4242

43-
See [Collect Prometheus metrics from AKS cluster (preview)](../essentials/prometheus-metrics-enable.md) for details on [verifying your deployment](../essentials/prometheus-metrics-enable.md#verify-deployment) and [limitations](../essentials/prometheus-metrics-enable.md#limitations)
43+
See [Collect Prometheus metrics from AKS cluster (preview)](../essentials/prometheus-metrics-enable.md) for details on [verifying your deployment](../essentials/prometheus-metrics-enable.md#verify-deployment) and [limitations](../essentials/prometheus-metrics-enable.md#limitations-during-enablementdeployment)
4444

4545
## Send metrics to Azure Monitor Logs
4646
You may want to collect more data in addition to the predefined set of data collected by Container insights. This data isn't used by Container insights views but is available for log queries and alerts like the other data it collects. This requires configuring the *monitoring addon* for the Azure Monitor agent, which is the one currently used by Container insights to send data to a Log Analytics workspace.
4747

48-
### Prometheus scraping settings
48+
### Prometheus scraping settings (for metrics stored as logs)
4949

50-
Active scraping of metrics from Prometheus is performed from one of two perspectives:
50+
Active scraping of metrics from Prometheus is performed from one of two perspectives below and metrics are sent to configured log analytics workspace :
5151

5252
- **Cluster-wide**: Defined in the ConfigMap section *[Prometheus data_collection_settings.cluster]*.
5353
- **Node-wide**: Defined in the ConfigMap section *[Prometheus_data_collection_settings.node]*.
@@ -75,7 +75,7 @@ When a URL is specified, Container insights only scrapes the endpoint. When Kube
7575
| Node-wide or cluster-wide | `interval` | String | 60s | The collection interval default is one minute (60 seconds). You can modify the collection for either the *[prometheus_data_collection_settings.node]* and/or *[prometheus_data_collection_settings.cluster]* to time units such as s, m, and h. |
7676
| Node-wide or cluster-wide | `fieldpass`<br> `fielddrop`| String | Comma-separated array | You can specify certain metrics to be collected or not from the endpoint by setting the allow (`fieldpass`) and disallow (`fielddrop`) listing. You must set the allowlist first. |
7777

78-
### Configure ConfigMaps
78+
### Configure ConfigMaps to specify Prometheus scrape configuration (for metrics stored as logs)
7979
Perform the following steps to configure your ConfigMap configuration file for your cluster. ConfigMaps is a global list and there can be only one ConfigMap applied to the agent. You can't have another ConfigMaps overruling the collections.
8080

8181

@@ -132,7 +132,7 @@ Perform the following steps to configure your ConfigMap configuration file for y
132132
133133
To configure scraping of Prometheus metrics by specifying a pod annotation:
134134
135-
1. In the ConfigMap, specify the following configuration:
135+
1. In the ConfigMap, specify the following configuration:
136136
137137
```
138138
prometheus-data-collection-settings: |- ​
@@ -142,7 +142,7 @@ Perform the following steps to configure your ConfigMap configuration file for y
142142
monitor_kubernetes_pods = true
143143
```
144144
145-
1. Specify the following configuration for pod annotations:
145+
2. Specify the following configuration for pod annotations:
146146
147147
```
148148
- prometheus.io/scrape:"true" #Enable scraping for this pod ​

articles/azure-monitor/essentials/azure-monitor-workspace-manage.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.date: 03/28/2023
1313
This article shows you how to create and delete an Azure Monitor workspace. When you configure Azure Monitor managed service for Prometheus, you can select an existing Azure Monitor workspace or create a new one.
1414

1515
> [!NOTE]
16-
> When you create an Azure Monitor workspace, by default a data collection rule and a data collection endpoint in the form `<azure-workspace-name>` will automatically be created in a resource group in the form `MA_<azure-workspace-name>_<location>_managed`.
16+
> When you create an Azure Monitor workspace, by default a data collection rule and a data collection endpoint in the form `<azure-monitor-workspace-name>` will automatically be created in a resource group in the form `MA_<azure-monitor-workspace-name>_<location>_managed`.
1717
1818
## Create an Azure Monitor workspace
1919
### [Azure portal](#tab/azure-portal)
@@ -76,13 +76,13 @@ resource workspace 'microsoft.monitor/accounts@2021-06-03-preview' = {
7676
```
7777
---
7878

79-
When you create an Azure Monitor workspace, a new resource group is created. The resource group name has the following format: `MA_<azure monitor workspace resource name>_<location code>_managed`, where the tokenized elements are in lower case. The resource group contains a data collection endpoint, and a data collection rule with the same name as the workspace. The resource group and its resources are automatically deleted when you delete the workspace.
79+
When you create an Azure Monitor workspace, a new resource group is created. The resource group name has the following format: `MA_<azure-monitor-workspace-name>_<location>_managed`, where the tokenized elements are lowercased. The resource group contains both a data collection endpoint and a data collection rule with the same name as the workspace. The resource group and its resources are automatically deleted when you delete the workspace.
8080

8181
To connect your Azure Monitor managed service for Prometheus to your Azure Monitor workspace, see [Collect Prometheus metrics from AKS cluster](./prometheus-metrics-enable.md)
8282

8383

8484
## Delete an Azure Monitor workspace
85-
When you delete an Azure Monitor workspace, no soft-delete operation is performed like with a [Log Analytics workspace](../logs/delete-workspace.md). The data in the workspace is immediately deleted, and there's no recovery option.
85+
When you delete an Azure Monitor workspace, unlike with a [Log Analytics workspace](../logs/delete-workspace.md), there is no soft delete operation. The data in the workspace is immediately deleted, and there's no recovery option.
8686

8787

8888
### [Azure portal](#tab/azure-portal)
@@ -94,7 +94,7 @@ When you delete an Azure Monitor workspace, no soft-delete operation is performe
9494
:::image type="content" source="media/azure-monitor-workspace-overview/delete-azure-monitor-workspace.png" lightbox="media/azure-monitor-workspace-overview/delete-azure-monitor-workspace.png" alt-text="Screenshot of Azure Monitor workspaces delete button.":::
9595

9696
### [CLI](#tab/cli)
97-
To delete an AzureMonitor workspace use [az resource delete](https://learn.microsoft.com/cli/azure/resource#az-resource-delete)
97+
To delete an AzureMonitor workspace use `az resource delete`
9898

9999
For example:
100100
```azurecli
@@ -117,7 +117,7 @@ For information on deleting resources and Azure Resource Manager, see [Azure Res
117117
Connect an Azure Monitor workspace to an [Azure Managed Grafana](../../managed-grafana/overview.md) workspace to allow Grafana to use the Azure Monitor workspace data in a Grafana dashboard. An Azure Monitor workspace can be connected to multiple Grafana workspaces, and a Grafana workspace can be connected to multiple Azure Monitor workspaces.
118118

119119
> [!NOTE]
120-
> When you add the Azure Monitor workspace as a data source to Grafana, it will be listed in form `Managed_Prometheus_<azure-workspace-name>`.
120+
> When you add the Azure Monitor workspace as a data source to Grafana, it will be listed in form `Managed_Prometheus_<azure-monitor-workspace-name>`.
121121
### [Azure portal](#tab/azure-portal)
122122

123123
1. Open the **Azure Monitor workspace** menu in the Azure portal.
@@ -129,14 +129,16 @@ Connect an Azure Monitor workspace to an [Azure Managed Grafana](../../managed-g
129129

130130
Create a link between the Azure Monitor workspace and the Grafana workspace by updating the Azure Kubernetes Service cluster that you're monitoring.
131131

132+
If your cluster is already configured to send data to an Azure Monitor managed service for Prometheus, you must disable it first using the following command:
133+
132134
```azurecli
133-
az aks update --enable-azuremonitormetrics -n <cluster-name> -g <cluster-resource-group> --azure-monitor-workspace-resource-id
134-
<azure-monitor-workspace-name-resource-id> --grafana-resource-id <grafana-workspace-name-resource-id>
135+
az aks update --disable-azuremonitormetrics -g <cluster-resource-group> -n <cluster-name>
135136
```
136-
If your cluster is already configured to send data to an Azure Monitor managed service for Prometheus, disable it first using the following command:
137137

138+
Then, either enable or re-enable using the following command:
138139
```azurecli
139-
az aks update --disable-azuremonitormetrics -g <cluster-resource-group> -n <cluster-name>
140+
az aks update --enable-azuremonitormetrics -n <cluster-name> -g <cluster-resource-group> --azure-monitor-workspace-resource-id
141+
<azure-monitor-workspace-name-resource-id> --grafana-resource-id <grafana-workspace-name-resource-id>
140142
```
141143

142144
Output
@@ -159,7 +161,7 @@ To set up an Azure monitor workspace as a data source for Grafana using a Resour
159161

160162
---
161163

162-
If your Grafana Instance is self managed, see [Use Azure Monitor managed service for Prometheus (preview) as data source for self-managed Grafana using managed system identity](./prometheus-self-managed-grafana-azure-active-directory.md)
164+
If your Grafana instance is self managed, see [Use Azure Monitor managed service for Prometheus (preview) as data source for self-managed Grafana using managed system identity](./prometheus-self-managed-grafana-azure-active-directory.md)
163165

164166

165167

@@ -168,6 +170,6 @@ If your Grafana Instance is self managed, see [Use Azure Monitor managed service
168170

169171

170172
## Next steps
171-
- [Links a Grafana instance to your Azure monitor Workspace](./prometheus-metrics-enable.md#enable-prometheus-metric-collection)
173+
- [Link a Grafana instance to your Azure Monitor workspace](./prometheus-metrics-enable.md#enable-prometheus-metric-collection)
172174
- Learn more about the [Azure Monitor data platform](../data-platform.md).
173-
- [Azure Monitor Workspace Overview](./azure-monitor-workspace-overview.md)
175+
- [Azure Monitor workspace Overview](./azure-monitor-workspace-overview.md)

articles/azure-monitor/essentials/azure-monitor-workspace-overview.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.date: 01/22/2023
1212
An Azure Monitor workspace is a unique environment for data collected by Azure Monitor. Each workspace has its own data repository, configuration, and permissions.
1313

1414
> [!Note]
15-
> Log Analytics workspaces contain logs and metrics data from multiple Azure resources, whereas Azure Monitor workspaces contain only metrics related to Prometheus.
15+
> Log Analytics workspaces contain logs and metrics data from multiple Azure resources, whereas Azure Monitor workspaces currently contain only metrics related to Prometheus.
1616
1717
## Contents of Azure Monitor workspace
1818
Azure Monitor workspaces will eventually contain all metric data collected by Azure Monitor. Currently, only Prometheus metrics are data hosted in an Azure Monitor workspace.
@@ -29,43 +29,43 @@ The following table presents criteria to consider when designing an Azure Monito
2929

3030
|Criteria|Description|
3131
|---|---|
32-
|Segregate by logical boundaries |Create separate Azure Monitor workspaces for operational data based on logical boundaries, for example, a role, application type, type of metric etc.|
32+
|Segregate by logical boundaries |Create separate Azure Monitor workspaces for operational data based on logical boundaries, such as by a role, application type, type of metric etc.|
3333
|Azure tenants | For multiple Azure tenants, create an Azure Monitor workspace in each tenant. Data sources can only send monitoring data to an Azure Monitor workspace in the same Azure tenant. |
3434
|Azure regions |Each Azure Monitor workspace resides in a particular Azure region. Regulatory or compliance requirements may dictate the storage of data in particular locations. |
35-
|Data ownership |Create separate Azure Monitor workspaces to define data ownership, for example by subsidiaries or affiliated companies.|
35+
|Data ownership |Create separate Azure Monitor workspaces to define data ownership, such as by subsidiaries or affiliated companies.|
3636

3737
### Considerations when creating an Azure Monitor workspace
3838

39-
* Azure Monitor workspaces are regional. When you create a new Azure Monitor workspace, you provide a region, setting the location in which the data is stored.
39+
* Azure Monitor workspaces are regional. When you create a new Azure Monitor workspace, you provide a region which sets the location in which the data is stored.
4040

4141
* Start with a single workspace to reduce the complexity of managing and querying data from multiple Azure resources.
4242

4343
* The default Azure Monitor workspace limit is 1 million active times series and 1 million events per minute ingested.
4444

45-
* There's no reduction in performance due to the amount of data in your Azure Monitor workspace. Multiple services can send data to the same account simultaneously. There is, however, a limit on how large an Azure Monitor workspace can scale as explained below.
45+
* There's no reduction in performance due to the amount of data in your Azure Monitor workspace. Multiple services can send data to the same account simultaneously. There is, however, a limit on how much an Azure Monitor workspace can scale, as explained below.
4646

4747
### Growing account capacity
4848

49-
Azure Monitor workspaces have default quotas and limitations for metrics. As your product grows and you need more metrics, you can request an increase to 50 million events or active time series. If your capacity needs grow exceptionally large, and your data ingestion needs can no longer be met by a single Azure Monitor workspace, consider creating multiple Azure Monitor workspaces.
49+
Azure Monitor workspaces have default quotas and limitations for metrics. As your product grows and you need more metrics, you can request an increase to 50 million events or active time series. If your capacity needs to be exceptionally large and your data ingestion needs can no longer be met by a single Azure Monitor workspace, consider creating multiple Azure Monitor workspaces.
5050

5151
### Multiple Azure Monitor workspaces
5252

53-
When an Azure Monitor workspace reaches 80% of its maximum capacity, or depending on your current and forecasted metrics volume, it's recommended to split the Azure Monitor workspace into multiple workspaces. Split the workspace based on how the data in the workspace is used by your applications and business processes, and how you want to access that data in the future.
53+
When an Azure Monitor workspace reaches 80% of its maximum capacity or is forecasted to reach that volume of metrics, it's recommended to split the Azure Monitor workspace into multiple workspaces. You should split the workspace based on how the data in the workspace is used by your applications and business processes and by how you want to access that data in the future.
5454

55-
In certain circumstances, splitting Azure Monitor workspace into multiple workspaces can be necessary. For example:
56-
* Monitoring data in sovereign cloudsCreate Azure Monitor workspace(s) in each sovereign cloud.
57-
* Compliance or regulatory requirements that mandate storage of data in specific regions Create an Azure Monitor workspace per region as per requirements. There may be a need to manage the scale of metrics for large services or financial institutions with regional accounts.
58-
* Separating metric data in test, pre-production, and production environments
55+
In certain circumstances, splitting an Azure Monitor workspace into multiple workspaces can be necessary. For example:
56+
* Monitoring data in sovereign clouds: Create an Azure Monitor workspace in each sovereign cloud.
57+
* Compliance or regulatory requirements that mandate storage of data in specific regions: Create an Azure Monitor workspace per region as per requirements. There may be a need to manage the scale of metrics for large services or financial institutions with regional accounts.
58+
* Separating metrics in test, pre-production, and production environments: Create an Azure Monitor workspace per environment.
5959

6060
>[!Note]
61-
> A single query cannot access multiple Azure Monitor workspaces. Keep data that you want to retrieve in a single query in same workspace. For presentation purposes, setting up Grafana with each workspace as a dedicated data source will allow for querying multiple workspaces in a single Grafana panel.
61+
> A single query cannot access multiple Azure Monitor workspaces. Keep data that you want to retrieve in a single query in same workspace. For visualization purposes, setting up Grafana with each workspace as a dedicated data source will allow for querying multiple workspaces in a single Grafana panel.
6262
6363

6464
## Limitations
6565
See [Azure Monitor service limits](../service-limits.md#prometheus-metrics) for performance related service limits for Azure Monitor managed service for Prometheus.
66-
- Private Links aren't supported for Prometheus metrics collection into Azure monitor workspace.
67-
- Azure monitor workspaces are currently only supported in public clouds.
68-
- Azure monitor workspaces don't currently support being moved into a different subscription or resource group once created.
66+
- Azure Monitor Private Links aren't supported for Prometheus metrics collection into Azure monitor workspace.
67+
- Azure Monitor workspaces are currently only supported in public clouds.
68+
- Azure Monitor workspaces don't currently support being moved into a different subscription or resource group once created.
6969

7070

7171
## Next steps
165 KB
Loading

0 commit comments

Comments
 (0)