Skip to content

Commit 3440018

Browse files
committed
edit pass: essentials-articles-batch-4
1 parent 1f008ac commit 3440018

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

articles/azure-monitor/essentials/prometheus-metrics-enable.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ Deploy the template with the parameter file by using any valid method for deploy
328328

329329
## Enable Windows metrics collection
330330

331-
As of version 6.4.0-main-02-22-2023-3ee44b9e, Windows metric collection has been enabled for the AKS clusters. Onboarding to the Azure Monitor Metrics add-on enables the Windows DaemonSet pods to start running on your nodepools. Both Windows Server 2019 and Windows Server 2022 are supported. Follow these steps to enable the pods to collect metrics from your Windows node pools.
331+
As of version 6.4.0-main-02-22-2023-3ee44b9e, Windows metric collection has been enabled for the AKS clusters. Onboarding to the Azure Monitor Metrics add-on enables the Windows DaemonSet pods to start running on your node pools. Both Windows Server 2019 and Windows Server 2022 are supported. Follow these steps to enable the pods to collect metrics from your Windows node pools.
332332

333333
1. Manually install windows-exporter on AKS nodes to access Windows metrics.
334334
Enable the following collectors:
@@ -355,7 +355,7 @@ As of version 6.4.0-main-02-22-2023-3ee44b9e, Windows metric collection has been
355355

356356
## Verify deployment
357357

358-
Run the following command to verify that the DaemonSet was deployed properly on the Linux nodepools:
358+
Run the following command to verify that the DaemonSet was deployed properly on the Linux node pools:
359359

360360
```
361361
kubectl get ds ama-metrics-node --namespace=kube-system
@@ -369,7 +369,7 @@ NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SEL
369369
ama-metrics-node 1 1 1 1 1 <none> 10h
370370
```
371371

372-
Run the following command to verify that the DaemonSet was deployed properly on the Windows nodepools:
372+
Run the following command to verify that the DaemonSet was deployed properly on the Windows node pools:
373373

374374
```
375375
kubectl get ds ama-metrics-win-node --namespace=kube-system

articles/azure-monitor/essentials/prometheus-metrics-scrape-configuration.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ This article provides instructions on customizing metrics scraping for a Kuberne
1515

1616
Three different configmaps can be configured to change the default settings of the metrics add-on:
1717

18-
- ama-metrics-settings-configmap
19-
- ama-metrics-prometheus-config
20-
- ama-metrics-prometheus-config-node
18+
- `ama-metrics-settings-configmap`
19+
- `ama-metrics-prometheus-config`
20+
- `ama-metrics-prometheus-config-node`
2121

2222
## Metrics add-on settings configmap
2323

@@ -39,7 +39,7 @@ The following table has a list of all the default targets that the Azure Monitor
3939
| windowskubeproxy | bool | `false` | Scrape windows-kube-proxy in every node in the K8s cluster without any extra scrape config.<br>Windows only. |
4040
| prometheuscollectorhealth | bool | `false` | Scrape information about the prometheus-collector container, such as the amount and size of time series scraped. |
4141

42-
If you want to turn on the scraping of the default targets that aren't enabled by default, edit the configmap `ama-metrics-settings-configmap` [configmap](https://aka.ms/azureprometheus-addon-settings-configmap) to update the targets listed under `default-scrape-settings-enabled` to `true`. Apply the configmap to your cluster.
42+
If you want to turn on the scraping of the default targets that aren't enabled by default, edit the [configmap](https://aka.ms/azureprometheus-addon-settings-configmap) `ama-metrics-settings-configmap` to update the targets listed under `default-scrape-settings-enabled` to `true`. Apply the configmap to your cluster.
4343

4444
### Customize metrics collected by default targets
4545
By default, for all the default targets, only minimal metrics used in the default recording rules, alerts, and Grafana dashboards are ingested as described in [minimal-ingestion-profile](prometheus-metrics-scrape-configuration-minimal.md). To collect all metrics from default targets, in the configmap under `default-targets-metrics-keep-list`, set `minimalingestionprofile` to `false`.
@@ -54,25 +54,25 @@ apiserver = "mymetric.*"
5454
```
5555

