Skip to content

Commit 6d5ade2

Browse files
authored
Merge pull request #267371 from v-thepet/adf-monitor
Azure Monitor horizontals - Azure Data Factory
2 parents 4969ec3 + 8bfa7cd commit 6d5ade2

File tree

6 files changed

+278
-180
lines changed

6 files changed

+278
-180
lines changed

articles/data-factory/.openpublishing.redirection.data-factory.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1071,6 +1071,21 @@
10711071
"redirect_url": "/azure/data-factory/connector-microsoft-fabric-lakehouse",
10721072
"redirect_document_id": false
10731073
},
1074+
{
1075+
"source_path_from_root": "/articles/data-factory/monitor-using-azure-monitor.md",
1076+
"redirect_url": "/azure/data-factory/monitor-data-factory",
1077+
"redirect_document_id": false
1078+
},
1079+
{
1080+
"source_path_from_root": "/articles/data-factory/monitor-metrics-alerts.md",
1081+
"redirect_url": "/azure/data-factory/monitor-data-factory",
1082+
"redirect_document_id": false
1083+
},
1084+
{
1085+
"source_path_from_root": "/articles/data-factory/monitor-schema-logs-events.md",
1086+
"redirect_url": "/azure/data-factory/monitor-data-factory-reference",
1087+
"redirect_document_id": false
1088+
},
10741089
{
10751090
"source_path_from_root": "/articles/data-factory/connector-troubleshoot-google-adwords.md",
10761091
"redirect_url": "/azure/data-factory/connector-troubleshoot-google-ads",

articles/data-factory/TOC.yml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -914,18 +914,14 @@ items:
914914
displayName: user properties
915915
- name: Monitor with Azure Monitor
916916
items:
917-
- name: Overview
918-
href: monitor-using-azure-monitor.md
919-
- name: Azure Data Factory metrics and alerts
920-
href: monitor-metrics-alerts.md
917+
- name: Monitor
918+
href: monitor-data-factory.md
921919
- name: Configure diagnostics settings and workspace
922920
href: monitor-configure-diagnostics.md
923-
- name: Setup diagnostics logs via the Azure Monitor REST API
921+
- name: Set up diagnostics logs via the Azure Monitor REST API
924922
href: monitor-logs-rest.md
925923
- name: Monitor SSIS operations with Azure Monitor
926924
href: monitor-ssis.md
927-
- name: Schema of logs and events
928-
href: monitor-schema-logs-events.md
929925
- name: Monitor with SDKs
930926
href: monitor-programmatically.md
931927
- name: Pipeline failure and error handling
@@ -971,9 +967,9 @@ items:
971967
- name: Diagnostic tool for self-hosted integration runtime
972968
href: self-hosted-integration-runtime-diagnostic-tool.md
973969
displayName: self hosted
974-
- name: Monitoring self-hosted integration runtime in Azure
970+
- name: Monitor self-hosted integration runtime in Azure
975971
href: monitor-shir-in-azure.md
976-
- name: Configuring self-hosted integration runtime for log analytics collection
972+
- name: Configure self-hosted integration runtime for log analytics collection
977973
href: how-to-configure-shir-for-log-analytics-collection.md
978974
displayName: self hosted, runtime
979975
- name: Azure-SSIS integration runtime
@@ -1396,6 +1392,8 @@ items:
13961392
href: /cli/azure/datafactory
13971393
- name: Compute optimized data flows retired
13981394
href: compute-optimized-data-flow-retire.md
1395+
- name: Monitoring data reference
1396+
href: monitor-data-factory-reference.md
13991397
- name: Resources
14001398
items:
14011399
- name: Whitepapers

articles/data-factory/monitor-schema-logs-events.md renamed to articles/data-factory/monitor-data-factory-reference.md

Lines changed: 106 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,110 @@
11
---
2-
title: Schema of logs and events
3-
description: Learn about the schema used by Azure Data Factory logs and events for monitoring.
4-
author: nabhishek
5-
ms.author: abnarain
6-
ms.reviewer: jburchel
2+
title: Monitoring data reference for Azure Data Factory
3+
description: This article contains important reference material you need when you monitor Azure Data Factory.
4+
ms.date: 03/19/2024
5+
ms.custom: horz-monitor
6+
ms.topic: reference
7+
author: jonburchel
8+
ms.author: jburchel
79
ms.service: data-factory
8-
ms.subservice: monitoring
9-
ms.topic: conceptual
10-
ms.date: 10/20/2023
1110
---
1211

13-
# Schema of logs and events
12+
# Azure Data Factory monitoring data reference
1413

15-
This article describes the schema used by Azure Data Factory logs and events for monitoring.
14+
[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
1615

17-
## Monitor schema
18-
The following lists of attributes are used for monitoring.
16+
See [Monitor Data Factory](monitor-data-factory.md) for details on the data you can collect for Azure Data Factory and how to use it.
17+
18+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
19+
20+
### Supported metrics for Microsoft.DataFactory/datafactories
21+
The following table lists the metrics available for the Microsoft.DataFactory/datafactories resource type.
22+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
23+
[!INCLUDE [Microsoft.DataFactory/datafactories](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-datafactory-datafactories-metrics-include.md)]
24+
25+
### Supported metrics for Microsoft.DataFactory/factories
26+
The following table lists the metrics available for the Microsoft.DataFactory/factories resource type.
27+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
28+
[!INCLUDE [Microsoft.DataFactory/factories](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-datafactory-factories-metrics-include.md)]
29+
30+
> [!NOTE]
31+
> Except for _PipelineElapsedTimeRuns_, only events from completed, triggered activity and pipeline runs are emitted. In-progress and debug runs aren't emitted. However, events from all SSIS package executions are emitted, including those that are completed and in progress, regardless of their invocation methods. For example, you can invoke package executions on Azure-enabled SQL Server Data Tools, via T-SQL on SQL Server Management Studio, SQL Server Agent, or other designated tools, and as triggered or debug runs of Execute SSIS Package activities in Data Factory pipelines.
32+
33+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
34+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
35+
36+
### Microsoft.DataFactory/datafactories
37+
38+
- pipelineName
39+
- activityName
40+
41+
### Microsoft.DataFactory/factories
42+
- ActivityType
43+
- PipelineName
44+
- FailureType
45+
- Name
46+
- IntegrationRuntimeName
47+
- ContainerName
48+
- DagFile
49+
- DagId
50+
- ComputeNodeSize
51+
- Job
52+
- Operator
53+
- Pool
54+
- TaskId
55+
- State
56+
- NodeName
57+
- CancelledBy
58+
- RunId
59+
60+
[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
61+
62+
### Supported resource logs for Microsoft.DataFactory/factories
63+
[!INCLUDE [Microsoft.DataFactory/factories](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-datafactory-factories-logs-include.md)]
64+
65+
[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
66+
### Data factories
67+
68+
Microsoft.DataFactory/factories
69+
70+
- [AzureActivity](/azure/azure-monitor/reference/tables/AzureActivity#columns)
71+
- [AzureMetrics](/azure/azure-monitor/reference/tables/AzureMetrics#columns)
72+
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/AzureDiagnostics#columns)
73+
- [ADFActivityRun](/azure/azure-monitor/reference/tables/ADFActivityRun#columns)
74+
- [ADFPipelineRun](/azure/azure-monitor/reference/tables/ADFPipelineRun#columns)
75+
- [ADFTriggerRun](/azure/azure-monitor/reference/tables/ADFTriggerRun#columns)
76+
- [ADFSandboxActivityRun](/azure/azure-monitor/reference/tables/ADFSandboxActivityRun#columns)
77+
- [ADFSandboxPipelineRun](/azure/azure-monitor/reference/tables/ADFSandboxPipelineRun#columns)
78+
- [ADFSSISIntegrationRuntimeLogs](/azure/azure-monitor/reference/tables/ADFSSISIntegrationRuntimeLogs#columns)
79+
- [ADFSSISPackageEventMessageContext](/azure/azure-monitor/reference/tables/ADFSSISPackageEventMessageContext#columns)
80+
- [ADFSSISPackageEventMessages](/azure/azure-monitor/reference/tables/ADFSSISPackageEventMessages#columns)
81+
- [ADFSSISPackageExecutableStatistics](/azure/azure-monitor/reference/tables/ADFSSISPackageExecutableStatistics#columns)
82+
- [ADFSSISPackageExecutionComponentPhases](/azure/azure-monitor/reference/tables/ADFSSISPackageExecutionComponentPhases#columns)
83+
- [ADFSSISPackageExecutionDataStatistics](/azure/azure-monitor/reference/tables/ADFSSISPackageExecutionDataStatistics#columns)
84+
85+
## Monitor and Log Analytics schemas for logs and events
86+
87+
This section lists the attributes that the Azure Monitor and Log Analytics schemas use for monitoring logs and events.
88+
89+
Log Analytics inherits the schema from Azure Monitor with the following exceptions:
90+
91+
- The first letter in each column name is capitalized. For example, the column name **correlationId** in Monitor is **CorrelationId** in Log Analytics.
92+
- There's no **Level** column.
93+
- The dynamic **properties** column is preserved as the following dynamic JSON blob type.
94+
95+
| Azure Monitor column | Log Analytics column | Type |
96+
| --- | --- | --- |
97+
| $.properties.UserProperties | UserProperties | Dynamic |
98+
| $.properties.Annotations | Annotations | Dynamic |
99+
| $.properties.Input | Input | Dynamic |
100+
| $.properties.Output | Output | Dynamic |
101+
| $.properties.Error.errorCode | ErrorCode | int |
102+
| $.properties.Error.message | ErrorMessage | string |
103+
| $.properties.Error | Error | Dynamic |
104+
| $.properties.Predecessors | Predecessors | Dynamic |
105+
| $.properties.Parameters | Parameters | Dynamic |
106+
| $.properties.SystemParameters | SystemParameters | Dynamic |
107+
| $.properties.Tags | Tags | Dynamic |
19108

20109
### Activity-run log attributes
21110

@@ -445,28 +534,11 @@ Here are the log attributes of data movements through each leg of data flow pipe
445534
| **executionPath** | String | The path of execution for data flow task | `\Transformation\Data Flow Task` |
446535
| **resourceId** | String | The unique ID of your data factory resource | `/SUBSCRIPTIONS/<subscriptionID>/RESOURCEGROUPS/<resourceGroupName>/PROVIDERS/MICROSOFT.DATAFACTORY/FACTORIES/<dataFactoryName>` |
447536

448-
## Log Analytics schema
449-
450-
Log Analytics inherits the schema from Azure Monitor with the following exceptions:
451-
452-
* The first letter in each column name is capitalized. For example, the column name "correlationId" in Monitor is "CorrelationId" in Log Analytics.
453-
* There's no "Level" column.
454-
* The dynamic "properties" column is preserved as the following dynamic JSON blob type.
455-
456-
| Azure Monitor column | Log Analytics column | Type |
457-
| --- | --- | --- |
458-
| $.properties.UserProperties | UserProperties | Dynamic |
459-
| $.properties.Annotations | Annotations | Dynamic |
460-
| $.properties.Input | Input | Dynamic |
461-
| $.properties.Output | Output | Dynamic |
462-
| $.properties.Error.errorCode | ErrorCode | int |
463-
| $.properties.Error.message | ErrorMessage | string |
464-
| $.properties.Error | Error | Dynamic |
465-
| $.properties.Predecessors | Predecessors | Dynamic |
466-
| $.properties.Parameters | Parameters | Dynamic |
467-
| $.properties.SystemParameters | SystemParameters | Dynamic |
468-
| $.properties.Tags | Tags | Dynamic |
537+
[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
538+
- [Microsoft.DataFactory resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftdatafactory)
469539

470540
## Related content
471541

472-
[Monitor programmatically using SDKs](monitor-programmatically.md)
542+
- [Monitor Data Factory](monitor-data-factory.md)
543+
- [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource)
544+
- [Monitor programmatically using SDKs](monitor-programmatically.md)

0 commit comments

Comments
 (0)