流运行通知

Adobe Experience Platform允许从外部源摄取数据,同时让您能够使用来构建、标记和增强传入数据 Platform 服务。 您可以从各种来源(如Adobe应用程序、基于云的存储、数据库和许多其他来源)中摄取数据。

Flow Service API 用于收集并集中以下各异来源的客户数据: Platform. 该服务提供了一个用户界面和RESTful API,所有受支持的源均可从此API进行连接。

通过Adobe I/O事件,您可以订阅事件并使用Webhook接收有关流运行状态的通知。 这些通知包含有关流运行成功或导致运行失败的错误的信息。

本文档提供了有关如何订阅事件、注册Webhook以及接收包含有关流运行状态信息的通知的步骤。

快速入门

本教程假定您已经创建了至少一个要监视其流运行的源连接。 如果您尚未配置源连接,请首先访问 源概述 以在返回本指南之前配置您选择的源。

本文档还需要实际了解Webhook以及如何将Webhook从一个应用程序连接到另一个应用程序。 请参阅 I/O Events 文档 有关webhook的介绍。

注册webhook以获取流运行通知

要接收流运行通知,您必须使用Adobe Developer控制台向注册webhook Experience Platform 集成。

请阅读以下教程: 订阅I/O Event通知 有关如何完成此操作的详细步骤。

IMPORTANT
在订阅过程中,请确保选择 平台通知 作为事件提供程序,然后选择以下事件订阅:
  • Experience Platform源的流运行成功
  • Experience Platform源的流运行失败

接收流运行通知

在连接webhook并完成事件订阅后,您可以开始通过webhook仪表板接收流运行通知。

通知将返回信息,例如运行的引入作业数、文件大小和错误。 通知还会返回与以JSON格式运行的流关联的有效负载。 响应有效负载可分类为 sources_flow_run_successsources_flow_run_failure.

IMPORTANT
如果在流创建过程中启用了部分摄取,则包含成功和失败摄取的流将标记为 sources_flow_run_success 仅当错误数低于在流创建过程中设置的错误阈值百分比时。 如果成功的流运行包含错误,这些错误仍将作为返回有效负载的一部分包含。

成功

成功的响应返回一组 metrics 定义特定流运行的特性和规则 activities 概述如何转换数据。

{
  "event_id": "aec55616-1715-487f-8044-ba648cc8ffee",
  "event": {
    "createdAt": 1597213529158,
    "updatedAt": 1597213530760,
    "createdBy": "{CREATED_BY}",
    "updatedBy": "{UPDATED_BY}",
    "createdClient": "{CREATED_CLIENT}",
    "updatedClient": "{UPDATED_CLIENT}",
    "sandboxId": "7127a4f0-def8-11e9-83ce-e79494b1c2a5",
    "sandboxName": "prod",
    "imsOrgId": "{ORG_ID}",
    "id": "933cf9f4-cf01-4d75-bcf9-f4cf010d750a",
    "flowId": "1c6f1047-dcaf-48fe-af10-47dcaf08feaf",
    "providerRefId": "test1234",
    "etag": "\"5100ec97-0000-0200-0000-5f338b5b0000\"",
    "metrics": {
      "durationSummary": {
        "startedAtUTC": 1590512053,
        "completedAtUTC": 1590512053
      },
      "sizeSummary": {
        "inputBytes": 2048,
        "outputBytes": 1024
      },
      "recordSummary": {
        "inputRecordCount": 100,
        "outputRecordCount": 70
      },
      "fileSummary": {
        "inputFileCount": 10,
        "outputFileCount": 10
      },
      "statusSummary": {
        "status": "success"
      }
    },
    "activities": [
      {
        "id": "copyActivity",
        "updatedAtUTC": 87473822,
        "durationSummary": {
          "startedAtUTC": 1590512053,
          "completedAtUTC": 1590512053
        },
        "sizeSummary": {
          "inputBytes": 2048,
          "outputBytes": 1098
        },
        "recordSummary": {
          "inputRecordCount": 100,
          "outputRecordCount": 100
        },
        "fileSummary": {
          "inputFileCount": 10,
          "outputFileCount": 10
        },
        "statusSummary": {
          "status": "success",
          "extensions": {
            "adf/pipeline/id": "abcd",
            "adf/run/id": "1234"
          }
        },
        "sourceInfo": [
          {
            "id": "sourceConnectionId1",
            "type": "SourceConnection",
            "reference": {
              "type": "AdfRunId"
            }
          }
        ]
      },
      {
        "id": "promotionActivity",
        "updatedAtUTC": 87473822,
        "durationSummary": {
          "completedAtUTC": 1590512053
        },
        "sizeSummary": {
          "inputBytes": 1098,
          "outputBytes": 1024
        },
        "recordSummary": {},
        "fileSummary": {
          "inputFileCount": 10,
          "outputFileCount": 10,
          "extensions": {
            "manifest": {
              "fileInfo": "https://platform.adobe.io/data/foundation/export/batches/01E4TSJNM2H5M74J0XB8MFWDHK/meta?path=input_files"
            }
          }
        },
        "statusSummary": {
          "status": "success",
          "extensions": {
            "batchId": "b1",
            "acp_request_id": "1234"
          }
        },
        "targetInfo": [
          {
            "id": "targetConnectionId1",
            "type": "TargetConnection",
            "reference": {
              "type": "batch"
            }
          }
        ]
      }
    ],
    "slaCreatedAt": 1597213531124,
    "processStartTime": 1597213531213,
    "header": {
      "_adobeio": {
        "imsOrgId": "{ORG_ID}",
        "providerMetadata": "platform_notifications",
        "eventCode": "sources_flow_run_success"
      }
    },
    "transformedTime": 1597213531214
  }
}
属性
描述
metrics
定义流运行中的数据特征。
activities
定义为转换数据而执行的不同步骤和活动。
durationSummary
定义流运行的开始和结束时间。
sizeSummary
定义数据的卷(字节)。
recordSummary
定义数据的记录计数。
fileSummary
定义数据的文件计数。
fileInfo
一个URL,可指向成功摄取文件的概述。
statusSummary
定义流运行是成功还是失败。

