|
1 | 1 | --- |
2 | | -title: Display MedTech service metrics logging - Azure Health Data Services |
3 | | -description: This article explains how to display MedTech service Metrics |
| 2 | +title: Display MedTech service metrics - Azure Health Data Services |
| 3 | +description: This article explains how to display MedTech service metrics. |
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: 03/22/2022 |
| 9 | +ms.date: 07/22/2022 |
10 | 10 | ms.author: jasteppe |
11 | 11 | --- |
12 | 12 |
|
13 | | -# How to display MedTech service metrics |
| 13 | +# How to display the MedTech service metrics |
14 | 14 |
|
15 | | -In this article, you'll learn how to display MedTech service metrics in the Azure portal. |
| 15 | +In this article, you'll learn how to display MedTech service metrics in the Azure portal and how to pin the MedTech service metrics tile to an Azure portal dashboard. |
16 | 16 |
|
17 | | -## Display metrics |
| 17 | +## Metric types for the MedTech service |
18 | 18 |
|
19 | | -1. Within your Azure Health Data Services workspace, select **MedTech service**. |
| 19 | +The MedTech service metrics that you can select and display are listed in the following table: |
20 | 20 |
|
21 | | - :::image type="content" source="media\iot-metrics\iot-workspace-displayed-with-connectors-button.png" alt-text="Screenshot of select the MedTech service button." lightbox="media\iot-metrics\iot-connectors-button.png"::: |
| 21 | +|Metric type|Metric purpose| |
| 22 | +|-----------|--------------| |
| 23 | +|Number of Incoming Messages|Displays the number of received raw incoming messages (for example, the device events).| |
| 24 | +|Number of Normalized Messages|Displays the number of normalized messages.| |
| 25 | +|Number of Message Groups|Displays the number of groups that have messages aggregated in the designated time window.| |
| 26 | +|Average Normalized Stage Latency|Displays the average latency of the normalized stage. The normalized stage performs normalization on raw incoming messages.| |
| 27 | +|Average Group Stage Latency|Displays the average latency of the group stage. The group stage performs buffering, aggregating, and grouping on normalized messages.| |
| 28 | +|Total Error Count|Displays the total number of errors.| |
| 29 | + |
| 30 | +## Display the MedTech service metrics |
| 31 | + |
| 32 | +1. Within your Azure Health Data Services workspace, select **MedTech service** under **Services**. |
| 33 | + |
| 34 | + :::image type="content" source="media\iot-metrics-display\iot-workspace-displayed-with-connectors-button.png" alt-text="Screenshot of select the MedTech service button within the workspace." lightbox="media\iot-metrics-display\iot-connectors-button.png"::: |
22 | 35 |
|
23 | 36 | 2. Select the MedTech service that you would like to display the metrics for. |
24 | 37 |
|
25 | | - :::image type="content" source="media\iot-metrics\iot-connector-select.png" alt-text="Screenshot of select MedTech service you would like to display metrics for." lightbox="media\iot-metrics\iot-connector-select.png"::: |
| 38 | + :::image type="content" source="media\iot-metrics-display\iot-connector-select.png" alt-text="Screenshot of select the MedTech service you would like to display metrics for." lightbox="media\iot-metrics-display\iot-connector-select.png"::: |
26 | 39 |
|
27 | 40 | 3. Select **Metrics** button within the MedTech service page. |
28 | 41 |
|
29 | | - :::image type="content" source="media\iot-metrics\iot-select-metrics.png" alt-text="Screenshot of Select the Metrics button." lightbox="media\iot-metrics\iot-metrics-button.png"::: |
| 42 | + :::image type="content" source="media\iot-metrics-display\iot-select-metrics.png" alt-text="Screenshot of Select the Metrics button within your MedTech service." lightbox="media\iot-metrics-display\iot-metrics-button.png"::: |
30 | 43 |
|
31 | | -4. From the metrics page, you can create the metrics that you want to display for your MedTech service. For this example, we'll be choosing the following selections: |
| 44 | +4. From the metrics page, you can create the metrics combinations that you want to display for your MedTech service. For this example, we'll be choosing the following selections: |
32 | 45 |
|
33 | | - * **Scope** = MedTech service name (**Default**) |
34 | | - * **Metric Namespace** = Standard Metrics (**Default**) |
35 | | - * **Metric** = MedTech service metrics you want to display. For this example, we'll choose **Number of Incoming Messages**. |
| 46 | + * **Scope** = Your MedTech service name (**Default**) |
| 47 | + * **Metric Namespace** = Standard metrics (**Default**) |
| 48 | + * **Metric** = The MedTech service metrics you want to display. For this example, we'll choose **Number of Incoming Messages**. |
36 | 49 | * **Aggregation** = How you would like to display the metrics. For this example, we'll choose **Count**. |
37 | 50 |
|
38 | | - :::image type="content" source="media\iot-metrics\iot-select-metrics-to-display.png" alt-text="Screenshpt of select metrics to display." lightbox="media\iot-metrics\iot-metrics-selection-close-up.png"::: |
| 51 | + :::image type="content" source="media\iot-metrics-display\iot-select-metrics-to-display.png" alt-text="Screenshot of select metrics to display." lightbox="media\iot-metrics-display\iot-metrics-selection-close-up.png"::: |
39 | 52 |
|
40 | 53 | 5. We can now see the MedTech service metrics for **Number of Incoming Messages** displayed on the Azure portal. |
41 | 54 |
|
42 | 55 | > [!TIP] |
43 | 56 | > You can add additional metrics by selecting the **Add metric** button and making your choices. |
44 | 57 |
|
45 | | - :::image type="content" source="media\iot-metrics\iot-metrics-add-button.png" alt-text="Screenshot of select Add metric button to add more metrics." lightbox="media\iot-metrics\iot-add-metric-button.png"::: |
| 58 | + :::image type="content" source="media\iot-metrics-display\iot-metrics-add-button.png" alt-text="Screenshot of select Add metric button to add more metrics." lightbox="media\iot-metrics-display\iot-add-metric-button.png"::: |
46 | 59 |
|
47 | 60 | > [!IMPORTANT] |
48 | | - > If you leave the metrics page, the metrics settings are lost and will have to be recreated. If you would like to save your MedTech service metrics for future viewing, you can pin them to an Azure dashboard as a tile. |
| 61 | + > If you leave the metrics page, the metrics settings for your MedTech service are lost and will have to be recreated. If you would like to save your MedTech service metrics for future viewing, you can pin them to an Azure dashboard as a tile. |
49 | 62 |
|
50 | | -## Pinning metrics tile on Azure portal dashboard |
| 63 | +## How to pin the MedTech service metrics tile to an Azure portal dashboard |
51 | 64 |
|
52 | | -1. To pin the metrics tile to an Azure portal dashboard, select the **Pin to dashboard** button. |
| 65 | +1. To pin the MedTech service metrics tile to an Azure portal dashboard, select the **Pin to dashboard** button. |
53 | 66 |
|
54 | | - :::image type="content" source="media\iot-metrics\iot-metrics-select-add-pin-to-dashboard.png" alt-text="Screenshot of select the Pin to dashboard button." lightbox="media\iot-metrics\iot-pin-to-dashboard-button.png"::: |
| 67 | + :::image type="content" source="media\iot-metrics-display\iot-metrics-select-add-pin-to-dashboard.png" alt-text="Screenshot of select the Pin to dashboard button." lightbox="media\iot-metrics-display\iot-pin-to-dashboard-button.png"::: |
55 | 68 |
|
56 | | -2. Select the dashboard you would like to display MedTech service metrics on. For this example, we'll use a private dashboard named `MedTech service Metrics`. Select **Pin** to add the metrics tile to the dashboard. |
| 69 | +2. Select the dashboard you would like to display your MedTech service metrics on. For this example, we'll use a private dashboard named `MedTech service metrics`. Select **Pin** to add your MedTech service metrics tile to the dashboard. |
57 | 70 |
|
58 | | - :::image type="content" source="media\iot-metrics\iot-select-pin-to-dashboard.png" alt-text="Screenshot of select dashboard and Pin button to complete the dashboard pinning process." lightbox="media\iot-metrics\iot-select-pin-to-dashboard.png"::: |
| 71 | + :::image type="content" source="media\iot-metrics-display\iot-select-pin-to-dashboard.png" alt-text="Screenshot of select dashboard and Pin button to complete the dashboard pinning process." lightbox="media\iot-metrics-display\iot-select-pin-to-dashboard.png"::: |
59 | 72 |
|
60 | | -3. You'll receive a confirmation that the metrics tile was successfully added to the dashboard. |
| 73 | +3. You'll receive a confirmation that your MedTech service metrics tile was successfully added to your selected Azure portal dashboard. |
61 | 74 |
|
62 | | - :::image type="content" source="media\iot-metrics\iot-select-dashboard-pinned-successful.png" alt-text="Screenshot of metrics tile successfully pinned to dashboard." lightbox="media\iot-metrics\iot-select-dashboard-pinned-successful.png"::: |
| 75 | + :::image type="content" source="media\iot-metrics-display\iot-select-dashboard-pinned-successful.png" alt-text="Screenshot of metrics tile successfully pinned to dashboard." lightbox="media\iot-metrics-display\iot-select-dashboard-pinned-successful.png"::: |
63 | 76 |
|
64 | | -4. Once you've received a successful confirmation, select **Dashboard**. |
| 77 | +4. Once you've received a successful confirmation, select the **Dashboard** button. |
65 | 78 |
|
66 | | - :::image type="content" source="media\iot-metrics\iot-select-dashboard-with-metrics-tile.png" alt-text="Screenshot of select the Dashboard button." lightbox="media\iot-metrics\iot-dashboard-button.png"::: |
| 79 | + :::image type="content" source="media\iot-metrics-display\iot-select-dashboard-with-metrics-tile.png" alt-text="Screenshot of select the Dashboard button." lightbox="media\iot-metrics-display\iot-dashboard-button.png"::: |
67 | 80 |
|
68 | | -5. Select the dashboard that you pinned the metrics tile to. For this example, the dashboard is **MedTech service Metrics**. The dashboard will display the MedTech service metrics tile that you created in the previous steps. |
| 81 | +5. Select the dashboard that you pinned your MedTech service metrics tile to. For this example, the dashboard is named **MedTech service metrics**. The dashboard will display the MedTech service metrics tile that you created in the previous steps. |
69 | 82 |
|
70 | | - :::image type="content" source="media\iot-metrics\iot-dashboard-with-metrics-tile-displayed.png" alt-text="Screenshot of dashboard with pinned MedTech service metrics tile." lightbox="media\iot-metrics\iot-dashboard-with-metrics-tile-displayed.png"::: |
| 83 | + :::image type="content" source="media\iot-metrics-display\iot-dashboard-with-metrics-tile-displayed.png" alt-text="Screenshot of dashboard with pinned MedTech service metrics tile." lightbox="media\iot-metrics-display\iot-dashboard-with-metrics-tile-displayed.png"::: |
71 | 84 |
|
72 | 85 | > [!TIP] |
73 | 86 | > See the [MedTech service troubleshooting guide](./iot-troubleshoot-guide.md) for assistance fixing common errors, conditions and issues. |
74 | 87 |
|
75 | 88 | ## Next steps |
76 | 89 |
|
77 | | -To learn how to export MedTech service metrics, see |
| 90 | +To learn how to export the MedTech service metrics, see |
78 | 91 |
|
79 | 92 | >[!div class="nextstepaction"] |
80 | | ->[Configure diagnostic setting for MedTech service metrics exporting](./iot-metrics-diagnostics-export.md) |
| 93 | +>[How to configure diagnostic settings for exporting the MedTech service metrics](./iot-metrics-diagnostics-export.md) |
81 | 94 |
|
82 | | -(FHIR®) is a registered trademark of HL7 and is used with the permission of HL7. |
| 95 | +(FHIR®) is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission. |
0 commit comments