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/iot-operations/connect-to-cloud/howto-configure-opentelemetry-endpoint.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Configure OpenTelemetry dataflow endpoints in Azure IoT Operations (preview)
3
-
description: Learn how to configure dataflow endpoints for OpenTelemetry destinations to send metrics and logs to observability platforms.
2
+
title: Configure OpenTelemetry data flow endpoints in Azure IoT Operations (preview)
3
+
description: Learn how to configure data flow endpoints for OpenTelemetry destinations to send metrics and logs to observability platforms.
4
4
author: PatAltimore
5
5
ms.author: patricka
6
6
ms.service: azure-iot-operations
@@ -9,14 +9,14 @@ ms.topic: how-to
9
9
ms.date: 07/24/2025
10
10
ai-usage: ai-assisted
11
11
12
-
#CustomerIntent: As an operator, I want to understand how to configure dataflow endpoints for OpenTelemetry destinations in Azure IoT Operations so that I can send metrics and logs to observability platforms like Grafana and Azure Monitor.
12
+
#CustomerIntent: As an operator, I want to understand how to configure data flow endpoints for OpenTelemetry destinations in Azure IoT Operations so that I can send metrics and logs to observability platforms like Grafana and Azure Monitor.
OpenTelemetry dataflow endpoints are used to send metrics and logs to OpenTelemetry collectors, which can then forward the data to observability platforms like Grafana dashboards and Azure Monitor. You can configure the endpoint settings, authentication, Transport Layer Security (TLS), and batching options.
19
+
OpenTelemetry data flow endpoints are used to send metrics and logs to OpenTelemetry collectors, which can then forward the data to observability platforms like Grafana dashboards and Azure Monitor. You can configure the endpoint settings, authentication, Transport Layer Security (TLS), and batching options.
20
20
21
21
## Prerequisites
22
22
@@ -29,7 +29,7 @@ OpenTelemetry endpoints enable you to export telemetry data from Azure IoT Opera
29
29
30
30
### Common scenarios
31
31
32
-
- Device diagnostics: Export temperature, pressure, and other sensor readings as metrics for monitoring device health
32
+
- Device diagnostics: Export temperature, pressure, and other sensor readings as metrics to monitor device health
33
33
- Factory monitoring: Send production line telemetry to Grafana dashboards for operational visibility
34
34
- System observability: Forward application logs and metrics to Azure Monitor for centralized monitoring
35
35
- Custom metrics: Add contextual attributes like factory ID or location to metrics for better filtering and analysis
@@ -38,7 +38,7 @@ OpenTelemetry endpoints enable you to export telemetry data from Azure IoT Opera
38
38
39
39
OpenTelemetry endpoints require data to conform to a specific JSON schema with either a `metrics` array, a `logs` array, or both. Messages that don't conform to this schema are dropped and acknowledged to prevent message loss.
40
40
41
-
The JSON payload must have this top-level structure:
41
+
The JSON payload must use this top-level structure:
42
42
43
43
```json
44
44
{
@@ -98,8 +98,8 @@ Each attribute in the `attributes` array must have:
98
98
Each log object in the `logs` array must contain the following fields:
99
99
100
100
Required fields:
101
-
-`value` (string): The log message content
102
-
-`level` (string): The log level (see [supported log levels](#supported-log-levels))
101
+
-`value` (string): Log message content
102
+
-`level` (string): Log level (see [supported log levels](#supported-log-levels))
103
103
104
104
Optional fields:
105
105
-`timestamp` (number): Unix epoch timestamp in nanoseconds when the log was recorded
@@ -136,15 +136,15 @@ Each attribute in the `attributes` array must have:
136
136
The following OpenTelemetry metric types are supported:
- Histograms: `f64_histogram`, `u64_histogram` - Distribution of values
142
142
143
143
### Supported log levels
144
144
145
145
The following log levels are supported:
146
146
-`trace`
147
-
-`debug`
147
+
-`debug`
148
148
-`info`
149
149
-`warn`
150
150
-`error`
@@ -156,7 +156,7 @@ You can create an OpenTelemetry dataflow endpoint using Bicep or Kubernetes.
156
156
157
157
# [Bicep](#tab/bicep)
158
158
159
-
Create a Bicep `.bicep` file with the following content. Update the settings as needed, and replace the placeholder values like `<AIO_INSTANCE_NAME>` with your own.
159
+
Create a Bicep `.bicep` file with the following content. Update the settings as needed, and replace the placeholder values like `<AIO_INSTANCE_NAME>` with your values.
OpenTelemetry endpoints support several authentication methods to securely connect to collectors.
260
+
OpenTelemetry endpoints support several authentication methods to connect securely to collectors.
261
261
262
262
#### Service Account Token (SAT)
263
263
264
-
Service Account Token authentication uses Kubernetes service account tokens for authentication with the OpenTelemetry collector.
264
+
Service account token (SAT) authentication uses Kubernetes service account tokens to authenticate with the OpenTelemetry collector.
265
265
266
-
Configuration: Replace `<OTEL_AUDIENCE>` with the appropriate audience value for your OpenTelemetry collector configuration. This value must match the expected audience configured on the collector side.
266
+
Replace `<OTEL_AUDIENCE>` with the audience value for your OpenTelemetry collector configuration. This value must match the expected audience on the collector.
267
267
268
268
# [Bicep](#tab/bicep)
269
269
@@ -313,7 +313,7 @@ authentication:
313
313
314
314
---
315
315
316
-
Before using X.509 certificate authentication, create a Kubernetes secret with your client certificate:
316
+
Before you use X.509 certificate authentication, create a Kubernetes secret with your client certificate:
317
317
318
318
```bash
319
319
kubectl create secret tls <X509_SECRET_NAME> \
@@ -414,8 +414,8 @@ batching:
414
414
415
415
| Property | Description | Default |
416
416
|----------|-------------|---------|
417
-
| `latencySeconds` | Maximum time to wait before sending a batch | 60 seconds |
418
-
| `maxMessages` | Maximum number of messages in a batch | 100000 messages |
417
+
| `latencySeconds` | Maximum time to wait before sending a batch. | 60 seconds |
418
+
| `maxMessages` | Maximum number of messages in a batch. | 100000 messages |
419
419
420
420
## Error handling and troubleshooting
421
421
@@ -431,10 +431,10 @@ Common validation errors:
431
431
432
432
### Delivery guarantees
433
433
434
-
The OpenTelemetry endpoint provides delivery guarantees to the collector itself, but not to upstream services that the collector may forward data to. Once data reaches the collector, Azure IoT Operations has no visibility into whether it successfully reaches the final destination.
434
+
The OpenTelemetry endpoint provides delivery guarantees to the collector itself, but not to upstream services that the collector can forward data to. Once data reaches the collector, Azure IoT Operations doesn't have visibility into whether it reaches the final destination.
Copy file name to clipboardExpand all lines: articles/iot-operations/manage-mqtt-broker/howto-configure-authentication.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -772,7 +772,7 @@ With Azure Device Registry integration enabled:
772
772
- Device status is checked upon client authentication and every 10 minutes thereafter.
773
773
- Disabled or removed devices are automatically denied access.
774
774
775
-
Before enabling this feature, you must create corresponding devices in the Azure Device Registry for each client certificate. The device name must match the certificate's Common Name (CN). To create and manage devices in the Azure Device Registry, see:
775
+
Before you enable this feature, create a corresponding device in the Azure Device Registry for each client certificate. The device name must match the certificate's Common Name (CN). To create and manage devices in the Azure Device Registry, see:
776
776
- [Use the operations experience to manage resources such as assets, devices, and data flows](../discover-manage-assets/howto-manage-assets-devices.md)
777
777
- [Understand assets and devices](../discover-manage-assets/concept-assets-devices.md)
778
778
@@ -842,7 +842,7 @@ spec:
842
842
843
843
---
844
844
845
-
After enabling Azure Device Registry integration, you must create corresponding devices in the Azure Device Registry for each client certificate. The device name must match the certificate's Common Name (CN). If a client attempts to authenticate with a certificate that doesn't have a matching enabled device in the registry, authentication fails.
845
+
After you enable Azure Device Registry integration, create a corresponding device in the Azure Device Registry for each client certificate. The device name must match the certificate's Common Name (CN). If a client tries to authenticate with a certificate that doesn't have a matching enabled device in the registry, authentication fails.
846
846
847
847
### Enable X.509 authentication for a listener port
0 commit comments