Skip to content

Commit d2b5a56

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into rolyon-includes-active-directory-cleanup-v15
2 parents 6a4064c + 0d21d94 commit d2b5a56

File tree

8 files changed

+234
-38
lines changed

8 files changed

+234
-38
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Add a cluster
3+
description: How to add an Arc-enabled cluster to existing observability infrastructure in Azure IoT Operations.
4+
author: timlt
5+
ms.author: timlt
6+
ms.topic: how-to
7+
ms.date: 02/27/2024
8+
9+
# CustomerIntent: As an IT admin or operator, I want to add more Arc-enabled clusters
10+
# to my existing observability infrastructure.
11+
---
12+
13+
# Add an Arc-enabled cluster to existing observability infrastructure
14+
15+
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
16+
17+
You can share observability resources across multiple Arc-enabled clusters that run Azure IoT Operations. This article shows how to add another Arc-enabled cluster to the observability infrastructure that you created in [Get started: configure observability](howto-configure-observability.md).
18+
19+
## Prerequisites
20+
21+
- Azure IoT Operations installed. For more information, see [Get started: configure observability](howto-configure-observability.md).
22+
23+
## Add an Arc-enabled cluster
24+
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).
25+
26+
Specify the resource group and name of the new Arc enabled cluster in the `resource-group` and `cluster-name` parameters:
27+
28+
```azurecli
29+
az deployment group create \
30+
--subscription <cluster-subscription-id> \
31+
--resource-group <cluster-resource-group> \
32+
--template-file cluster.bicep \
33+
--parameters clusterName=<cluster-name> \
34+
azureMonitorId=<azure-monitor-resource-id> \
35+
logAnalyticsId=<log-analytics-resource-id>
36+
```
37+
38+
If Azure Monitor or Log Analytics is in a different region from your cluster, the previous command produces an error. To resolve the error, pass the extra `azureMonitorLocation` and `logAnalyticsLocation` parameters:
39+
40+
```azurecli
41+
az deployment group create \
42+
--subscription <cluster-subscription-id> \
43+
--resource-group <cluster-resource-group> \
44+
--template-file cluster.bicep \
45+
--parameters clusterName=<cluster-name> \
46+
azureMonitorId=<azure-monitor-resource-id> \
47+
logAnalyticsId=<log-analytics-resource-id> \
48+
azureMonitorLocation=<azure-monitor-location> \
49+
logAnalyticsLocation=<log-analytics-location>
50+
```
51+
52+
To set up Prometheus metrics collection for the new Arc enabled cluster, follow the steps in [Configure Prometheus metrics collection](howto-configure-observability.md#configure-prometheus-metrics-collection).
53+
54+
## Access Grafana dashboards
55+
56+
Navigate to the endpoint for the Grafana instance that you created previously in [Get started: configure observability](howto-configure-observability.md). If you didn't already do so, create the relevant dashboards by going to the [dashboard list](https://github.com/Azure/azure-iot-operations/tree/main/samples/grafana-dashboards). In the dashboards, you see the name of the new Arc-enabled cluster in the **Cluster** selector dropdown.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Clean up observability resources
3+
description: How to clean up shared and data collection observability resources from an existing installation in Azure IoT Operations.
4+
author: timlt
5+
ms.author: timlt
6+
ms.topic: how-to
7+
ms.date: 02/27/2024
8+
9+
# CustomerIntent: As an IT admin or operator, I want to be able to clean up and remove
10+
# observability resources installed on my cluster, without removing the cluster.
11+
---
12+
13+
# Clean up observability resources
14+
This article shows how to clean up the observability resources in your cluster without removing the cluster itself.
15+
16+
## Delete resources
17+
18+
To uninstall the observability resources, complete the following steps.
19+
20+
1. Navigate to the resource group where you installed the shared resources, and delete the following resources:
21+
22+
- Azure Monitor Workspace
23+
- Azure Managed Grafana
24+
- Log Analytics Workspace
25+
- Container Insights Solution
26+
27+
For a resource group with a single cluster connected, the following screenshot shows what the list of resources looks like:
28+
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":::
30+
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:
32+
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")
36+
37+
> [!NOTE]
38+
> You might need to run the delete more than once for all resources to be successfully deleted.
39+
40+
## Delete the configuration from your cluster
41+
42+
Finally, you can remove the configuration that was installed on your cluster. To do that, run the following command:
43+
44+
```bash
45+
kubectl delete -f ama-metrics-prometheus-config.yaml
46+
```
47+
48+
## Related content
49+
50+
- [Get started: configure observability](howto-configure-observability.md)
51+
- [How to configure observability manually](howto-configure-observability-manual.md)

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
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Configure observability manually
3+
description: How to configure observability features manually in Azure IoT Operations so that you can monitor your solution.
4+
author: timlt
5+
ms.author: timlt
6+
ms.topic: how-to
7+
ms.date: 02/27/2024
8+
9+
# CustomerIntent: As an IT admin or operator, I want to monitor and visualize data
10+
# on the health of my industrial assets and edge environment.
11+
---
12+
13+
# Configure observability manually
14+
15+
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
16+
17+
This article shows how to install and configure Azure IoT Operations observability components manually. This approach provides more options and control over your environment. For a simplified setup process that installs all the components you need to get started, see [Get started: configure observability](howto-configure-observability.md).
18+
19+
## Configure your subscription
20+
21+
Run the following code to register providers with the subscription where your cluster is located:
22+
23+
```azurecli
24+
az account set -s <subscription-id>
25+
az provider register -n "Microsoft.Insights"
26+
az provider register -n "Microsoft.AlertsManagement"
27+
```
28+
29+
## Install Azure Monitor managed service for Prometheus
30+
Azure Monitor managed service for Prometheus is a component of Azure Monitor Metrics. This managed service provides flexibility in the types of metric data that you can collect and analyze with Azure Monitor. Prometheus metrics share some features with platform and custom metrics. Prometheus metrics also use some different features to better support open source tools such as PromQL and Grafana.
31+
32+
Azure Monitor managed service for Prometheus allows you to collect and analyze metrics at scale using a Prometheus-compatible monitoring solution. This fully managed service is based on the Prometheus project from the Cloud Native Computing Foundation (CNCF). The service allows you to use the Prometheus query language (PromQL) to analyze and alert on the performance of monitored infrastructure and workloads, without having to operate the underlying infrastructure.
33+
34+
To set up Prometheus metrics collection for the new Arc-enabled cluster, follow the steps in [Configure Prometheus metrics collection](howto-configure-observability.md#configure-prometheus-metrics-collection).
35+
36+
## Install Container Insights
37+
Container Insights monitors the performance of container workloads deployed to the cloud. It gives you performance visibility by collecting memory and processor metrics from controllers, nodes, and containers that are available in Kubernetes through the Metrics API. After you enable monitoring from Kubernetes clusters, metrics and container logs are automatically collected through a containerized version of the Log Analytics agent for Linux. Metrics are sent to the metrics database in Azure Monitor. Log data is sent to your Log Analytics workspace.
38+
39+
To monitor container workload performance, complete the steps to [enable container insights](../../azure-monitor/containers/container-insights-onboard.md).
40+
41+
## Install Grafana
42+
Azure Managed Grafana is a data visualization platform built on top of the Grafana software by Grafana Labs. Azure Managed Grafana is a fully managed Azure service operated and supported by Microsoft. Grafana helps you bring together metrics, logs and traces into a single user interface. With its extensive support for data sources and graphing capabilities, you can view and analyze your application and infrastructure telemetry data in real-time.
43+
44+
Azure IoT Operations provides a collection of dashboards designed to give you many of the visualizations you need to understand the health and performance of your Azure IoT Operations deployment.
45+
46+
To install Azure Managed Grafana, complete the following steps:
47+
48+
1. Use the Azure portal to [create an Azure Managed Grafana instance](../../managed-grafana/quickstart-managed-grafana-portal.md).
49+
50+
1. Configure an [Azure Monitor managed service for Prometheus as a data source for Azure Managed Grafana](../../azure-monitor/essentials/prometheus-grafana.md).
51+
52+
1. Configure the dashboards by following the steps in [Deploy dashboards to Grafana](howto-configure-observability.md#deploy-dashboards-to-grafana).
53+
54+
## Related content
55+
56+
- [Get started: configure observability](howto-configure-observability.md)

0 commit comments

Comments
 (0)