Skip to content

Commit a67416e

Browse files
Merge pull request #216127 from olmoloce/patch-1
Create concepts-annotations-userproperties.md
2 parents f3cd2c6 + 9d0fb37 commit a67416e

File tree

8 files changed

+59
-1
lines changed

8 files changed

+59
-1
lines changed

articles/data-factory/TOC.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,9 @@ items:
193193
href: concepts-pipelines-activities.md
194194
displayName: retry, timeout
195195
- name: Pipeline parameters and variables
196-
href: concepts-parameters-variables.md
196+
href: concepts-parameters-variables.md
197+
- name: Annotations and user properties
198+
href: concepts-annotations-user-properties.md
197199
- name: Nested activities
198200
href: concepts-nested-activities.md
199201
displayName: nested, nesting
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Monitor Azure Data Factory and Azure Synapse Analytics pipelines with annotations and user properties
3+
description: Advanced monitoring with annotations and user properties
4+
author: olmoloce
5+
ms.author: olmoloce
6+
ms.reviewer: olmoloce
7+
ms.service: data-factory
8+
ms.subservice: monitoring
9+
ms.topic: conceptual
10+
ms.date: 11/01/2022
11+
---
12+
13+
# Monitor Azure Data Factory and Azure Synapse Analytics pipelines with annotations and user properties
14+
15+
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
16+
17+
When monitoring your data pipelines, you may want to be able to filter and monitor a certain group of activities, such as those of a project or specific department's pipelines. You may also need to further monitor activities based on dynamic properties. You can achieve these things by leveraging annotations and user properties.
18+
19+
## Annotations
20+
21+
Azure Data Factory annotations are tags that you can add to your Azure Data Factory or Azure Synapse Analytics entities to easily identify them. An annotation allows you to classify or group different entities in order to easily monitor or filter them after an execution. Annotations only allow you to define static values and can be added to pipelines, datasets, linked services and triggers.
22+
23+
## User properties
24+
25+
User properties are key-value pairs defined at the activity level. By adding user properties, you can view additional information about activities under activity runs window that may help you to monitor your activity executions.
26+
User properties allow you to define dynamic values and can be added to any activity, up to 5 per activity, under User Properties tab.
27+
28+
## Create and use annotations and user properties
29+
30+
As we discussed, annotations are static values that you can assign to pipelines, datasets, linked services, and triggers. Let's assume you want to filter for pipelines that belong to the same business unit or project name. We will first create the annotation. Click on the Properties icon, + New button and name your annotation appropriately. We advise being consistent with your naming.
31+
32+
![Screenshot showing how to create an annotation.](./media/concepts-annotations-user-properties/create-annotations.png "Create Annotation")
33+
34+
When you go to the Monitor tab, you can filter under Pipeline runs for this Annotation:
35+
36+
![Screenshot showing how to monitor an annotations.](./media/concepts-annotations-user-properties/monitor-annotations.png "Monitor Annotations")
37+
38+
If you want to monitor for dynamic values at the activity level, you can do so by leveraging the User properties. You can add these under any activity by clicking on the Activity box, User properties tab and the + New button:
39+
40+
![Screenshot showing how to create user properties.](./media/concepts-annotations-user-properties/create-user-properties.png "Create User Properties")
41+
42+
For Copy Activity specifically, you can auto-generate these:
43+
44+
![Screenshot showing User Properties under Copy activity.](./media/concepts-annotations-user-properties/copy-activity-user-properties.png "Copy Activity User Properties")
45+
46+
To monitor User properties, go to the Activity runs monitoring view. Here you will see all the properties you added.
47+
48+
![Screenshot showing how to use User Properties in the Monitor tab.](./media/concepts-annotations-user-properties/monitor-user-properties.png "Monitor User Properties")
49+
50+
You can remove some from the view if you click on the Bookmark sign:
51+
52+
![Screenshot showing how to remove User Properties.](./media/concepts-annotations-user-properties/remove-user-properties.png "Remove User Properties")
53+
54+
## Next steps
55+
56+
To learn more about monitoring see [Visually monitor Azure Data Factory.](./monitor-visually.md)
25.8 KB
Loading
15.7 KB
Loading
22 KB
Loading
34.5 KB
Loading
35.1 KB
Loading
14.8 KB
Loading

0 commit comments

Comments
 (0)