Alert and Monitor data factories using Azure Monitor

• 12/11/2018
• 12 minutes to read
• • 
  • 
  • 
  • 
  • 
  • +11

Cloud applications are complex with many moving parts. Monitoring provides data to ensure that your application stays up and running in a healthy state. It also helps you to stave off potential problems or troubleshoot past ones. In addition, you can use monitoring data to gain deep insights about your application. This knowledge can help you to improve application performance or maintainability, or automate actions that would otherwise require manual intervention.

Azure Monitor provides base level infrastructure metrics and logs for most services in Microsoft Azure. For details, see monitoring overview. Azure Diagnostic logs are logs emitted by a resource that provide rich, frequent data about the operation of that resource. Data Factory outputs diagnostic logs in Azure Monitor.

Persist Data Factory Data

Data Factory only stores pipeline run data for 45 days. If you want to persist pipeline run data for more than 45 days, using Azure Monitor, you cannot only route diagnostic logs for analysis, you can persist them into a storage account so you have factory information for the duration of your choosing.

Diagnostic logs

• Save them to a Storage Account for auditing or manual inspection. You can specify the retention time (in days) using the diagnostic settings.
• Stream them to Event Hubs for ingestion by a third-party service or custom analytics solution such as Power BI.
• Analyze them with Log Analytics

You can use a storage account or event hub namespace that is not in the same subscription as the resource that is emitting logs. The user who configures the setting must have the appropriate role-based access control (RBAC) access to both subscriptions.

Set up diagnostic logs

Diagnostic Settings

Diagnostic Logs for non-compute resources are configured using diagnostic settings. Diagnostic settings for a resource control:

• Where diagnostic logs are sent (Storage Account, Event Hubs, or Azure Monitor logs).
• Which log categories are sent.
• How long each log category should be retained in a storage account.
• A retention of zero days means logs are kept forever. Otherwise, the value can be any number of days between 1 and 2147483647.
• If retention policies are set but storing logs in a storage account is disabled (for example, only Event Hubs or Azure Monitor logs options are selected), the retention policies have no effect.
• Retention policies are applied per-day, so at the end of a day (UTC), logs from the day that is now beyond the retention policy are deleted. For example, if you had a retention policy of one day, at the beginning of the day today the logs from the day before yesterday would be deleted.

Enable diagnostic logs via REST APIs

Create or update a diagnostics setting in Azure Monitor REST API

Request

PUT
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}

Headers

• Replace {api-version} with 2016-09-01.
• Replace {resource-id} with the resource ID of the resource for which you would like to edit diagnostic settings. For more information Using Resource groups to manage your Azure resources.
• Set the Content-Type header to application/json.
• Set the authorization header to a JSON web token that you obtain from Azure Active Directory. For more information, see Authenticating requests.

Body

{
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
        "metrics": [
        ],
        "logs": [
                {
                    "category": "PipelineRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                },
                {
                    "category": "TriggerRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                },
                {
                    "category": "ActivityRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                }
            ]
    },
    "location": ""
}

Response

200 OK

{
    "id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
    "type": null,
    "name": "service",
    "location": null,
    "kind": null,
    "tags": null,
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
        "eventHubAuthorizationRuleId": null,
        "eventHubName": null,
        "metrics": [],
        "logs": [
            {
                "category": "PipelineRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "TriggerRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "ActivityRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            }
        ]
    },
    "identity": null
}

Get information about diagnostics setting in Azure Monitor REST API

Request

GET
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}

Headers

• Replace {api-version} with 2016-09-01.
• Replace {resource-id} with the resource ID of the resource for which you would like to edit diagnostic settings. For more information Using Resource groups to manage your Azure resources.
• Set the Content-Type header to application/json.
• Set the authorization header to a JSON Web Token that you obtain from Azure Active Directory. For more information, see Authenticating requests.

Response

200 OK

{
    "id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
    "type": null,
    "name": "service",
    "location": null,
    "kind": null,
    "tags": null,
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.Storage/storageAccounts/azmonlogs",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.EventHub/namespaces/shloeventhub/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/ADF/providers/Microsoft.OperationalInsights/workspaces/mihaipie",
        "eventHubAuthorizationRuleId": null,
        "eventHubName": null,
        "metrics": [],
        "logs": [
            {
                "category": "PipelineRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "TriggerRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "ActivityRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            }
        ]
    },
    "identity": null
}

More info here

Schema of Logs & Events

Azure Monitor Schema

Activity Run Logs Attributes

{
   "Level": "",
   "correlationId":"",
   "time":"",
   "activityRunId":"",
   "pipelineRunId":"",
   "resourceId":"",
   "category":"ActivityRuns",
   "level":"Informational",
   "operationName":"",
   "pipelineName":"",
   "activityName":"",
   "start":"",
   "end":"",
   "properties":
       {
          "Input": "{
              "source": {
                "type": "BlobSource"
              },
              "sink": {
                "type": "BlobSink"
              }
           }",
          "Output": "{"dataRead":121,"dataWritten":121,"copyDuration":5,
               "throughput":0.0236328132,"errors":[]}",
          "Error": "{
              "errorCode": "null",
              "message": "null",
              "failureType": "null",
              "target": "CopyBlobtoBlob"
        }
    }
}

