설명서Experience PlatformData Ingestion 안내서

데이터 수집 오류 진단 검색

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • 개발자

Adobe Experience Platform은 데이터를 업로드하고 수집하는 두 가지 방법을 제공합니다. 다양한 파일 형식(예: CSV)을 사용하여 데이터를 삽입할 수 있는 일괄 처리 수집이나 스트리밍 끝점을 사용하여 실시간으로 해당 데이터를 Platform에 삽입할 수 있는 스트리밍 수집을 사용할 수 있습니다.

이 문서에서는 일괄 처리 수집 모니터링, 부분 일괄 처리 수집 오류 관리 및 부분 일괄 처리 수집 유형에 대한 참조에 대한 정보를 제공합니다.

시작하기

이 안내서를 사용하려면 Adobe Experience Platform의 다음 구성 요소에 대해 이해하고 있어야 합니다.

샘플 API 호출 읽기

이 튜토리얼에서는 요청 형식을 지정하는 방법을 보여 주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 적절한 형식의 요청 페이로드가 포함됩니다. API 응답에서 반환되는 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 Experience Platform 문제 해결 안내서의 예제 API 호출을 읽는 방법에 대한 섹션을 참조하십시오.

필수 헤더에 대한 값 수집

Platform API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 튜토리얼을 완료하면 아래와 같이 모든 Experience Platform API 호출의 필수 헤더 각각에 대한 값이 제공됩니다.

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Schema Registry에 속하는 리소스를 포함한 Experience Platform의 모든 리소스는 특정 가상 샌드박스로 격리됩니다. Platform API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다.

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Platform의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.

오류 진단 다운로드 download-diagnostics

Adobe Experience Platform을 사용하면 입력 파일의 오류 진단을 다운로드할 수 있습니다. 진단은 최대 30일 동안 Platform 내에 유지됩니다.

입력 파일 나열 list-files

다음 요청은 최종 배치에 제공된 모든 파일의 목록을 검색합니다.

API 형식

GET /batches/{BATCH_ID}/meta?path=input_files
속성
설명
{BATCH_ID}
조회 중인 배치 ID입니다.

요청

curl -X GET https://platform.adobe.io/data/foundation/export/batches/af838510-2233-11ea-acf0-f3edfcded2d2/meta?path=input_files \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

응답이 성공하면 진단이 저장된 위치를 자세히 설명하는 JSON 개체가 반환됩니다.

{
    "_page": {
        "count": 1,
        "limit": 100
    },
    "data": [
        {
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/export/batches/af838510-2233-11ea-acf0-f3edfcded2d2/meta?path=input_files/fileMetaData1.json"
                }
            },
            "length": "1337",
            "name": "fileMetaData1.json"
        },
                {
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/export/batches/af838510-2233-11ea-acf0-f3edfcded2d2}/meta?path=input_files/fileMetaData2.json"
                }
            },
            "length": "1042",
            "name": "fileMetaData2.json"
        }
    ]
}

입력 파일 진단 검색 retrieve-diagnostics

서로 다른 모든 입력 파일의 목록을 검색한 후에는 다음 요청을 사용하여 개별 파일의 진단을 검색할 수 있습니다.

API 형식

GET /batches/{BATCH_ID}/meta?path=input_files/{FILE}
속성
설명
{BATCH_ID}
조회 중인 배치 ID입니다.
{FILE}
액세스 중인 파일의 이름입니다.

요청

curl -X GET https://platform.adobe.io/data/foundation/export/batches/af838510-2233-11ea-acf0-f3edfcded2d2/meta?path=input_files/fileMetaData1.json \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

응답이 성공하면 진단이 저장된 위치를 자세히 설명하는 path개의 개체가 포함된 JSON 개체가 반환됩니다. 응답은 JSON 줄 형식으로 path 개체를 반환합니다.

{"path": "F1.json"}
{"path": "etc/F2.json"}

일괄 처리 수집 오류 검색 retrieve-errors

배치에 오류가 포함되어 있으면 데이터를 다시 수집할 수 있도록 이러한 오류에 대한 오류 정보를 검색해야 합니다.

상태 확인 check-status

