Skip to content

Commit 1a8bd67

Browse files
authored
Updates per the feedback
1 parent e4130c6 commit 1a8bd67

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/operator-nexus/howto-cluster-metrics-configuration-management.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
---
2-
title: "Operator Nexus: Cluster Metrics Configuration"
2+
title: "Operator Nexus: How to configure cluster metrics"
33
description: Instructional for the inputs and methods for creating, updating, retrieving, and deleting cluster metrics configurations.
44
author: bryan-strassner
55
ms.author: bstrassner
6-
ms.service: azure
6+
ms.service: operator-nexus
77
ms.topic: how-to
88
ms.date: 02/09/2023
99
ms.custom: template-how-to
1010
---
1111

12-
# Cluster Metrics Configuration
12+
# Cluster metrics configuration
1313

1414
When the user deploys a Cluster, a standard set of metrics are enabled for collection. For the list of metrics, see
1515
[List of Metrics Collected](List-of-metrics-collected.md).
1616

1717
Users can't control the behavior (enable or disable) for collection of these included standard metrics. Though, users can control the collection of some optional metrics that aren't part of the link in the list. To enable this experience, users will have to create and update a MetricsConfiguration resource for a cluster. By default, creation of this MetricsConfiguration resource doesn't change the collection of metrics. User will have to update the resource to enable or disable these optional metrics collection.
1818

19-
**Notes:**
20-
1. For a cluster, at max, only one MetricsConfiguration resource could be created.
21-
2. Users need to create a MetricsConfiguration resource to check a list of optional metrics that can be controlled.
22-
3. Deletion of the MetricsConfiguration resource will result in the standard set of metrics being restored.
19+
> [!NOTE]
20+
> * For a cluster, at max, only one MetricsConfiguration resource could be created.
21+
> * Users need to create a MetricsConfiguration resource to check a list of optional metrics that can be controlled.
22+
> * Deletion of the MetricsConfiguration resource will result in the standard set of metrics being restored.
2323
24-
## How To Manage Cluster Metrics Configuration
24+
## How to manage cluster metrics configuration
2525

2626
To support the lifecycle of cluster metrics configurations, the following `az rest` interactions allow for the creation and management of a cluster's metrics configurations.
2727

28-
### Creating a Metrics Configuration
28+
### Creating a metrics configuration
2929

3030
Use of the `az rest` command requires that the request input is defined, and then a `PUT` request is made to the `Microsoft.NetworkCloud` resource provider.
3131

@@ -64,9 +64,9 @@ export CLUSTER=<the cluter name>
6464
az rest -m put -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview" -b @create_metrics_configuration.json --debug
6565
```
6666

67-
Specifying `--debug` in REST API will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to Track Asynchronous Operations](howto-Track-Async-Operations-CLI.md).
67+
Specifying `--debug` in REST API will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to track asynchronous operations](howto-track-async-operations-cli.md).
6868

69-
## Retrieving a Metrics Configuration
69+
## Retrieving a metrics configuration
7070

7171
After a metrics configuration is created, it can be retrieved using a `az rest` command:
7272

@@ -80,7 +80,7 @@ az rest -m get -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/re
8080

8181
This command will return a JSON representation of the metrics configuration.
8282

83-
## Updating a Metrics Configuration
83+
## Updating a metrics configuration
8484

8585
Much like the creation of a metrics configuration, an update can be performed to change the configuration. A file, containing the metrics to be updated, is consumed as an input.
8686

@@ -108,9 +108,9 @@ export CLUSTER=<the cluter name>
108108
az rest -m put -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview" -b @update_metrics_configuration.json --debug
109109
```
110110

111-
Specifying `--debug` in REST API will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to Track Asynchronous Operations](howto-Track-Async-Operations-CLI.md).
111+
Specifying `--debug` in REST API will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to track asynchronous operations](howto-track-async-operations-cli.md).
112112

113-
## Deleting a Metrics Configuration
113+
## Deleting a metrics configuration
114114

115115
Deletion of the metrics configuration will return the cluster to an unaltered configuration. To delete a metrics configuration, `az rest` API is used.
116116

@@ -122,4 +122,4 @@ export CLUSTER=<the cluter name>
122122
az rest -m delete -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview" --debug
123123
```
124124

125-
Specifying `--debug` in REST API will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to Track Asynchronous Operations](howto-Track-Async-Operations-CLI.md).
125+
Specifying `--debug` in REST API will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to track asynchronous operations](howto-track-async-operations-cli.md).

0 commit comments

Comments
 (0)