You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-cluster-metrics-configuration-management.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,12 @@ ms.custom: template-how-to
14
14
When the user deploys a Cluster, a standard set of metrics are enabled for collection. For the list of metrics, see
15
15
[List of Metrics Collected](List-of-metrics-collected.md).
16
16
17
-
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 to 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.
17
+
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 to the list. To enable this experience, users 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 has to update the resource to enable or disable these optional metrics collection.
18
18
19
19
> [!NOTE]
20
20
> * For a cluster, at max, only one MetricsConfiguration resource can be created.
21
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.
22
+
> * Deletion of the MetricsConfiguration resource results in the standard set of metrics being restored.
23
23
24
24
## How to manage cluster metrics configuration
25
25
@@ -48,25 +48,25 @@ az networkcloud cluster metricsconfiguration create \
48
48
> * The default metrics collection interval for standard set of metrics is set to every 5 minutes. Changing the `collectionInterval` will also impact the collection frequency for default standard metrics.
49
49
> * There can be only one set of metrics configuration defined per cluster. The resource is created with the name `default`.
50
50
51
-
Specifying `--no-wait --debug` options in az cli command will result in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
51
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
| LOCATION | The Azure Region where the Cluster will be deployed |
58
+
| LOCATION | The Azure Region where the Cluster is deployed|
59
59
| CLUSTER_EXTENDED_LOCATION_ID | The Cluster extended Location from Azure portal |
60
60
| COLLECTION_INTERVAL | The collection frequency for default standard metrics |
61
61
| RESOURCE_GROUP | The Cluster resource group name |
62
62
| TAG_KEY1 | Optional tag1 to pass to Cluster create |
63
63
| TAG_VALUE1 | Optional tag1 value to pass to Cluster Create |
64
64
| TAG_KEY2 | Optional tag2 to pass to Cluster create |
65
65
| TAG_VALUE2 | Optional tag2 value to pass to Cluster create |
66
-
| METRIC_TO_ENABLE_1 | Optional metric1 that have been chosen to be enabled in addition to the default metrics |
67
-
| METRIC_TO_ENABLE_2 | Optional metric2 that have been chosen to be enabled in addition to the default metrics |
66
+
| METRIC_TO_ENABLE_1 | Optional metric1 that is enabled in addition to the default metrics |
67
+
| METRIC_TO_ENABLE_2 | Optional metric2 that is enabled in addition to the default metrics |
68
68
69
-
Specifying `--no-wait --debug` options in az cli command will result in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
69
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
70
70
71
71
## Retrieving a metrics configuration
72
72
@@ -79,7 +79,7 @@ az networkcloud cluster metricsconfiguration show \
79
79
--resource-group "<RESOURCE_GROUP>"
80
80
```
81
81
82
-
This command will return a JSON representation of the metrics configuration.
82
+
This command returns a JSON representation of the metrics configuration.
83
83
84
84
## Updating a metrics configuration
85
85
@@ -96,18 +96,18 @@ az networkcloud cluster metricsconfiguration update \
96
96
97
97
The `collection-interval` can be updated independently of `enabled-metrics` list. Omit fields that aren't being changed.
98
98
99
-
Specifying `--no-wait --debug` options in az cli command will result in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
99
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
100
100
101
101
## Deleting a metrics configuration
102
102
103
-
Deletion of the metrics configuration will return the cluster to an unaltered configuration. To delete a metrics configuration, use the below command:
103
+
Deletion of the metrics configuration returns the cluster to an unaltered configuration. To delete a metrics configuration, use the below command:
104
104
105
105
```azurecli
106
106
az networkcloud cluster metricsconfiguration delete \
107
107
--cluster-name "<CLUSTER>" \
108
108
--resource-group "<RESOURCE_GROUP>"
109
109
```
110
110
111
-
Specifying `--no-wait --debug` options in az cli command will result in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
111
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
0 commit comments