수집된 배치의 상태를 확인하려면 GET 요청의 경로에 배치 ID를 제공해야 합니다. 이 API 호출 사용에 대한 자세한 내용은 카탈로그 끝점 안내서를 참조하십시오.

API 형식

GET /catalog/batches/{BATCH_ID}
GET /catalog/batches/{BATCH_ID}?{FILTER}
매개변수
설명
{BATCH_ID}
상태를 확인할 일괄 처리의 id 값입니다.
{FILTER}
응답에서 반환된 결과를 필터링하는 데 사용되는 쿼리 매개 변수입니다. 여러 매개 변수는 앰퍼샌드(&)로 구분됩니다. 자세한 내용은 카탈로그 데이터 필터링에 대한 안내서를 참조하십시오.

요청

curl -X GET https://platform.adobe.io/data/foundation/catalog/batches/af838510-2233-11ea-acf0-f3edfcded2d2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

오류 없는 응답

성공적인 응답이 일괄 처리 상태에 대한 자세한 정보와 함께 반환됩니다.

{
    "af838510-2233-11ea-acf0-f3edfcded2d2": {
        "status": "success",
        "tags": {
            "acp_enableErrorDiagnostics": true,
            "acp_partialIngestionPercent": 5
        },
        "relatedObjects": [
            {
                "type": "dataSet",
                "id": "5deac2648a19d218a888d2b1"
            }
        ],
        "id": "af838510-2233-11ea-acf0-f3edfcded2d2",
        "externalId": "af838510-2233-11ea-acf0-f3edfcded2d2",
        "inputFormat": {
            "format": "parquet"
        },
        "imsOrg": "{ORG_ID}",
        "started": 1576741718543,
        "metrics": {
            "inputByteSize": 568,
            "inputFileCount": 4,
            "inputRecordCount": 519,
            "outputRecordCount": 497,
            "failedRecordCount": 0
        },
        "completed": 1576741722026,
        "created": 1576741597205,
        "createdClient": "{API_KEY}",
        "createdUser": "{USER_ID}",
        "updatedUser": "{USER_ID}",
        "updated": 1576741722644,
        "version": "1.0.5"
    }
}
속성
설명
metrics.failedRecordCount
구문 분석, 전환 또는 유효성 검사로 인해 처리할 수 없는 행의 수입니다. 이 값은 outputRecordCount에서 inputRecordCount을(를) 빼서 파생할 수 있습니다. 이 값은 errorDiagnostics이(가) 사용되는지 여부에 관계없이 모든 일괄 처리에서 생성됩니다.

오류가 있는 응답

배치에 하나 이상의 오류가 있고 오류 진단이 활성화되어 있는 경우 응답은 페이로드 자체뿐만 아니라 다운로드 가능한 오류 파일 내에서 오류에 대한 자세한 정보를 반환합니다. 오류가 포함된 배치의 상태는 여전히 성공 상태일 수 있습니다.

{
    "01E8043CY305K2MTV5ANH9G1GC": {
        "status": "success",
        "tags": {
            "acp_enableErrorDiagnostics": true,
            "acp_partialIngestionPercent": 5
        },
        "relatedObjects": [
            {
                "type": "dataSet",
                "id": "5deac2648a19d218a888d2b1"
            }
        ],
        "id": "01E8043CY305K2MTV5ANH9G1GC",
        "externalId": "01E8043CY305K2MTV5ANH9G1GC",
        "inputFormat": {
            "format": "parquet"
        },
        "imsOrg": "{ORG_ID}",
        "started": 1576741718543,
        "metrics": {
            "inputByteSize": 568,
            "inputFileCount": 4,
            "inputRecordCount": 519,
            "outputRecordCount": 514,
            "failedRecordCount": 5
        },
        "completed": 1576741722026,
        "created": 1576741597205,
        "createdClient": "{API_KEY}",
        "createdUser": "{USER_ID}",
        "updatedUser": "{USER_ID}",
        "updated": 1576741722644,
        "version": "1.0.5",
        "errors": [
           {
             "code": "INGEST-1212-400",
             "description": "Encountered 5 errors in the data. Successfully ingested 514 rows. Please review the associated diagnostic files for more details."
           },
           {
             "code": "INGEST-1401-400",
             "description": "The row has corrupted data and cannot be read or parsed. Fix the corrupted data and try again.",
             "recordCount": 2
           },
           {
             "code": "INGEST-1555-400",
             "description": "A required field is either missing or has a value of null. Add the required field to the input row and try again.",
             "recordCount": 3
           }
        ]
    }
}
속성
설명
metrics.failedRecordCount
구문 분석, 전환 또는 유효성 검사로 인해 처리할 수 없는 행의 수입니다. 이 값은 outputRecordCount에서 inputRecordCount을(를) 빼서 파생할 수 있습니다. 이 값은 errorDiagnostics이(가) 사용되는지 여부에 관계없이 모든 일괄 처리에서 생성됩니다.
errors.recordCount
지정된 오류 코드에 대해 실패한 행 수입니다. 이 값은 errorDiagnostics이(가) 활성화된 경우 only ​입니다.
NOTE
오류 진단을 사용할 수 없는 경우 대신 다음 오류 메시지가 나타납니다.
code language-json 
{
       "errors": [{
               "code": "INGEST-1211-400",
               "description": "Encountered errors while parsing, converting or otherwise validating the data. Please resend the data with error diagnostics enabled to collect additional information on failure types"
       }]
}

