Skip to content

Commit 0927d8c

Browse files
authored
Merge pull request #224952 from msjasteppe/diagnostics-enable-updates
Updates based on the new pre-defined queries
2 parents c9c6ced + a526abc commit 0927d8c

File tree

4 files changed

+52
-13
lines changed

4 files changed

+52
-13
lines changed

articles/healthcare-apis/iot/how-to-enable-diagnostic-settings.md

Lines changed: 52 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,18 @@ author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: iomt
88
ms.topic: how-to
9-
ms.date: 12/27/2022
9+
ms.date: 1/24/2023
1010
ms.author: jasteppe
1111
---
1212

1313
# How to enable diagnostic settings for the MedTech service
1414

15-
In this article, you'll learn how to enable the diagnostic settings for the MedTech service to export logs and metrics to different destinations (for example: to an [Azure Log Analytics workspace](../../azure-monitor/logs/log-analytics-workspace-overview.md) or an [Azure storage account](../../storage/index.yml) or an [Azure event hub](../../event-hubs/index.yml)) for audit, analysis, backup, or troubleshooting of your MedTech service.
15+
In this article, you'll learn how to enable diagnostic settings for the MedTech service to:
16+
17+
> [!div class="checklist"]
18+
> - Create a diagnostic setting to export logs and metrics for audit, analysis, or troubleshooting of the MedTech service.
19+
> - Use the Azure Log Analytics workspace to view the MedTech service logs.
20+
> - Access the MedTech service pre-defined Azure Log Analytics queries.
1621
1722
## Create a diagnostic setting for the MedTech service
1823

@@ -54,9 +59,9 @@ In this article, you'll learn how to enable the diagnostic settings for the MedT
5459

5560
|Destination|Description|
5661
|-----------|-----------|
57-
|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.|
58-
|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.|
59-
|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.|
62+
|[Azure Log Analytics workspace](../../azure-monitor/logs/log-analytics-workspace-overview.md)|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.|
63+
|[Azure storage account](../../storage/index.yml)|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.|
64+
|[Azure event hub](../../event-hubs/index.yml)|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.|
6065
|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.|
6166

6267
5. Select the **Save** option to save your diagnostic setting selections.
@@ -86,17 +91,17 @@ In this article, you'll learn how to enable the diagnostic settings for the MedT
8691
>
8792
> To learn about how to work with diagnostic logs, see [Overview of Azure platform logs](../../azure-monitor/essentials/platform-logs-overview.md).
8893
89-
## Use the Log Analytics workspace to view the MedTech service logs - Optional
94+
## Use the Azure Log Analytics workspace to view the MedTech service logs
9095

91-
If you choose to include your Log Analytics workspace as a destination option for your diagnostic setting, you can view the error logs within **Logs** in your MedTech service. If there are any error logs, they'll be a result of exceptions for your MedTech service (for example: *HealthCheck* exceptions).
96+
If you choose to include your Log Analytics workspace as a destination option for your diagnostic setting, you can view the logs within **Logs** in your MedTech service. If there are any logs, they'll be a result of exceptions for your MedTech service (for example: *HealthCheck* exceptions).
9297

9398
1. To access your Log Analytics workspace, select the **Logs** button within your MedTech service.
9499

95100
:::image type="content" source="media/how-to-enable-diagnostic-settings/select-logs-button.png" alt-text="Screenshot of logs option." lightbox="media/how-to-enable-diagnostic-settings/select-logs-button.png":::
96101

