Skip to content

Commit 8926120

Browse files
authored
Merge pull request #208030 from msjasteppe/iot-metrics-export
Major update to article.
2 parents e3474b4 + 30c627c commit 8926120

13 files changed

+55
-32
lines changed

articles/healthcare-apis/iot/iot-metrics-diagnostics-export.md

Lines changed: 55 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,88 @@ author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: iomt
88
ms.topic: how-to
9-
ms.date: 07/22/2022
9+
ms.date: 08/17/2022
1010
ms.author: jasteppe
1111
---
1212

1313
# How to configure diagnostic settings for exporting the MedTech service metrics
1414

15-
In this article, you'll learn how to configure the diagnostic setting for the MedTech service to export metrics to different destinations (for example: to Azure storage or an event hub) for audit, analysis, or backup.
15+
In this article, you'll learn how to configure diagnostic settings for the MedTech service to export metrics to different destinations (for example: to [Azure storage](/azure/storage/) or an [Azure event hub](/azure/event-hubs/)) for audit, analysis, or backup.
1616

17-
## Create diagnostic setting for the MedTech service
18-
1. To enable metrics export for the MedTech service, select **MedTech service** in your workspace.
17+
## Create a diagnostic setting for the MedTech service
18+
1. To enable metrics export for your MedTech service, select **MedTech service** in your workspace under **Services**.
1919

20-
:::image type="content" source="media/iot-metrics-export/iot-connector-logging-workspace.png" alt-text="Screenshot of select the MedTech service within workspace." lightbox="media/iot-metrics-export/iot-connector-logging-workspace.png":::
20+
:::image type="content" source="media/iot-metrics-export/iot-select-medtech-service-in-workspace.png" alt-text="Screenshot of select the MedTech service within workspace." lightbox="media/iot-metrics-export/iot-select-medtech-service-in-workspace.png":::
2121

22-
2. Select the MedTech service that you want to configure metrics export for.
22+
2. Select the MedTech service that you want to configure for metrics exporting. For this example, we'll be using a MedTech service named **mt-azuredocsdemo**. You'll be selecting a MedTech service named by you within your Azure Health Data Services workspace.
2323

24-
:::image type="content" source="media/iot-metrics-export/iot-connector-logging-select-connector.png" alt-text="Screenshot of select the MedTech service for exporting metrics" lightbox="media/iot-metrics-export/iot-connector-logging-select-connector.png":::
24+
:::image type="content" source="media/iot-metrics-export/iot-select-medtech-service.png" alt-text="Screenshot of select the MedTech service for exporting metrics." lightbox="media/iot-metrics-export/iot-select-medtech-service.png":::
2525

26-
3. Select the **Diagnostic settings** button and then select the **+ Add diagnostic setting** button.
26+
3. Select the **Diagnostic settings** option under **Monitoring**.
2727

28-
:::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":::
28+
:::image type="content" source="media/iot-metrics-export/iot-select-diagnostic-settings.png" alt-text="Screenshot of select the Diagnostic settings." lightbox="media/iot-metrics-export/iot-select-diagnostic-settings.png":::
2929

30-
4. After the **+ Add diagnostic setting** page opens, enter a name in the **Diagnostic setting name** dialog box.
30+
4. Select the **+ Add diagnostic setting** option.
3131

32-
:::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":::
32+
:::image type="content" source="media/iot-metrics-export/iot-add-diagnostic-setting.png" alt-text="Screenshot of select the + Add diagnostic setting." lightbox="media/iot-metrics-export/iot-add-diagnostic-setting.png":::
3333

34-
5. Under **Destination details**, select the destination you want to use to export your MedTech service metrics to. In the above example, we've selected an Azure storage account.
34+
5. The **+ Add diagnostic setting** page will open, requiring configuration inputs from you.
3535

36-
Metrics can be exported to the following destinations:
36+
:::image type="content" source="media/iot-metrics-export/iot-select-diagnostic-setting-options.png" alt-text="Screenshot of diagnostic setting and required fields." lightbox="media/iot-metrics-export/iot-select-diagnostic-setting-options.png":::
3737

38-
|Destination|Description|
39-
|-----------|-----------|
40-
|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.|
41-
|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.|
42-
|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.|
43-
|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.|
38+
1. Enter a display name in the **Diagnostic setting name** box. For this example, we'll name it **MedTech_service_All_Metrics**. You'll enter a display name of your own choosing.
4439

