Skip to content

Commit 2322dc8

Browse files
authored
Merge pull request #229785 from msjasteppe/monitoring-updates
Adding in the health checks tab addition
2 parents edb044d + 23dbeeb commit 2322dc8

21 files changed

+101
-91
lines changed

.openpublishing.redirection.healthcare-apis.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -665,13 +665,17 @@
665665
"redirect_url": "/azure/healthcare-apis/iot/how-to-use-mapping-debugger",
666666
"redirect_document_id": false
667667
},
668+
{ "source_path_from_root": "/articles/healthcare-apis/iot/how-to-use-monitoring-tab.md",
669+
"redirect_url": "/azure/healthcare-apis/iot/how-to-use-monitoring-and-health-checks-tabs",
670+
"redirect_document_id": false
671+
},
668672
{ "source_path_from_root": "/articles/healthcare-apis/events/events-display-metrics.md",
669673
"redirect_url": "/azure/healthcare-apis/events/events-use-metrics",
670674
"redirect_document_id": false
671675
},
672676
{ "source_path_from_root": "/articles/healthcare-apis/events/events-export-logs-metrics.md",
673677
"redirect_url": "/azure/healthcare-apis/events/events-enable-diagnostic-settings",
674-
"redirect_document_id": true
678+
"redirect_document_id": false
675679
}
676680
]
677681
}

articles/healthcare-apis/iot/how-to-use-mapping-debugger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: iomt
88
ms.topic: how-to
9-
ms.date: 03/05/2023
9+
ms.date: 03/07/2023
1010
ms.author: jasteppe
1111
---
1212

13-
# How to use the Mapping debugger
13+
# How to use the MedTech service Mapping debugger
1414