5656
> [!NOTE]
57-
> If you use quotes or backslashes in the regex, you'll need to escape them by using a backslash. Examples are `"test\'smetric\"s\""` and `testbackslash\\*`.
57+
> If you use quotation marks or backslashes in the regex, you need to escape them by using a backslash like the examples `"test\'smetric\"s\""` and `testbackslash\\*`.
5858
59-
To further customize the default jobs to change properties such as collection frequency or labels, disable the corresponding default target by setting the configmap value for the target to `false`. Then apply the job by using custom configmap. For details on custom configuration, see [Customize scraping of Prometheus metrics in Azure Monitor](prometheus-metrics-scrape-configuration.md#configure-custom-prometheus-scrape-jobs).
59+
To further customize the default jobs to change properties like collection frequency or labels, disable the corresponding default target by setting the configmap value for the target to `false`. Then apply the job by using a custom configmap. For details on custom configuration, see [Customize scraping of Prometheus metrics in Azure Monitor](prometheus-metrics-scrape-configuration.md#configure-custom-prometheus-scrape-jobs).
6060

6161
### Cluster alias
62-
The cluster label appended to every time series scraped will use the last part of the full AKS cluster's Azure Resource Manager resource ID. For example, if the resource ID is `/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-name/providers/Microsoft.ContainerService/managedClusters/clustername`, the cluster label is `clustername`.
62+
The cluster label appended to every time series scraped uss the last part of the full AKS cluster's Azure Resource Manager resource ID. For example, if the resource ID is `/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-name/providers/Microsoft.ContainerService/managedClusters/clustername`, the cluster label is `clustername`.
6363

64-
To override the cluster label in the time series scraped, update the setting `cluster_alias` to any string under `prometheus-collector-settings` in the `ama-metrics-settings-configmap` [configmap](https://aka.ms/azureprometheus-addon-settings-configmap). You can either create this configmap or edit an existing one.
64+
To override the cluster label in the time series scraped, update the setting `cluster_alias` to any string under `prometheus-collector-settings` in the [configmap](https://aka.ms/azureprometheus-addon-settings-configmap) `ama-metrics-settings-configmap`. You can either create this configmap or edit an existing one.
6565

6666
The new label also shows up in the cluster parameter dropdown in the Grafana dashboards instead of the default one.
6767

6868
> [!NOTE]
6969
> Only alphanumeric characters are allowed. Any other characters are replaced with `_`. This change is to ensure that different components that consume this label adhere to the basic alphanumeric convention.
7070
7171
### Debug mode
72-
To view every metric that's being scraped for debugging purposes, the metrics add-on agent can be configured to run in debug mode by updating the setting `enabled` to `true` under the `debug-mode` setting in `ama-metrics-settings-configmap` [configmap](https://aka.ms/azureprometheus-addon-settings-configmap). You can either create this configmap or edit an existing one. For more information, see [the Debug Mode section in Troubleshoot collection of Prometheus metrics](prometheus-metrics-troubleshoot.md#debug-mode).
72+
To view every metric that's being scraped for debugging purposes, the metrics add-on agent can be configured to run in debug mode by updating the setting `enabled` to `true` under the `debug-mode` setting in the [configmap](https://aka.ms/azureprometheus-addon-settings-configmap) `ama-metrics-settings-configmap`. You can either create this configmap or edit an existing one. For more information, see the [Debug mode section in Troubleshoot collection of Prometheus metrics](prometheus-metrics-troubleshoot.md#debug-mode).
7373

7474
### Scrape interval settings
75-
To update the scrape interval settings for any target, the customer can update the duration in default-targets-scrape-interval-settings setting for that target in `ama-metrics-settings-configmap` [configmap](https://aka.ms/azureprometheus-addon-settings-configmap). The scrape intervals have to be set by customer in the correct format specified [here](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file). Otherwise, the default value of 30 seconds is applied to the corresponding targets.
75+
To update the scrape interval settings for any target, you can update the duration in the setting `default-targets-scrape-interval-settings` for that target in the [configmap](https://aka.ms/azureprometheus-addon-settings-configmap) `ama-metrics-settings-configmap`. You have to set the scrape intervals in the correct format specified in [this website](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file). Otherwise, the default value of 30 seconds is applied to the corresponding targets.
7676

7777
## Configure custom Prometheus scrape jobs
7878

@@ -82,11 +82,11 @@ Follow the instructions to [create, validate, and apply the configmap](prometheu
8282

8383
### Advanced setup: Configure custom Prometheus scrape jobs for the DaemonSet
8484

85-
The `ama-metrics` ReplicaSet pod consumes the custom Prometheus config and scrapes the specified targets. For a cluster with a large number of nodes and pods and a large volume of metrics to scrape, some of the applicable custom scrape targets can be off-loaded from the single `ama-metrics` ReplicaSet pod to the `ama-metrics` DaemonSet pod.
85+
The `ama-metrics` ReplicaSet pod consumes the custom Prometheus config and scrapes the specified targets. For a cluster with a large number of nodes and pods and a large volume of metrics to scrape, some of the applicable custom scrape targets can be off-loaded from the single `ama-metrics` ReplicaSet pod to the `ama-metrics` DaemonSet pod.
8686

87-
The [ama-metrics-prometheus-config-node configmap](https://aka.ms/azureprometheus-addon-ds-configmap), similar to the regular configmap, can be created to have static scrape configs on each node. The scrape config should only target a single node and shouldn't use service discovery. Otherwise, each node tries to scrape all targets and will make many calls to the Kubernetes API server.
87+
The [ama-metrics-prometheus-config-node configmap](https://aka.ms/azureprometheus-addon-ds-configmap), similar to the regular configmap, can be created to have static scrape configs on each node. The scrape config should only target a single node and shouldn't use service discovery. Otherwise, each node tries to scrape all targets and makes many calls to the Kubernetes API server.
8888

89-
The following `node-exporter` config is one of the default targets for the DaemonSet pods. It uses the `$NODE_IP` environment variable, which is already set for every ama-metrics add-on container to target a specific port on the node.
89+
The following `node-exporter` config is one of the default targets for the DaemonSet pods. It uses the `$NODE_IP` environment variable, which is already set for every `ama-metrics` add-on container to target a specific port on the node.
9090

9191
```yaml
9292
- job_name: node
@@ -108,7 +108,7 @@ Custom scrape targets can follow the same format by using `static_configs` with
108108

109109
## Prometheus configuration tips and examples
110110

111-
Learn some tips and see some examples in this section.
111+
Learn some tips from examples in this section.
112112

113113
### Configuration file for custom scrape config
114114

@@ -126,7 +126,7 @@ scrape_configs:
126126
- <job-y>
127127
```
128128

129-
Any other unsupported sections must be removed from the config before they're applied as a configmap. Otherwise, the custom configuration fails validation and won't be applied.
129+
Any other unsupported sections must be removed from the config before they're applied as a configmap. Otherwise, the custom configuration fails validation and isn't applied.
130130

131131
See the [Apply config file](prometheus-metrics-scrape-validate.md#apply-config-file) section to create a configmap from the Prometheus config.
132132

articles/azure-monitor/essentials/prometheus-metrics-scrape-default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ The following metrics are collected by default from each default target. All oth
141141
Two default jobs can be run for Windows that scrape metrics required for the dashboards specific to Windows.
142142

143143
> [!NOTE]
144-
> This requires an update in the ama-metrics-settings-configmap and installing windows-exporter on all Windows nodepools. For more information, see the [enablement document](./prometheus-metrics-enable.md#enable-prometheus-metric-collection).
144+
> This requires an update in the ama-metrics-settings-configmap and installing windows-exporter on all Windows node pools. For more information, see the [enablement document](./prometheus-metrics-enable.md#enable-prometheus-metric-collection).
145145
146146
- `windows-exporter` (`job=windows-exporter`)
147147
- `kube-proxy-windows` (`job=kube-proxy-windows`)

0 commit comments

Comments
 (0)