|
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: Configure IoT connector Diagnostic settings for metrics export - Azure Healthcare APIs |
| 3 | +description: This article explains how to configure IoT connector Diagnostic settings for metrics exporting. |
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 | +# Configure diagnostic setting for IoT connector metrics exporting |
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 configure the diagnostic setting for IoT connector to export metrics to different destinations for audit, analysis, or backup. |
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 | +## Create diagnostic setting for IoT connector |
| 21 | +1. To enable metrics export for IoT connector, select **IoT connectors** in your Workspace. |
| 22 | + |
| 23 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-workspace.png" alt-text="Screenshot of select IoT connector within Workspace." lightbox="media/iot-metrics-export/iot-connector-logging-workspace.png"::: |
| 24 | + |
| 25 | +2. Select the IoT connector that you want to configure metrics export for. |
| 26 | + |
| 27 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-connector.png" alt-text="Screenshot of select IoT connector for exporting metrics" lightbox="media/iot-metrics-export/iot-connector-logging-select-connector.png"::: |
| 28 | + |
| 29 | +3. Select the **Diagnostic settings** button and then select the **+ Add diagnostic setting** button. |
22 | 30 |
|
23 |
| -2. Navigate to **Diagnostic settings** |
| 31 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-diagnostic-settings.png" alt-text="Screenshot of select the Diagnostic settings and select the + Add diagnostic setting buttons." lightbox="media/iot-metrics-export/iot-connector-logging-select-diagnostic-settings.png"::: |
24 | 32 |
|
25 |
| -3. Select **+ Add diagnostic setting** |
| 33 | +4. After the **+ Add diagnostic setting** page opens, enter a name in the **Diagnostic setting name** dialog box. |
26 | 34 |
|
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"::: |
| 35 | + :::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-diagnostic-configuration.png" alt-text="Screenshot diagnostic setting and required fields." lightbox="media/iot-metrics-export/iot-connector-logging-select-diagnostic-configuration.png"::: |
28 | 36 |
|
29 |
| -4. Enter a name in the **Diagnostic setting name** dialog box. |
| 37 | +5. Under **Destination details**, select the destination you want to use to export your IoT connector metrics to. In the above example, we've selected an Azure storage account. |
30 | 38 |
|
31 |
| -5. Select the method you want to use to access your diagnostic logs: |
| 39 | + Metrics can be exported to the following destinations: |
32 | 40 |
|
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. |
| 41 | + |Destination|Description| |
| 42 | + |-----------|-----------| |
| 43 | + |Log Analytics workspace|Metrics are converted to log form. This option may not be available for all resource types. Sending them to the Azure Monitor Logs store (which is searchable via Log Analytics) helps you to integrate them into queries, alerts, and visualizations with existing log data.| |
| 44 | + |Azure storage account|Archiving logs and metrics to an Azure storage account is useful for audit, static analysis, or backup. Compared to Azure Monitor Logs and a Log Analytics workspace, Azure storage is less expensive and logs can be kept there indefinitely.| |
| 45 | + |Event Hubs|Sending logs and metrics to Event Hubs allows you to stream data to external systems such as third-party SIEMs and other Log Analytics solutions.| |
| 46 | + |Azure Monitor partner integrations|Specialized integrations between Azure Monitor and other non-Microsoft monitoring platforms. Useful when you're already using one of the partners.| |
| 47 | + |
| 48 | + > [!Important] |
| 49 | + > Each **Destination details** selection requires that certain resources (for example, an existing Azure storage account) be created and available before the selection can be successfully configured. Choose each selection to get a list of the required resources. |
36 | 50 |
|
37 |
| -6. Select **Errors, Traffic, and Latency** for IoT connector. Select any extra metric categories you want to capture for the FHIR service. |
| 51 | +6. Select **AllMetrics**. |
38 | 52 |
|
39 |
| -7. Select **Save** |
| 53 | + > [!Note] |
| 54 | + > To view a complete list of IoT connector metrics associated with **AllMetrics**, see [Supported metrics with Azure Monitor](/azure/azure-monitor/essentials/metrics-supported#microsofthealthcareapisworkspacesiotconnectors). |
40 | 55 |
|
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"::: |
| 56 | +7. Select **Save**. |
42 | 57 |
|
43 |
| -> [!Note] |
44 |
| -> It might take up to 15 minutes for the first Metrics logs to display in the repository of your choice. |
| 58 | + > [!Note] |
| 59 | + > It might take up to 15 minutes for the first IoT connector metrics to display in the destination of your choice. |
45 | 60 |
|
46 |
| -For more information about how to work with diagnostic logs, see the [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md) |
| 61 | +For more information about how to work with diagnostics logs, see the [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md). |
47 | 62 |
|
48 | 63 | ## Conclusion
|
49 |
| -Having access to Metrics logs is essential for monitoring and troubleshooting. IoT connector allows you to do these actions through Metrics logs. |
| 64 | +Having access to metrics is essential for monitoring and troubleshooting. IoT connector allows you to do these actions through the export of metrics. |
50 | 65 |
|
51 | 66 | ## Next steps
|
52 | 67 |
|
53 |
| -Check out frequently asked questions about IoT connector. |
| 68 | +To view the frequently asked questions (FAQs) about IoT connector, see |
54 | 69 |
|
55 | 70 | >[!div class="nextstepaction"]
|
56 | 71 | >[IoT connector FAQs](iot-connector-faqs.md)
|
|
0 commit comments