1515
> [!NOTE]
1616
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: How to use the MedTech service monitoring and health check tabs - Azure Health Data Services
3+
description: This article describes how to use the MedTech service monitoring and health check tabs.
4+
services: healthcare-apis
5+
author: msjasteppe
6+
ms.service: healthcare-apis
7+
ms.subservice: iomt
8+
ms.topic: how-to
9+
ms.date: 03/07/2023
10+
ms.author: jasteppe
11+
---
12+
13+
# How to use the MedTech service monitoring and health checks tabs
14+
15+
> [!NOTE]
16+
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
17+
18+
In this article, you'll learn how to use the MedTech service monitoring and health check tabs in the Azure portal. The monitoring and health check tabs provide access to crucial MedTech service metrics and health checks. These metrics and health checks can be used in assessing the health and performance of your MedTech service and can be useful seeing patterns and/or trends or assisting with troubleshooting your MedTech service.
19+
20+
## Use the MedTech service monitoring tab
21+
22+
1. Within your Azure Health Data Services workspace, select **MedTech service** under **Services**.
23+
24+
:::image type="content" source="media\how-to-use-monitoring-and-health-checks-tabs\workspace-displayed-with-connectors-button.png" alt-text="Screenshot of select the MedTech service within the workspace." lightbox="media\how-to-use-monitoring-and-health-checks-tabs\workspace-displayed-with-connectors-button.png":::
25+
26+
2. Select the MedTech service that you would like to display metrics for. For this example, we'll select a MedTech service named **mt-azuredocsdemo**. You'll be selecting a MedTech service within your own Azure Health Data Services workspace.
27+
28+
:::image type="content" source="media\how-to-use-monitoring-and-health-checks-tabs\select-medtech-service.png" alt-text="Screenshot of select the MedTech service you would like to display metrics for." lightbox="media\how-to-use-monitoring-and-health-checks-tabs\select-medtech-service.png":::
29+
30+
3. The MedTech service monitoring tab will open displaying a subset of the supported MedTech service metrics. By default, the **Show data for last** option is set to **1 hour**. To adjust the time duration, select the **Show data for last option**, select the time period you would like to view, and select **Apply**. Select the down arrow in the **Traffic** MedTech service metrics tile to display the next set of MedTech service traffic metrics.
31+
32+
:::image type="content" source="media\how-to-use-monitoring-and-health-checks-tabs\display-monitoring-tab.png" alt-text="Screenshot the MedTech service monitoring tab with drop-down menus." lightbox="media\how-to-use-monitoring-and-health-checks-tabs\display-monitoring-tab.png":::
33+
34+
> [!IMPORTANT]
35+
> If you leave the MedTech service monitoring tab, any customized settings you have made to the monitoring settings are lost and will have to be recreated. If you would like to save your customizations for future viewing, you can pin them to an Azure portal dashboard as a tile.
36+
>
37+
> To learn how to customize and save metrics settings to an Azure portal dashboard and tile, see [How to configure the MedTech service metrics](how-to-configure-metrics.md).
38+
39+
5. **Optional** - Select the **pin icon** to save the metrics tile to an Azure portal dashboard of your choosing.
40+
41+
:::image type="content" source="media\how-to-use-monitoring-and-health-checks-tabs\pin-metrics-to-dashboard.png" alt-text="Screenshot the MedTech service monitoring tile with red box around the pin icon." lightbox="media\how-to-use-monitoring-and-health-checks-tabs\pin-metrics-to-dashboard.png":::
42+
43+
> [!TIP]
44+
> To learn more about advanced metrics display and sharing options, see [Getting started with Azure Metrics Explorer](../../azure-monitor/essentials/metrics-getting-started.md)
45+
46+
## Available metrics for the MedTech service
47+
48+
This table shows the available MedTech service metrics and the information that the metrics are capturing. The metrics in **bold** are the metrics displayed within the **Monitoring** tab:
49+
50+
Metric category|Metric name|Metric description|
51+
|--------------|-----------|--------------|
52+
|Availability|IotConnector Health Status|The overall health of the MedTech service.|
53+
|Errors|**Total Error Count**|The total number of errors.|
54+
|Latency|**Average Group Stage Latency**|The average latency of the group stage. The [group stage](understand-service.md#group---optional) performs buffering, aggregating, and grouping on normalized messages.|
55+
|Latency|**Average Normalize Stage Latency**|The average latency of the normalized stage. The [normalized stage](understand-service.md#normalize) performs normalization on raw incoming messages.|
56+
|Traffic|Number of Fhir resources saved|The total number of FHIR resources [updated or persisted](understand-service.md#persist) by the MedTech service.|
57+
|Traffic|**Number of Incoming Messages**|The number of received raw [incoming messages](understand-service.md#ingest) (for example, the device events) from the configured source event hub.|
58+
|Traffic|**Number of Measurements**|The number of normalized value readings received by the FHIR [transformation stage](understand-service.md#transform) of the MedTech service.|
59+
|Traffic|**Number of Message Groups**|The number of groups that have messages aggregated in the designated time window.|
60+
|Traffic|**Number of Normalized Messages**|The number of normalized messages.|
61+
62+
## Use the MedTech service health checks tab
63+
64+
1. Select the **Health checks** tab within your MedTech service to display the health checks. In the example, the MedTech service is passing all health checks as indicated by the **Status** row and the **Connected** status.
65+
66+
:::image type="content" source="media\how-to-use-monitoring-and-health-checks-tabs\health-checks-without-errors.png" alt-text="Screenshot of the MedTech service health checks tab without errors." lightbox="media\how-to-use-monitoring-and-health-checks-tabs\health-checks-without-errors.png":::
67+
68+
2. In this example, we can see that the MedTech service is indicating that the **Health check** for **Event hub connection** is showing a **Status** of **Disconnected**. To find out how to troubleshoot this failed health check, you may select the **Accessing the MedTech service from the event hub** link under the **Learn more** row to be directed to the MedTech service troubleshooting guide section for addressing this failed health check.
69+
70+
:::image type="content" source="media\how-to-use-monitoring-and-health-checks-tabs\health-checks-with-error.png" alt-text="Screenshot of the MedTech service health checks tab with errors." lightbox="media\how-to-use-monitoring-and-health-checks-tabs\health-checks-with-error.png":::
71+
72+
## Next steps
73+
74+
In this article, you learned how to use the MedTech service monitoring and health check tab.
75+
76+
To learn how to configure the MedTech service metrics, see
77+
78+
> [!div class="nextstepaction"]
79+
> [How to configure the MedTech service metrics](how-to-configure-metrics.md)
80+
81+
To learn how to enable the MedTech service diagnostic settings, see
82+
83+
> [!div class="nextstepaction"]
84+
> [How to enable diagnostic settings for the MedTech service](how-to-enable-diagnostic-settings.md)
85+
86+
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.

articles/healthcare-apis/iot/how-to-use-monitoring-tab.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

articles/healthcare-apis/iot/index.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ metadata:
1313
ms.collection: collection
1414
author: msjasteppe
1515
ms.author: jasteppe
16-
ms.date: 02/17/2023
16+
ms.date: 03/07/2023
1717

1818
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
1919

@@ -64,8 +64,8 @@ landingContent:
6464
linkLists:
6565
- linkListType: how-to-guide
6666
links:
67-
- text: Use the monitoring tab
68-
url: how-to-use-monitoring-tab.md
67+
- text: Use the monitoring and health checks tabs
68+
url: how-to-use-monitoring-and-health-checks-tabs.md
6969
- text: Configure metrics
7070
url: how-to-configure-metrics.md
7171
- text: Enable diagnostic settings
29.1 KB
Loading
18.1 KB
Loading
25.3 KB
Loading
15.9 KB
Loading

0 commit comments

Comments
 (0)