|
1 | 1 | ---
|
2 | 2 | title: Enable diagnostic logging in the DICOM service - Azure Health Data Services
|
3 | 3 | description: This article explains how to enable diagnostic logging in the DICOM service.
|
4 |
| -author: mmitrik |
| 4 | +author: varunbms |
5 | 5 | ms.service: azure-health-data-services
|
6 | 6 | ms.subservice: dicom-service
|
7 | 7 | ms.topic: conceptual
|
8 | 8 | ms.date: 10/13/2023
|
9 |
| -ms.author: mmitrik |
| 9 | +ms.author: buchvarun |
10 | 10 | ---
|
11 | 11 |
|
12 | 12 | # Enable audit and diagnostic logging in the DICOM service
|
13 | 13 |
|
14 |
| -In this article, you'll learn how to enable diagnostic logging in DICOM service and be able to review some sample queries for these logs. Access to diagnostic logs is essential for any healthcare service where compliance with regulatory requirements is a must. The feature in DICOM service enables diagnostic logs is the [Diagnostic settings](../../azure-monitor/essentials/diagnostic-settings.md) in the Azure portal. |
| 14 | +In this article, you'll learn how to enable diagnostic logging in DICOM® service and be able to review some sample queries for these logs. Access to diagnostic logs is essential for any healthcare service where compliance with regulatory requirements is required. The feature in DICOM service that enables diagnostic logs is the [Diagnostic settings](../../azure-monitor/essentials/diagnostic-settings.md) in the Azure portal. |
15 | 15 |
|
16 | 16 | ## Enable logs
|
17 | 17 |
|
18 | 18 | 1. To enable logging DICOM service, select your DICOM service in the Azure portal.
|
19 | 19 | 2. Select the **Activity log** on the left pane, and then select **Diagnostic settings**.
|
20 | 20 |
|
21 |
| - [  ](media/dicom-activity-log.png#lightbox) |
| 21 | + [](media/dicom-activity-log.png#lightbox) |
22 | 22 |
|
23 | 23 | 3. Select **+ Add diagnostic setting**.
|
24 | 24 |
|
25 |
| - [  ](media/add-diagnostic-settings.png#lightbox) |
| 25 | + [](media/add-diagnostic-settings.png#lightbox) |
26 | 26 |
|
27 | 27 | 4. Enter the **Diagnostic settings name**.
|
28 | 28 |
|
29 |
| - [  ](media/configure-diagnostic-settings.png#lightbox) |
| 29 | + [](media/configure-diagnostic-settings.png#lightbox) |
30 | 30 |
|
31 |
| -5. Select the **Category** and **Destination** details for accessing the diagnostic logs. |
| 31 | +5. Select the **Category** and **Destination** details for accessing the diagnostic logs: |
32 | 32 |
|
33 | 33 | * **Send to Log Analytics workspace** in the Azure Monitor. You need to create your Logs Analytics workspace before you can select this option. For more information about the platform logs, see [Overview of Azure platform logs](../../azure-monitor/essentials/platform-logs-overview.md).
|
34 |
| - * **Archive to a storage account** for auditing or manual inspection. The storage account you want to use needs to be already created. |
| 34 | + * **Archive to a storage account** for auditing or manual inspection. The storage account you want to use needs to already be created. |
35 | 35 | * **Stream to an event hub** for ingestion by a third-party service or custom analytic solution. You need to create an event hub namespace and event hub policy before you can configure this step.
|
36 |
| - * **Send to partner solution** that you're working with as partner organization in Azure. For information about potential partner integrations, see [Azure partner solutions documentation](../../partner-solutions/overview.md) |
| 36 | + * **Send to partner solution** that you're working with as a partner organization in Azure. For information about potential partner integrations, see [Azure partner solutions documentation](../../partner-solutions/overview.md) |
37 | 37 |
|
38 | 38 | For information about supported metrics, see [Supported metrics with Azure Monitor](.././../azure-monitor/essentials/metrics-supported.md).
|
39 | 39 |
|
40 | 40 | 6. Select **Save**.
|
41 | 41 |
|
42 |
| - |
43 | 42 | > [!Note]
|
44 |
| - > It might take up to 15 minutes for the first Logs to show in Log Analytics. Also, if the DICOM service is moved from one resource group or subscription to another, update the settings once the move is complete. |
| 43 | + > It might take up to 15 minutes for the first Logs to appear in Log Analytics. Also, if the DICOM service is moved from one resource group or subscription to another, update the settings once the move is complete. |
45 | 44 |
|
46 | 45 | For information on how to work with diagnostic logs, see [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md)
|
47 | 46 |
|
48 | 47 | ## Log details
|
49 |
| -The log schema used differs based on the destination. Log Analytics has a schema that differs from other destinations. Each log type has a schema that differs. |
| 48 | +The log schema used differs based on the destination. Log Analytics has a schema that differs from other destinations. Each log type has a different schema. |
50 | 49 |
|
51 | 50 | ### Audit log details
|
52 | 51 |
|
53 | 52 | #### Raw logs
|
54 | 53 |
|
55 |
| -The DICOM service returns the following fields in the audit log as seen when streamed outside of Log Analytics: |
| 54 | +The DICOM service returns the following fields in the audit log as seen when streamed outside of Log Analytics. |
56 | 55 |
|
57 | 56 | |Field Name |Type |Notes |
|
58 | 57 | |---------|---------|---------|
|
59 |
| -|correlationId|String|Correlation ID |
60 |
| -|operationName|String|Describes the type of operation (for example, Retrieve, Store, Query, etc.) |
61 |
| -|time|DateTime|Date and time of the event. |
62 |
| -|resourceId|String| Azure path to the resource. |
63 |
| -|identity|Dynamic|A generic property bag containing identity information (currently doesn't apply to DICOM). |
64 |
| -|location|String|The location of the server that processed the request. |
65 |
| -|uri|String|The request URI. |
66 |
| -|resultType|String| The available values currently are Started, Succeeded, or Failed. |
67 |
| -|resultSignature|Int|The HTTP Status Code (for example, 200) |
68 |
| -|type|String|Type of log (it's always MicrosoftHealthcareApisAuditLog in this case). |
69 |
| -|level|String|Log level (Informational, Error). |
| 58 | +| correlationId | String | Correlation ID | |
| 59 | +| operationName | String | Describes the type of operation (for example, Retrieve, Store, Query, etc.) | |
| 60 | +|time | DateTime | Date and time of the event. | |
| 61 | +|resourceId | String | Azure path to the resource. | |
| 62 | +|identity | Dynamic | A generic property bag containing identity information (currently doesn't apply to DICOM). | |
| 63 | +| location | String | The location of the server that processed the request. | |
| 64 | +| uri | String | The request URI. | |
| 65 | +| resultType | String | The available values currently are Started, Succeeded, or Failed. | |
| 66 | +| resultSignature | Int | The HTTP Status Code (for example, 200) | |
| 67 | +| type | String | Type of log (it's always MicrosoftHealthcareApisAuditLog in this case). | |
| 68 | +| level | String | Log level (Informational, Error). | |
70 | 69 |
|
71 | 70 |
|
72 | 71 | #### Log Analytics logs
|
73 | 72 |
|
74 |
| -The DICOM service returns the following fields in the audit sign-in Log Analytics: |
| 73 | +The DICOM service returns the following fields in the audit sign-in Log Analytics. |
75 | 74 |
|
76 | 75 | |Field Name |Type |Notes |
|
77 | 76 | |---------|---------|---------|
|
78 |
| -|CorrelationId|String|Correlation ID |
79 |
| -|OperationName|String|Describes the type of operation (for example, Retrieve, Store, Query, etc.) |
80 |
| -|TimeGenerated [UTC]|DateTime|Date and time of the event. |
81 |
| -|_ResourceId|String| Azure path to the resource. |
82 |
| -|Identity|Dynamic|A generic property bag containing identity information (currently doesn't apply to DICOM). |
83 |
| -|Uri|String|The request URI. |
84 |
| -|ResultType|String| The available values currently are Started, Succeeded, or Failed. |
85 |
| -|StatusCode|Int|The HTTP Status Code (for example, 200) |
86 |
| -|Type|String|Type of log (it's always AHDSDicomAuditLogs in this case). |
87 |
| -|Level|String|Log level (Informational, Error). |
88 |
| -|TenantId|String| Tenant ID. |
| 77 | +| CorrelationId | String | Correlation ID | |
| 78 | +| OperationName | String | Describes the type of operation (for example, Retrieve, Store, Query, etc.) | |
| 79 | +| TimeGenerated [UTC] | DateTime | Date and time of the event. | |
| 80 | +| _ResourceId | String | Azure path to the resource. | |
| 81 | +| Identity | Dynamic | A generic property bag containing identity information (currently doesn't apply to DICOM). | |
| 82 | +| Uri | String | The request URI. | |
| 83 | +| ResultType | String | The available values currently are Started, Succeeded, or Failed. | |
| 84 | +| StatusCode | Int | The HTTP Status Code (for example, 200) | |
| 85 | +| Type|String | Type of log (it's always AHDSDicomAuditLogs in this case). | |
| 86 | +| Level | String | Log level (Informational, Error). | |
| 87 | +| TenantId | String | Tenant ID. | |
89 | 88 |
|
90 | 89 |
|
91 | 90 | ### Diagnostic log details
|
92 | 91 |
|
93 | 92 | #### Raw logs
|
94 | 93 |
|
95 |
| -The DICOM service returns the following fields in the audit log as seen when streamed outside of Log Analytics: |
| 94 | +The DICOM service returns the following fields in the audit log as seen when streamed outside of Log Analytics. |
96 | 95 |
|
97 | 96 | |Field Name |Type |Notes |
|
98 | 97 | |---------|---------|---------|
|
99 |
| -|correlationId|String|Correlation ID |
100 |
| -|operationName|String|Describes the type of operation (for example, Retrieve, Store, Query, etc.) |
101 |
| -|time|DateTime|Date and time of the event. |
102 |
| -|resultDescription|String|Description of the log entry. An example is a diagnostic log with a validation warning message when storing a file. |
103 |
| -|resourceId|String| Azure path to the resource. |
104 |
| -|identity|Dynamic|A generic property bag containing identity information (currently doesn't apply to DICOM). |
105 |
| -|location|String|The location of the server that processed the request. |
106 |
| -|properties|String|Additional information about the event in JSON array format. Examples include DICOM identifiers present in the request. |
107 |
| -|level|String|Log level (Informational, Error). |
| 98 | +| correlationId | String | Correlation ID | |
| 99 | +| operationName | String | Describes the type of operation (for example, Retrieve, Store, Query, etc.) | |
| 100 | +| time | DateTime | Date and time of the event. | |
| 101 | +| resultDescription | String | Description of the log entry. An example is a diagnostic log with a validation warning message when storing a file. | |
| 102 | +| resourceId | String | Azure path to the resource. | |
| 103 | +| identity | Dynamic | A generic property bag containing identity information (currently doesn't apply to DICOM). | |
| 104 | +| location | String | The location of the server that processed the request. | |
| 105 | +| properties | String | Additional information about the event in JSON array format. Examples include DICOM identifiers present in the request. | |
| 106 | +| level | String | Log level (Informational, Error). | |
108 | 107 |
|
109 | 108 | #### Log Analytics logs
|
110 | 109 |
|
111 |
| -The DICOM service returns the following fields in the audit sign-in Log Analytics: |
| 110 | +The DICOM service returns the following fields in the audit sign-in Log Analytics. |
112 | 111 |
|
113 | 112 | |Field Name |Type |Notes |
|
114 | 113 | |---------|---------|---------|
|
115 |
| -|CorrelationId|String|Correlation ID |
116 |
| -|OperationName|String|Describes the type of operation (for example, Retrieve, Store, Query, etc.) |
117 |
| -|TimeGenerated|DateTime|Date and time of the event. |
118 |
| -|Message|String|Description of the log entry. An example is a diagnostic log with a validation warning message when storing a file. |
119 |
| -|Location|String|The location of the server that processed the request. |
120 |
| -|Properties|String|Additional information about the event in JSON array format. Examples include DICOM identifiers present in the request. |
121 |
| -|LogLevel|String|Log level (Informational, Error). |
| 114 | +| CorrelationId | String | Correlation ID | |
| 115 | +| OperationName | String | Describes the type of operation (for example, Retrieve, Store, Query, etc.) | |
| 116 | +| TimeGenerated | DateTime | Date and time of the event. | |
| 117 | +| Message | String | Description of the log entry. An example is a diagnostic log with a validation warning message when storing a file. | |
| 118 | +| Location | String | The location of the server that processed the request. | |
| 119 | +| Properties | String | Additional information about the event in JSON array format. Examples include DICOM identifiers present in the request. | |
| 120 | +| LogLevel | String | Log level (Informational, Error). | |
122 | 121 |
|
123 | 122 | ## Sample Log Analytics queries
|
124 | 123 |
|
|
0 commit comments