失败

以下响应是流运行失败的示例,在处理复制的数据时出现错误。 从源复制数据时也可能出错。 失败的流运行包含有关导致运行失败的错误的信息,包括其错误和描述。

[
  {
    "messages": [
      {
        "msgType": "eventNotification",
        "version": "1.0",
        "timestamp": 1597434157622,
        "imsOrgId": "{ORG_ID}",
        "schema": {
          "name": "run-notification",
          "version": "1.0"
        },
        "provider": "FlowService",
        "_eventNotificationMeta": {
          "category": "Platform Notifications",
          "type": "sources_flow_run_failed"
        },
        "value": {
          "createdAt": 1597434147259,
          "updatedAt": 1597434157567,
          "createdBy": "{CREATED_BY}",
          "updatedBy": "{UPDATED_BY}",
          "createdClient": "{CREATED_CLIENT}",
          "updatedClient": "{UPDATED_CLIENT}",
          "sandboxId": "e49ebb00-d0fa-11e9-b164-ed6a398c8b35",
          "sandboxName": "prod",
          "imsOrgId": "{ORG_ID}",
          "id": "d9024c32-2174-4271-824c-322174627101",
          "flowId": "cf4fce79-8822-456d-8fce-798822556dc6",
          "etag": "\"0c003dbf-0000-0200-0000-5f36e92d0000\"",
          "metrics": {
            "durationSummary": {
              "startedAtUTC": 1597434147190
            },
            "sizeSummary": {
              "inputBytes": -1
            },
            "fileSummary": {
              "inputFileCount": -1
            },
            "statusSummary": {
              "status": "failed",
              "errors": [
                {
                  "code": "CONNECTOR-2001-500",
                  "message": "Error in processing (parsing, validation or transformation) the copied data."
                }
              ]
            }
          },
          "activities": [
            {
              "id": "promotionActivity",
              "updatedAtUTC": 1597434157529,
              "durationSummary": {
                "startedAtUTC": 1597434147190,
                "completedAtUTC": 1597434157212
              },
              "sizeSummary": {
                "inputBytes": -1
              },
              "recordSummary": {},
              "fileSummary": {
                "inputFileCount": -1,
                "extensions": {
                  "manifest": {
                    "fileInfo": "https://platform-stage.adobe.io/data/foundation/export/batches/6f6a900f-e40d-4f0e-9bb9-b614436c3465/meta?path=input_files"
                  }
                }
              },
              "statusSummary": {
                "status": "failed",
                "errors": [
                  {
                    "code": "CONNECTOR-2001-500",
                    "message": "Error in processing (parsing, validation or transformation) the copied data."
                  }
                ],
                "extensions": {
                  "errors": [
                    {
                      "code": "133",
                      "message": "We are unable to locate any files uploaded for this batch. Please upload files to ingest."
                    }
                  ]
                }
              },
              "targetInfo": [
                {
                  "id": "e88737aa-27b8-4795-8737-aa27b8f7959e",
                  "type": "TargetConnection",
                  "reference": {
                    "type": "Batch",
                    "ids": [
                      "6f6a900f-e40d-4f0e-9bb9-b614436c3465"
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  }
]
属性
描述
fileInfo
一个URL,可指向成功和失败引入的文件概览。
NOTE
请参阅 附录 以了解有关错误消息的详细信息。

后续步骤

您现在可以订阅事件,以便接收有关流运行状态的实时通知。 有关流运行和源的详细信息,请参阅 源概述.

附录

以下部分提供了有关使用流运行通知的其他信息。

了解错误消息 errors

从源复制数据或将复制的数据处理到时,可能会发生摄取错误 Platform. 有关特定错误的更多信息,请参阅下表。

错误
描述
CONNECTOR-1001-500
从源复制数据时出错。
CONNECTOR-2001-500
将复制的数据处理到时出错 Platform. 此错误可能与解析、验证或转换有关。
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089