Pipeline Run Logs Attributes

{
   "Level": "",
   "correlationId":"",
   "time":"",
   "runId":"",
   "resourceId":"",
   "category":"PipelineRuns",
   "level":"Informational",
   "operationName":"",
   "pipelineName":"",
   "start":"",
   "end":"",
   "status":"",
   "properties":
    {
      "Parameters": {
        "<parameter1Name>": "<parameter1Value>"
      },
      "SystemParameters": {
        "ExecutionStart": "",
        "TriggerId": "",
        "SubscriptionId": ""
      }
    }
}

Trigger Run Logs Attributes

{
   "Level": "",
   "correlationId":"",
   "time":"",
   "triggerId":"",
   "resourceId":"",
   "category":"TriggerRuns",
   "level":"Informational",
   "operationName":"",
   "triggerName":"",
   "triggerType":"",
   "triggerEvent":"",
   "start":"",
   "status":"",
   "properties":
   {
      "Parameters": {
        "TriggerTime": "",
       "ScheduleTime": ""
      },
      "SystemParameters": {}
    }
}

Log Analytics Schema

Log Analytics inherits the schema from Azure Monitor with the following exceptions:

• The first letter in each column name will be capitalized, for instance correlationId in Azure Monitor will be CorrelationId in Log Analytics.

• The column Level will be dropped.

• The dynamic column properties will be preserved as the below dynamic JSON blob type:

  Azure Monitor column	Log Analytics column	Type
  $.properties.UserProperties	UserProperties	Dynamic
  $.properties.Annotations	Annotations	Dynamic
  $.properties.Input	Input	Dynamic
  $.properties.Output	Output	Dynamic
  $.properties.Error.errorCode	ErrorCode	int
  $.properties.Error.message	ErrorMessage	string
  $.properties.Error	Error	Dynamic
  $.properties.Predecessors	Predecessors	Dynamic
  $.properties.Parameters	Parameters	Dynamic
  $.properties.SystemParameters	SystemParameters	Dynamic
  $.properties.Tags	Tags	Dynamic

Metrics

Azure Monitor enables you to consume telemetry to gain visibility into the performance and health of your workloads on Azure. The most important type of Azure telemetry data is the metrics (also called performance counters) emitted by most Azure resources. Azure Monitor provides several ways to configure and consume these metrics for monitoring and troubleshooting.

ADFV2 emits the following metrics:

To access the metrics, complete the instructions in Azure Monitor data platform.

Monitor Data Factory Metrics with Azure Monitor

You can use Azure Data Factory integration with Azure Monitor to route data to Azure Monitor. This integration is useful in the following scenarios:

1. You want to write complex queries on a rich set of metrics that is published by Data Factory to Azure Monitor. You can also create custom alerts on these queries via Azure Monitor.

2. You want to monitor across data factories. You can route data from multiple data factories to a single Azure Monitor workspace.

For a seven-minute introduction and demonstration of this feature, watch the following video:

Configure Diagnostic Settings and Workspace

Enable Diagnostic Settings for your data factory.

1. In the portal, navigate to Azure Monitor and click on Diagnostic settings in the Settings menu.

2. Select the data factory for which you would like to set a diagnostic setting.

3. If no settings exist on the data factory you have selected, you are prompted to create a setting. Click "Turn on diagnostics."

   

   If there are existing settings on the data factory, you will see a list of settings already configured on this data factory. Click "Add diagnostic setting."

   

4. Give your setting a name and check the box for Send to Log Analytics, then select a Log Analytics workspace.

   

5. Click Save.

After a few moments, the new setting appears in your list of settings for this data factory, and diagnostic logs are streamed to that workspace as soon as new event data is generated. There may be up to 15 minutes between when an event is emitted and when it appears in Log Analytics.

Install Azure Data Factory Analytics from Azure Marketplace

Click Create and select the Workspace and Workspace settings.

Monitor Data Factory Metrics

Installing Azure Data Factory Analytics creates a default set of views that enables the following metrics:

• ADF Runs- 1) Pipeline Runs by Data Factory

• ADF Runs- 2) Activity Runs by Data Factory

• ADF Runs- 3) Trigger Runs by Data Factory

• ADF Errors- 1) Top 10 Pipeline Errors by Data Factory

• ADF Errors- 2) Top 10 Activity Runs by Data Factory

• ADF Errors- 3) Top 10 Trigger Errors by Data Factory

• ADF Statistics- 1) Activity Runs by Type

• ADF Statistics- 2) Trigger Runs by Type

• ADF Statistics- 3) Max Pipeline Runs Duration

You can visualize the above metrics, look at the queries behind these metrics, edit the queries, create alerts, and so forth.

Alerts

Sign in to the Azure portal and click Monitor > Alerts to create alerts.

Create Alerts

1. Click + New Alert rule to create a new alert.

   

2. Define the Alert condition.

   Note

   Make sure to select All in the Filter by resource type.

   

   

   

3. Define the Alert details.

   

4. Define the Action group.

   

   

   

   

Next steps

See Monitor and manage pipelines programmatically article to learn about monitoring and managing pipelines with code.