|
1 | 1 | ---
|
2 |
| -title: Export IoT connector Metrics through Diagnostic settings - Azure Healthcare APIs |
3 |
| -description: This article explains how to export IoT connector metrics through Diagnostic settings |
| 2 | +title: Enable IoT connector metrics logging through Diagnostic settings - Azure Healthcare APIs |
| 3 | +description: This article explains how to log IoT connector metrics through Diagnostic settings |
4 | 4 | services: healthcare-apis
|
5 | 5 | author: msjasteppe
|
6 | 6 | ms.service: healthcare-apis
|
7 | 7 | ms.subservice: iomt
|
8 | 8 | ms.topic: how-to
|
9 |
| -ms.date: 11/10/2021 |
| 9 | +ms.date: 1/20/2021 |
10 | 10 | ms.author: jasteppe
|
11 | 11 | ---
|
12 | 12 |
|
13 |
| -# Export IoT connector Metrics through Diagnostic settings |
| 13 | +# Enable IoT connector metrics through Diagnostic settings |
14 | 14 |
|
15 | 15 | > [!IMPORTANT]
|
16 | 16 | > Azure Healthcare APIs is currently in PREVIEW. The [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
|
17 | 17 |
|
18 |
| -In this article, you'll learn how to export IoT connector Metrics logs. The feature that enables Metrics logging is the [**Diagnostic settings**](../../azure-monitor/essentials/diagnostic-settings.md) in the Azure portal. |
| 18 | +In this article, you'll learn how to enable IoT connector metrics logs. The feature that enables metrics logging is the [**Diagnostic settings**](../../azure-monitor/essentials/diagnostic-settings.md) in the Azure portal. |
19 | 19 |
|
20 |
| -## Enable Metrics logging for IoT connector |
21 |
| -1. To enable Metrics logging for the IoT connector, select your Fast Healthcare Interoperability Resources (FHIR®) service in the Azure portal. |
| 20 | +## Enable metrics logging exporting for IoT connector |
| 21 | +1. To enable metrics logging for IoT connector, select **IoT connector** in your Workspace. |
| 22 | + |
| 23 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-workspace.png" alt-text="Select IoT connector within Workspace" lightbox="media/iot-metrics-export/iot-connector-logging-workspace.png"::: |
22 | 24 |
|
23 |
| -2. Navigate to **Diagnostic settings** |
| 25 | +2. Select the IoT connector that you want to enable metrics logging for. |
| 26 | + |
| 27 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-connector.png" alt-text="Select IoT connector for enabling logging" lightbox="media/iot-metrics-export/iot-connector-logging-select-connector.png"::: |
24 | 28 |
|
25 |
| -3. Select **+ Add diagnostic setting** |
| 29 | +3. Select the **Diagnostic settings** button and then select the **+ Add diagnostic setting** button. |
26 | 30 |
|
27 |
| - :::image type="content" source="media/iot-metrics-export/diagnostic-settings-main.png" alt-text="IoT connector1" lightbox="media/iot-metrics-export/diagnostic-settings-main.png"::: |
| 31 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-diagnostic-settings.png" alt-text="Select the Diagnostic settings and select the + Add diagnostic setting buttons." lightbox="media/iot-metrics-export/iot-connector-logging-select-diagnostic-settings.png"::: |
28 | 32 |
|
29 | 33 | 4. Enter a name in the **Diagnostic setting name** dialog box.
|
30 | 34 |
|
31 |
| -5. Select the method you want to use to access your diagnostic logs: |
| 35 | +5. Under **Destination details**, select the method you want to use to access your diagnostic logs. In this example, we have selected an Azure storage account. |
| 36 | + |
| 37 | +> [!Important] |
| 38 | +> Each **Destination details** selection requires that certain resources (for example: an existing storage account) be created and available before the selection can be successfully configured. Click each selection to get a list of required resources. |
32 | 39 |
|
33 |
| - 1. **Archive to a storage account** for auditing or manual inspection. The storage account you want to use needs to be already created. |
34 |
| - 2. **Stream to Event Hub** for ingestion by a third-party service or custom analytic solution. You'll need to create an Event Hub namespace and Event Hub policy before you can configure this step. |
35 |
| - 3. **Stream to the Log Analytics** workspace in Azure Monitor. You'll need to create your Logs Analytics Workspace before you can select this option. |
| 40 | +6. Select **Allmetrics** |
36 | 41 |
|
37 |
| -6. Select **Errors, Traffic, and Latency** for IoT connector. Select any extra metric categories you want to capture for the FHIR service. |
| 42 | +> [!Note] |
| 43 | +> **Allmetrics** contains the following IoT connector metrics: |
| 44 | +> * TotalErrors |
| 45 | +> * DeviceEvent |
| 46 | +> * NormalizedEvent |
| 47 | +> * Measurement |
| 48 | +> * MeasurementGroup |
| 49 | +> * DeviceEventProcessingLatencyMs (Ms = millisecond) |
| 50 | +> * MeasurementIngestionLatencyMs (Ms = millisecond) |
38 | 51 |
|
39 | 52 | 7. Select **Save**
|
40 | 53 |
|
41 |
| - :::image type="content" source="media/iot-metrics-export/diagnostic-setting-add.png" alt-text="IoT connector2" lightbox="media/iot-metrics-export/diagnostic-setting-add.png"::: |
| 54 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-diagnostic-configuration.png" alt-text="Provide a name for your logs, where you want the logs to be sent, ALLMetrics, and save" lightbox="media/iot-metrics-export/iot-connector-logging-select-diagnostic-configuration.png"::: |
42 | 55 |
|
43 | 56 | > [!Note]
|
44 |
| -> It might take up to 15 minutes for the first Metrics logs to display in the repository of your choice. |
| 57 | +> It might take up to 15 minutes for the first metrics logs to display in the destination of your choice. |
45 | 58 |
|
46 | 59 | For more information about how to work with diagnostic logs, see the [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md)
|
47 | 60 |
|
48 | 61 | ## Conclusion
|
49 |
| -Having access to Metrics logs is essential for monitoring and troubleshooting. IoT connector allows you to do these actions through Metrics logs. |
| 62 | +Having access to metrics logs is essential for monitoring and troubleshooting. IoT connector allows you to do these actions through metrics logging. |
50 | 63 |
|
51 | 64 | ## Next steps
|
52 | 65 |
|
53 |
| -Check out frequently asked questions about IoT connector. |
| 66 | +Check out frequently asked questions (FAQs) about IoT connector. |
54 | 67 |
|
55 | 68 | >[!div class="nextstepaction"]
|
56 | 69 | >[IoT connector FAQs](iot-connector-faqs.md)
|
|
0 commit comments