97-
2. Copy the below table query string into your Log Analytics workspace query window and select **Run**.
102+
2. Copy the below table query string into your Log Analytics workspace query area and select **Run**. Using the *AHDSMedTechDiagnosticLogs* table will provide you with all logs contained in the entire table for the selected **Time range** setting (the default value is **Last 24 hours**). The MedTech service provides five pre-defined queries that will be addressed in the article section titled [Accessing the MedTech service pre-defined Azure Log Analytics queries](how-to-enable-diagnostic-settings.md#accessing-the-medtech-service-pre-defined-azure-log-analytics-queries).
98103

99-
```Table
104+
```Kusto
100105
AHDSMedTechDiagnosticLogs
101106
```
102107
:::image type="content" source="media/how-to-enable-diagnostic-settings/select-run-query.png" alt-text="Screenshot of query run option." lightbox="media/how-to-enable-diagnostic-settings/select-run-query.png":::
@@ -117,16 +122,50 @@ If you choose to include your Log Analytics workspace as a destination option fo
117122

118123
:::image type="content" source="media/how-to-enable-diagnostic-settings/clean-query-result-post-error-fix.png" alt-text="Screenshot of query after fixing error." lightbox="media/how-to-enable-diagnostic-settings/clean-query-result-post-error-fix.png":::
119124

125+
> [!WARNING]
126+
> The above custom query is not saved and will have to be recreated if you leave your Log Analytics workspace without saving the custom query.
127+
>
128+
> To learn how to save a custom query in Log Analytics, see [Save a query in Azure Monitor Log Analytics](/azure/azure-monitor/logs/save-query)
129+
130+
> [!TIP]
131+
> To learn how to use the Log Analytics workspace, see [Azure Log Analytics workspace](../../azure-monitor/logs/log-analytics-workspace-overview.md).
132+
>
133+
> To learn how to troubleshoot the MedTech service error messages and conditions, see [Troubleshoot MedTech service errors](troubleshoot-errors.md).
134+
135+
## Accessing the MedTech service pre-defined Azure Log Analytics queries
136+
137+
The MedTech service comes with pre-defined queries that can be used anytime in your Log Analytics workspace to filter and summarize your logs for more precise investigation. The queries can also be customized and saved/shared.
138+
139+
1. To access the pre-defined queries, select **Queries**, type *MedTech* in the **Search** area, select a pre-defined query by using a double-click, and select **Run** to execute the pre-defined query. In this example, we've selected *MedTech healthcheck exceptions*. You'll select a pre-defined query of your own choosing.
140+
141+
> [!TIP]
142+
> You can click on each of the MedTech service pre-defined queries to see their description and access different options for running the query or placing it into the Log Analytics workspace query area.
143+
144+
:::image type="content" source="media/how-to-enable-diagnostic-settings/select-and-run-pre-defined-query.png" alt-text="Screenshot of searching, selecting, and running a MedTech service pre-defined query." lightbox="media/how-to-enable-diagnostic-settings/select-and-run-pre-defined-query.png":::
145+
146+
2. Multiple pre-defined queries can be selected. In this example, we've additionally selected *Log count per MedTech log or exception type*. You'll select another pre-defined query of your own choosing.
147+
148+
:::image type="content" source="media/how-to-enable-diagnostic-settings/select-and-run-additional-pre-defined-query.png" alt-text="Screenshot of searching, selecting, and running a MedTech service and additional pre-defined query." lightbox="media/how-to-enable-diagnostic-settings/select-and-run-additional-pre-defined-query.png":::
149+
150+
3. Only the highlighted pre-defined query will be executed.
151+
152+
:::image type="content" source="media/how-to-enable-diagnostic-settings/results-of-select-and-run-additional-pre-defined-query.png" alt-text="Screenshot of results of running a MedTech service and additional pre-defined query." lightbox="media/how-to-enable-diagnostic-settings/results-of-select-and-run-additional-pre-defined-query.png":::
153+
154+
> [!WARNING]
155+
> Any changes that you've made to the pre-defined queries are not saved and will have to be recreated if you leave your Log Analytics workspace without saving custom changes you've made to the pre-defined queries.
156+
>
157+
> To learn how to save a query in Log Analytics, see [Save a query in Azure Monitor Log Analytics](/azure/azure-monitor/logs/save-query)
158+
120159
> [!TIP]
121-
> To learn about how to use the Log Analytics workspace, see [Azure Log Analytics workspace](../../azure-monitor/logs/log-analytics-workspace-overview.md).
160+
> To learn how to use the Log Analytics workspace, see [Azure Log Analytics workspace](../../azure-monitor/logs/log-analytics-workspace-overview.md).
122161
>
123-
> To learn about how to troubleshoot the MedTech service error messages and conditions, see [Troubleshoot the MedTech service error messages and conditions](troubleshoot-error-messages-and-conditions.md).
162+
> To learn how to troubleshoot the MedTech service error messages and conditions, see [Troubleshoot MedTech service errors](troubleshoot-errors.md).
124163
125164
## Next steps
126165

127-
In this article, you learned how to enable the diagnostics settings for the MedTech service.
166+
In this article, you learned how to enable the diagnostics settings for the MedTech service and use the Log Analytics workspace to query and view the MedTech service logs.
128167

129168
To learn about the MedTech service frequently asked questions (FAQs), see
130169

131170
> [!div class="nextstepaction"]
132-
> [Frequently asked questions about the MedTech service](frequently-asked-questions.md)
171+
> [Frequently asked questions about the MedTech service](frequently-asked-questions.md)
Loading
Loading
102 KB
Loading

0 commit comments

Comments
 (0)