Skip to content

Commit bc36dae

Browse files
Merge pull request #289255 from kgremban/m3-observ
Observability fixes
2 parents a92d3ec + de34d16 commit bc36dae

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Define and deploy an [OpenTelemetry (OTel) Collector](https://opentelemetry.io/d
123123
endpoint: ':8889'
124124
resource_to_telemetry_conversion:
125125
enabled: true
126+
add_metric_suffixes: false
126127
service:
127128
extensions:
128129
- health_check
@@ -158,7 +159,7 @@ Define and deploy an [OpenTelemetry (OTel) Collector](https://opentelemetry.io/d
158159
enabled: false
159160
```
160161
161-
1. In the `otel-collector-values.yaml` file, make a note of the following values that you use in the `az iot ops init` command when you deploy Azure IoT Operations on the cluster:
162+
1. In the `otel-collector-values.yaml` file, make a note of the following values that you use in the `az iot ops create` command when you deploy Azure IoT Operations on the cluster:
162163

163164
* **fullnameOverride**
164165
* **grpc.endpoint**
@@ -234,11 +235,11 @@ Configure Prometheus metrics collection on your cluster.
234235

235236
## Deploy dashboards to Grafana
236237

237-
Azure IoT Operations provides a [collection of dashboards](https://github.com/Azure/azure-iot-operations/tree/main/samples/grafana-dashboards) designed to give you many of the visualizations you need to understand the health and performance of your Azure IoT Operations deployment.
238+
Azure IoT Operations provides a [sample dashboard](https://github.com/Azure/azure-iot-operations/tree/main/samples/grafana-dashboard) designed to give you many of the visualizations you need to understand the health and performance of your Azure IoT Operations deployment.
238239

239240
Complete the following steps to install the Azure IoT Operations curated Grafana dashboards.
240241

241-
1. Clone or download the **azure-iot-operations** repository to get the sample Grafana Dashboard json files locally: [https://github.com/Azure/azure-iot-operations](https://github.com/Azure/azure-iot-operations).
242+
1. Clone or download the **azure-iot-operations** repository to get the sample Grafana Dashboard json file locally: [https://github.com/Azure/azure-iot-operations](https://github.com/Azure/azure-iot-operations).
242243

243244
1. Sign in to the Grafana console. You can access the console through the Azure portal or use the `az grafana show` command to retrieve the URL.
244245

@@ -250,7 +251,7 @@ Complete the following steps to install the Azure IoT Operations curated Grafana
250251

251252
1. Select **Import dashboard**.
252253

253-
1. Browse to the sample dashboards directory in your local copy of the Azure IoT Operations repository, **azure-iot-operations** > **samples** > **grafana-dashboards**, then select a JSON dashboard file.
254+
1. Browse to the sample dashboard directory in your local copy of the Azure IoT Operations repository, **azure-iot-operations** > **samples** > **grafana-dashboard**, then select the `aio.sample.json` dashboard file.
254255

255256
1. When the application prompts, select your managed Prometheus data source.
256257

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -144,20 +144,20 @@ Use these steps if you chose the **Test settings** option on the **Dependency ma
144144
145145
1. Prepare the cluster for Azure IoT Operations deployment. Copy and run the provided [az iot ops init](/cli/azure/iot/ops#az-iot-ops-init) command.
146146
147-
If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `init` command:
148-
149-
| Optional parameter | Value | Description |
150-
| --------- | ----- | ----------- |
151-
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.enpoint=4317**. |
152-
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
153-
154147
>[!TIP]
155148
>The `init` command only needs to be run once per cluster. If you're reusing a cluster that already had Azure IoT Operations version 0.8.0 deployed on it, you can skip this step.
156149
157150
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
158151
159152
1. Deploy Azure IoT Operations. Copy and run the provided [az iot ops create](/cli/azure/iot/ops#az-iot-ops-create) command.
160153
154+
If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `create` command:
155+
156+
| Optional parameter | Value | Description |
157+
| --------- | ----- | ----------- |
158+
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.enpoint=4317**. |
159+
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
160+
161161
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
162162
163163
1. Once all of the Azure CLI commands complete successfully, you can close the **Install Azure IoT Operations** wizard.
@@ -209,20 +209,20 @@ Use these steps if you chose the **Secure settings** option on the **Dependency
209209
210210
1. Prepare the cluster for Azure IoT Operations deployment. Copy and run the provided [az iot ops init](/cli/azure/iot/ops#az-iot-ops-init) command.
211211
212-
If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `init` command:
213-
214-
| Optional parameter | Value | Description |
215-
| --------- | ----- | ----------- |
216-
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.enpoint=4317**. |
217-
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
218-
219212
>[!TIP]
220213
>The `init` command only needs to be run once per cluster. If you're reusing a cluster that already had Azure IoT Operations version 0.8.0 deployed on it, you can skip this step.
221214
222215
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
223216
224217
1. Deploy Azure IoT Operations. Copy and run the provided [az iot ops create](/cli/azure/iot/ops#az-iot-ops-create) command.
225218
219+
If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `create` command:
220+
221+
| Optional parameter | Value | Description |
222+
| --------- | ----- | ----------- |
223+
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.enpoint=4317**. |
224+
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
225+
226226
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
227227
228228
1. Enable secret sync for the deployed Azure IoT Operations instance. Copy and run the provided [az iot ops secretsync enable](/cli/azure/iot/ops/secretsync#az-iot-ops-secretsync-enable) command.

0 commit comments

Comments
 (0)