45-
> [!Important]
46-
> 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.
40+
2. Under **Metrics**, select the **AllMetrics** option.
4741

48-
6. Select **AllMetrics**.
42+
> [!Note]
43+
>
44+
> The **AllMetrics** option is the only option available and will export all currently supported MedTech service metrics.
45+
>
46+
> To view a complete list of MedTech service metrics associated with **AllMetrics**, see [Supported metrics with Azure Monitor](../../azure-monitor/essentials/metrics-supported.md#microsofthealthcareapisworkspacesiotconnectors).
4947
50-
> [!Note]
51-
> To view a complete list of MedTech service metrics associated with **AllMetrics**, see [Supported metrics with Azure Monitor](../../azure-monitor/essentials/metrics-supported.md#microsofthealthcareapisworkspacesiotconnectors).
48+
3. Under **Destination details**, select the destination you want to use for your exported MedTech service metrics. In this example, we've selected an Azure storage account. You'll select a destination of your own choosing.
49+
50+
> [!Important]
51+
>
52+
> 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 see which resources are required.
53+
54+
Metrics can be exported to the following destinations:
55+
56+
|Destination|Description|
57+
|-----------|-----------|
58+
|Log Analytics workspace|Metrics are converted to log form. Sending the metrics to the Azure Monitor Logs store (which is searchable via Log Analytics) enables you to integrate them into queries, alerts, and visualizations with existing log data.|
59+
|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.|
60+
|Azure event hub|Sending logs and metrics to an event hub allows you to stream data to external systems such as third-party Security Information and Event Managements (SIEMs) and other Log Analytics solutions.|
61+
|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.|
5262

53-
7. Select **Save**.
63+
4. Select the **Save** option to save your diagnostic setting selections.
64+
65+
6. Once you've selected the **Save** option, the page will display a message that the diagnostic setting for your MedTech service has been saved successfully.
66+
67+
:::image type="content" source="media/iot-metrics-export/iot-successful-save-diagnostic-setting.png" alt-text="Screenshot of a successful diagnostic setting save." lightbox="media/iot-metrics-export/iot-successful-save-diagnostic-setting.png":::
5468

5569
> [!Note]
56-
> It might take up to 15 minutes for the first MedTech service metrics to display in the destination of your choice.
57-
58-
For more information about how to work with diagnostics logs, see the [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md).
70+
>
71+
> It might take up to 15 minutes for the first MedTech service metrics to display in the destination of your choice.
5972
60-
## Conclusion
61-
Having access to the MedTech service metrics is essential for monitoring and troubleshooting. The MedTech service allows you to do these actions through the export of metrics.
73+
7. To view your saved diagnostic setting, select **Diagnostic settings**.
74+
75+
:::image type="content" source="media/iot-metrics-export/iot-navigate-to-diagnostic-settings.png" alt-text="Screenshot of Diagnostic settings option to view the saved diagnostic setting." lightbox="media/iot-metrics-export/iot-navigate-to-diagnostic-settings.png":::
76+
77+
8. The **Diagnostic settings** page will open, displaying your newly created diagnostic setting for your MedTech service. You'll have the ability to:
78+
79+
1. **Edit setting**: Edit or delete your saved MedTech service diagnostic setting.
80+
2. **+ Add diagnostic setting**: Create more diagnostic settings for your MedTech service (for example: you may also want to send your MedTech service metrics to another destination like a Logs Analytics workspace).
81+
82+
:::image type="content" source="media/iot-metrics-export/iot-view-diagnostic-settings.png" alt-text="Screenshot of Diagnostic settings options." lightbox="media/iot-metrics-export/iot-view-diagnostic-settings.png":::
83+
84+
> [!TIP]
85+
>
86+
> For more information about how to work with diagnostic logs, see the [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md).
6287
6388
## Next steps
6489

6590
To view the frequently asked questions (FAQs) about the MedTech service, see
6691

6792
>[!div class="nextstepaction"]
6893
>[MedTech service FAQs](iot-connector-faqs.md)
69-
70-
(FHIR®) is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.
79.8 KB
Loading
66.5 KB
Loading
71.8 KB
Loading
97.7 KB
Loading
144 KB
Loading

0 commit comments

Comments
 (0)