Skip to content

Commit 8b0532a

Browse files
committed
Updates to metadata and headings per Linter
1 parent 6a4e980 commit 8b0532a

File tree

5 files changed

+31
-34
lines changed

5 files changed

+31
-34
lines changed

articles/iot-operations/monitor/howto-add-cluster.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: Add a cluster
3-
titleSuffix: Azure IoT Operations
43
description: How to add an Arc-enabled cluster to existing observability infrastructure in Azure IoT Operations.
54
author: timlt
65
ms.author: timlt
76
ms.topic: how-to
8-
ms.date: 02/04/2024
7+
ms.date: 02/27/2024
98

109
# CustomerIntent: As an IT admin or operator, I want to add more Arc-enabled clusters
1110
# to my existing observability infrastructure.
@@ -19,7 +18,7 @@ You can share observability resources across multiple Arc-enabled clusters that
1918

2019
## Prerequisites
2120

22-
- Azure IoT Operations Preview installed. For more information, see [Get started: configure observability](howto-configure-observability.md).
21+
- Azure IoT Operations installed. For more information, see [Get started: configure observability](howto-configure-observability.md).
2322

2423
## Add an Arc-enabled cluster
2524
To create this setup, run the following command. Specify the two resource IDs for the observability components that were output when you ran the steps in [Install observability components](howto-configure-observability.md#install-observability-components).

articles/iot-operations/monitor/howto-clean-up-observability-resources.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Clean up observability resources
3-
titleSuffix: Azure IoT Operations
4-
description: How to clean up observability resources in Azure IoT Operations.
3+
description: How to clean up shared and data collection observability resources from an existing installation in Azure IoT Operations.
54
author: timlt
65
ms.author: timlt
76
ms.topic: how-to
@@ -14,36 +13,36 @@ ms.date: 02/04/2024
1413
# Clean up observability resources
1514
This article shows how to clean up the observability resources in your cluster without removing the cluster itself.
1615

17-
## Delete shared resources
16+
## Delete resources
1817

19-
To uninstall the observability resources, navigate to the resource group where you installed the shared resources and delete the following resources:
18+
To uninstall the observability resources, complete the following steps.
2019

21-
- Azure Monitor Workspace
22-
- Azure Managed Grafana
23-
- Log Analytics Workspace
24-
- Container Insights Solution
20+
1. Navigate to the resource group where you installed the shared resources, and delete the following resources:
2521

26-
For a resource group with a single cluster connected, the following screenshot shows what the list of resources looks like:
27-
28-
:::image type="content" source="media/howto-clean-up-observability-resources/shared-resource-delete.png" alt-text="Screenshot that lists shared resources." lightbox="media/howto-clean-up-observability-resources/shared-resource-delete-expanded.png":::
22+
- Azure Monitor Workspace
23+
- Azure Managed Grafana
24+
- Log Analytics Workspace
25+
- Container Insights Solution
2926

30-
## Delete data collection resources
27+
For a resource group with a single cluster connected, the following screenshot shows what the list of resources looks like:
3128

32-
Next, navigate to the resource group where your cluster is located (if different from the resource group for the previous resources).
29+
:::image type="content" source="media/howto-clean-up-observability-resources/shared-resource-delete.png" alt-text="Screenshot that lists a set of shared resources." lightbox="media/howto-clean-up-observability-resources/shared-resource-delete-expanded.png":::
3330

34-
Delete the following five resources to complete the cleanup without removing the cluster itself:
35-
- The data collection endpoint
36-
- The two data collection rules (one ends with "logsDataCollectionRule" and the other ends with "metricsDataCollectionRule")
37-
- The two recording rule groups (one ends with "KubernetesRecordingRuleGroup" and the other ends with "NodeRecordingRuleGroup")
31+
1. Navigate to the resource group where your cluster is located (if different from the resource group for the previous resources). Delete the following resources:
3832

39-
> [!NOTE]
40-
> You might need to run the delete more than once for all resources to be successfully deleted.
33+
- The data collection endpoint
34+
- The two data collection rules (one ends with "logsDataCollectionRule" and the other ends with "metricsDataCollectionRule")
35+
- The two recording rule groups (one ends with "KubernetesRecordingRuleGroup" and the other ends with "NodeRecordingRuleGroup")
4136

42-
For a typical cluster resource group, the following screenshot shows what the list of resources looks like. The resources to delete are selected.
37+
> [!NOTE]
38+
> You might need to run the delete more than once for all resources to be successfully deleted.
4339
44-
:::image type="content" source="media/howto-clean-up-observability-resources/cluster-resource-delete.png" alt-text="Screenshot that lists shared resources to delete." lightbox="media/howto-clean-up-observability-resources/cluster-resource-delete-expanded.png":::
40+
For a typical cluster resource group, the following screenshot shows what the list of resources looks like. The resources to delete are selected.
41+
42+
:::image type="content" source="media/howto-clean-up-observability-resources/cluster-resource-delete.png" alt-text="Screenshot that lists several resources to delete." lightbox="media/howto-clean-up-observability-resources/cluster-resource-delete-expanded.png":::
4543

4644
## Delete the configuration from your cluster
45+
4746
Finally, you can remove the configuration that was installed on your cluster. To do that, run the following command:
4847

4948
```bash

articles/iot-operations/monitor/howto-configure-diagnostics.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
title: Configure MQ diagnostics service
3-
titleSuffix: Azure IoT MQ
4-
description: How to configure Azure IoT MQ diagnostics service.
3+
description: How to configure the Azure IoT MQ diagnostics service to create a Prometheus endpoint, and monitor the health of the system.
54
author: timlt
65
ms.author: timlt
76
ms.subservice: mq
8-
ms.topic: how-to
7+
ms.topic: concept-article
98
ms.custom:
109
- ignite-2023
11-
ms.date: 11/14/2023
10+
ms.date: 02/27/2024
1211

1312
#CustomerIntent: As an operator, I want to understand how to use observability and diagnostics
1413
#to monitor the health of the MQ service.
1514
---
1615

17-
# Configure Azure IoT MQ diagnostic service settings
16+
# Configure Azure IoT MQ Preview diagnostic service settings
1817

1918
Azure IoT MQ includes a diagnostics service that periodically self tests Azure IoT MQ components and emits metrics. Operators can use these metrics to monitor the health of the system. The diagnostics service provides a Prometheus endpoint for metrics from all IoT MQ components including Broker self-test metrics.
2019

@@ -37,7 +36,9 @@ The diagnostics service processes and collates diagnostic signals from various A
3736
| openTelemetryTracesCollectorAddr | false | String | `null` | Endpoint URL of the OpenTelemetry collector |
3837
| staleDataTimeoutSeconds | false | Int32 | `600` | Data timeouts in seconds |
3938

40-
Here's an example of a Diagnostics service resource with basic configuration:
39+
## Example of a diagnostics service resource
40+
41+
Here's an example of a diagnostics service resource with basic configuration:
4142

4243
```yaml
4344
apiVersion: mq.iotoperations.azure.com/v1beta1

articles/iot-operations/monitor/howto-configure-observability-manual.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Configure observability manually
3-
titleSuffix: Azure IoT Operations
43
description: How to configure observability features manually in Azure IoT Operations so that you can monitor your solution.
54
author: timlt
65
ms.author: timlt

articles/iot-operations/monitor/howto-configure-observability.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Get started with observability
3-
titleSuffix: Azure IoT Operations
43
description: How to get started with configuring observability features in Azure IoT Operations so that you can monitor your solution.
54
author: timlt
65
ms.author: timlt
@@ -17,11 +16,11 @@ ms.date: 11/7/2023
1716

1817
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
1918

20-
Observability provides visibility into every layer of your Azure IoT Operations Preview configuration. It gives you insight into the actual behavior of issues, which increases the effectiveness of site reliability engineering. Azure IoT Operations offers observability through custom curated Grafana dashboards that are hosted in Azure. These dashboards are powered by Azure Monitor managed service for Prometheus and by Container Insights. This article shows you how to configure the services you need for observability.
19+
Observability provides visibility into every layer of your Azure IoT Operations configuration. It gives you insight into the actual behavior of issues, which increases the effectiveness of site reliability engineering. Azure IoT Operations offers observability through custom curated Grafana dashboards that are hosted in Azure. These dashboards are powered by Azure Monitor managed service for Prometheus and by Container Insights. This article shows you how to configure the services you need for observability.
2120

2221
## Prerequisites
2322

24-
- Azure IoT Operations Preview installed. For more information, see [Quickstart: Deploy Azure IoT Operations – to an Arc-enabled Kubernetes cluster](../get-started/quickstart-deploy.md).
23+
- Azure IoT Operations installed. For more information, see [Quickstart: Deploy Azure IoT Operations – to an Arc-enabled Kubernetes cluster](../get-started/quickstart-deploy.md).
2524

2625
## Configure your subscription
2726

0 commit comments

Comments
 (0)