Skip to content

Commit baf984a

Browse files
denreadenrea
authored
Merge pull request #235433 from esmadau/users/esmadau/dicomlogs
update diagnostic logging
2 parents 21a203a + e2bc4ff commit baf984a

File tree

2 files changed

+65
-13
lines changed

2 files changed

+65
-13
lines changed

‎articles/healthcare-apis/dicom/enable-diagnostic-logging.md

Lines changed: 63 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ ms.date: 03/02/2022
99
ms.author: mmitrik
1010
---
1111

12-
# Enable Diagnostic Logging in the DICOM service
12+
# Enable audit and diagnostic logging in the DICOM service
1313

1414
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.
1515

16-
## Enable audit logs
16+
## Enable logs
1717

18-
1. To enable diagnostic logging DICOM service, select your DICOM service in the Azure portal.
18+
1. To enable logging DICOM service, select your DICOM service in the Azure portal.
1919
2. Select the **Activity log** blade, and then select **Diagnostic settings**.
2020

2121
[ ![Screenshot of Azure activity log.](media/dicom-activity-log.png) ](media/dicom-activity-log.png#lightbox)
@@ -45,30 +45,82 @@ In this article, you'll learn how to enable diagnostic logging in DICOM service
4545
4646
For information on how to work with diagnostic logs, see [Azure Resource Log documentation](../../azure-monitor/essentials/platform-logs-overview.md)
4747

48-
## Audit log details
48+
## Log details
49+
The log schema used differs based on the destination. Log Analytics has a schema that will differ from other destinations. Each log type will also have a schema that differs.
4950

50-
The DICOM service returns the following fields in the audit log:
51+
### Audit log details
52+
53+
#### Raw logs
54+
55+
The DICOM service returns the following fields in the audit log as seen when streamed outside of Log Analytics:
5156

5257
|Field Name |Type |Notes |
5358
|---------|---------|---------|
5459
|correlationId|String|Correlation ID
55-
|category|String|Log Category (We currently have 'AuditLogs')
5660
|operationName|String|Describes the type of operation (for example, Retrieve, Store, Query, etc.)
5761
|time|DateTime|Date and time of the event.
5862
|resourceId|String| Azure path to the resource.
5963
|identity|Dynamic|A generic property bag containing identity information (currently doesn't apply to DICOM).
60-
|callerIpAddress|String|The caller's IP address.
61-
|Location|String|The location of the server that processed the request.
64+
|location|String|The location of the server that processed the request.
6265
|uri|String|The request URI.
6366
|resultType|String| The available values currently are Started, Succeeded, or Failed.
6467
|resultSignature|Int|The HTTP Status Code (for example, 200)
65-
|properties|String|Describes the properties including resource type, resource name, subscription ID, audit action, etc.
6668
|type|String|Type of log (it's always MicrosoftHealthcareApisAuditLog in this case).
69+
|level|String|Log level (Informational, Error).
70+
71+
72+
#### Log Analytics logs
73+
74+
The DICOM service returns the following fields in the audit log in Log Analytics:
75+
76+
|Field Name |Type |Notes |
77+
|---------|---------|---------|
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).
6787
|Level|String|Log level (Informational, Error).
68-
|operationVersion|String| Currently empty. Will be utilized to show api version.
88+
|TenantId|String| Tenant ID.
89+
90+
91+
### Diagnostic log details
92+
93+
#### Raw logs
94+
95+
The DICOM service returns the following fields in the audit log as seen when streamed outside of Log Analytics:
6996

97+
|Field Name |Type |Notes |
98+
|---------|---------|---------|
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 here 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).
108+
109+
#### Log Analytics logs
110+
111+
The DICOM service returns the following fields in the audit log in Log Analytics:
112+
113+
|Field Name |Type |Notes |
114+
|---------|---------|---------|
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 here 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).
70122

71-
## Sample queries
123+
## Sample Log Analytics queries
72124

73125
Below are a few basic Application Insights queries you can use to explore your log data.
74126

‎articles/healthcare-apis/dicom/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ items:
3737
href: dicom-configure-azure-rbac.md#assign-roles-for-the-dicom-service
3838
- name: Configure CORS
3939
href: configure-cross-origin-resource-sharing.md
40-
- name: Diagnostic logging
40+
- name: Audit and diagnostic logging
4141
expanded: false
4242
items:
43-
- name: Enable diagnostic logging in the DICOM service
43+
- name: Enable audit and diagnostic logging in the DICOM service
4444
href: enable-diagnostic-logging.md
4545
- name: Operations
4646
expanded: false

0 commit comments

Comments
 (0)