다음 단계 next-steps

이 튜토리얼에서는 부분 일괄 처리 수집 오류를 모니터링하는 방법을 다룹니다. 일괄 처리 수집에 대한 자세한 내용은 일괄 처리 수집 개발자 안내서를 참조하십시오.

부록 appendix

이 섹션에서는 수집 오류 유형에 대한 추가 정보를 제공합니다.

부분 일괄 처리 수집 오류 유형 partial-ingestion-types

부분 일괄 처리 수집에는 데이터를 수집할 때 세 가지 다른 오류 유형이 있습니다.

읽을 수 없는 파일 unreadable

수집된 배치에 읽을 수 없는 파일이 있는 경우 배치 자체의 오류가 첨부됩니다. 실패한 일괄 처리 검색에 대한 자세한 내용은 실패한 일괄 처리 검색 가이드를 참조하십시오.

잘못된 스키마 또는 헤더 schemas-headers

수집된 배치에 잘못된 스키마 또는 잘못된 헤더가 있는 경우 배치 자체의 오류가 첨부됩니다. 실패한 일괄 처리 검색에 대한 자세한 내용은 실패한 일괄 처리 검색 가이드를 참조하십시오.

구문 분석할 수 없는 행 unparsable

수집한 배치에 분석할 수 없는 행이 있는 경우 다음 요청을 사용하여 오류가 포함된 파일 목록을 볼 수 있습니다.

API 형식

GET /export/batches/{BATCH_ID}/meta?path=row_errors
매개변수
설명
{BATCH_ID}
오류 정보를 검색 중인 일괄 처리의 id 값입니다.

요청

curl -X GET https://platform.adobe.io/data/foundation/export/batches/01EFZ7W203PEKSAMVJC3X99VHQ/meta?path=row_errors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공한 응답은 오류가 있는 파일 목록을 반환합니다.

{
    "data": [
        {
            "name": "conversion_errors_0.json",
            "length": "1162",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/export/batches/01EFZ7W203PEKSAMVJC3X99VHQ/meta?path=row_errors%2Fconversion_errors_0.json"
                }
            }
        },
        {
            "name": "parsing_errors_0.json",
            "length": "153",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/export/batches/01EFZ7W203PEKSAMVJC3X99VHQ/meta?path=row_errors%2Fparsing_errors_0.json"
                }
            }
        }
    ],
    "_page": {
        "limit": 100,
        "count": 2
    }
}

그런 다음 진단 검색 끝점을 사용하여 오류에 대한 자세한 정보를 검색할 수 있습니다.

오류 파일 검색에 대한 샘플 응답은 다음과 같습니다.

{
    "_corrupt_record": "{missingQuotes: 'v1'}",
    "_errors": [{
        "code": "1401",
        "message": "Row is corrupted and cannot be read, please fix and resend."
    }],
    "_filename": "parsing_errors_0.json"
}
recommendation-more-help
2ee14710-6ba4-4feb-9f79-0aad73102a9a