설명서Experience PlatformObservability Insights 안내서

지표 엔드포인트

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

작성 대상:

  • 개발자

가시성 지표는 Adobe Experience Platform의 다양한 기능에 대한 사용 통계, 내역 트렌드 및 성능 지표에 대한 통찰력을 제공합니다. Observability Insights API의 /metrics 끝점을 사용하면 Platform에서 조직의 활동에 대한 지표 데이터를 프로그래밍 방식으로 검색할 수 있습니다.

NOTE
이전 버전의 지표 끝점(V1)은 더 이상 사용되지 않습니다. 이 문서는 현재 버전(V2)에만 중점을 둡니다. 레거시 구현을 위한 V1 끝점에 대한 자세한 내용은 API 참조를 참조하십시오.

시작하기

이 가이드에 사용된 API 끝점은 Observability Insights API의 일부입니다. 계속하기 전에 시작 안내서를 검토하여 관련 문서에 대한 링크, 이 문서의 샘플 API 호출 읽기 지침 및 Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보를 확인하십시오.

가시성 지표 검색

페이로드에서 검색하려는 지표를 지정하여 /metrics 끝점에 대한 POST 요청을 수행하여 지표 데이터를 검색할 수 있습니다.

API 형식

POST /metrics

요청

curl -X POST \
  https://platform.adobe.io/data/infrastructure/observability/insights/metrics \
  -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}' \
  -d '{
        "start": "2020-07-14T00:00:00.000Z",
        "end": "2020-07-22T00:00:00.000Z",
        "granularity": "day",
        "metrics": [
          {
            "name": "timeseries.ingestion.dataset.recordsuccess.count",
            "filters": [
              {
                "name": "dataSetId",
                "value": "5edcfb2fbb642119194c7d94|5eddb21420f516191b7a8dad",
                "groupBy": true
              }
            ],
            "aggregator": "sum",
            "downsample": "sum"
          },
          {
            "name": "timeseries.ingestion.dataset.dailysize",
            "filters": [
              {
                "name": "dataSetId",
                "value": "5eddb21420f516191b7a8dad",
                "groupBy": false
              }
            ],
            "aggregator": "sum",
            "downsample": "sum"
          }
        ]
      }'
속성
설명
start
지표 데이터를 검색할 가장 빠른 날짜/시간입니다.
end
지표 데이터를 검색할 최신 날짜/시간입니다.
granularity
지표 데이터를 나눌 시간 간격을 나타내는 선택 필드입니다. 예를 들어 값 DAY은(는) start과(와) end 날짜 사이의 각 날에 대한 지표를 반환하지만 값 MONTH은(는) 대신 월별 지표 결과를 그룹화합니다. 이 필드를 사용할 때 데이터를 그룹화할 집계 함수를 나타내려면 해당 downsample 속성도 제공해야 합니다.
metrics
검색할 각 지표에 대해 하나씩 객체의 배열입니다.
name
Observability Insights에서 인식하는 지표의 이름입니다. 허용되는 지표 이름의 전체 목록은 부록을 참조하십시오.
filters

특정 데이터 세트별로 지표를 필터링할 수 있는 선택 필드입니다. 필드는 객체 배열(각 필터에 대해 하나씩)이며, 각 객체에는 다음 속성이 포함됩니다.

  • name: 지표를 필터링할 엔터티의 유형입니다. 현재 dataSets만 지원됩니다.
  • value: 하나 이상의 데이터 세트의 ID입니다. 여러 데이터 세트 ID를 하나의 문자열로 제공할 수 있습니다. 각 ID는 세로 막대 문자(|)로 구분됩니다.
  • groupBy: true로 설정하면 해당 value이(가) 지표 결과를 별도로 반환해야 하는 여러 데이터 세트를 나타냅니다. false로 설정하면 해당 데이터 세트에 대한 지표 결과가 함께 그룹화됩니다.
aggregator
여러 시계열 레코드를 단일 결과로 그룹화하는 데 사용해야 하는 집계 함수를 지정합니다. 사용 가능한 집계자에 대한 자세한 내용은 OpenTSDB 설명서를 참조하세요.
downsample
필드를 간격 (또는 "버킷")으로 정렬하여 지표 데이터의 샘플링 속도를 줄이는 집계 함수를 지정할 수 있는 선택 필드입니다. 다운샘플링의 간격은 granularity 속성에 의해 결정됩니다. 다운샘플링에 대한 자세한 내용은 OpenTSDB 설명서를 참조하세요.

응답

성공적인 응답은 요청에 지정된 지표 및 필터에 대한 결과 데이터 포인트를 반환합니다.

{
  "metricResponses": [
    {
      "metric": "timeseries.ingestion.dataset.recordsuccess.count",
      "filters": [
        {
          "name": "dataSetId",
          "value": "5edcfb2fbb642119194c7d94|5eddb21420f516191b7a8dad",
          "groupBy": true
        }
      ],
      "datapoints": [
        {
          "groupBy": {
            "dataSetId": "5edcfb2fbb642119194c7d94"
          },
          "dps": {
            "2020-07-14T00:00:00Z": 44.0,
            "2020-07-15T00:00:00Z": 46.0,
            "2020-07-16T00:00:00Z": 36.0,
            "2020-07-17T00:00:00Z": 50.0,
            "2020-07-18T00:00:00Z": 38.0,
            "2020-07-19T00:00:00Z": 40.0,
            "2020-07-20T00:00:00Z": 42.0,
            "2020-07-21T00:00:00Z": 42.0,
            "2020-07-22T00:00:00Z": 50.0
          }
        },
        {
          "groupBy": {
            "dataSetId": "5eddb21420f516191b7a8dad"
          },
          "dps": {
            "2020-07-14T00:00:00Z": 44.0,
            "2020-07-15T00:00:00Z": 46.0,
            "2020-07-16T00:00:00Z": 36.0,
            "2020-07-17T00:00:00Z": 50.0,
            "2020-07-18T00:00:00Z": 38.0,
            "2020-07-19T00:00:00Z": 40.0,
            "2020-07-20T00:00:00Z": 42.0,
            "2020-07-21T00:00:00Z": 42.0,
            "2020-07-22T00:00:00Z": 50.0
          }
        }
      ],
      "granularity": "DAY"
    },
    {
      "metric": "timeseries.ingestion.dataset.dailysize",
      "filters": [
        {
          "name": "dataSetId",
          "value": "5eddb21420f516191b7a8dad",
          "groupBy": false
        }
      ],
      "datapoints": [
        {
          "groupBy": {},
          "dps": {
            "2020-07-14T00:00:00Z": 38455.0,
            "2020-07-15T00:00:00Z": 40213.0,
            "2020-07-16T00:00:00Z": 31476.0,
            "2020-07-17T00:00:00Z": 43705.0,
            "2020-07-18T00:00:00Z": 33227.0,
            "2020-07-19T00:00:00Z": 34977.0,
            "2020-07-20T00:00:00Z": 36735.0,
            "2020-07-21T00:00:00Z": 36737.0,
            "2020-07-22T00:00:00Z": 43715.0
          }
        }
      ],
      "granularity": "DAY"
    }
  ]
}
속성
설명
metricResponses
요청에 지정된 각 지표를 나타내는 개체가 있는 배열입니다. 각 객체에는 필터 구성 및 반환된 지표 데이터에 대한 정보가 포함되어 있습니다.
metric
요청에 제공된 지표 중 하나의 이름입니다.
filters
지정된 지표에 대한 필터 구성입니다.
datapoints
객체가 지정된 지표 및 필터의 결과를 나타내는 배열입니다. 배열의 오브젝트 수는 요청에 제공된 필터 옵션에 따라 다릅니다. 필터를 제공하지 않은 경우 배열에는 모든 데이터 세트를 나타내는 단일 객체만 포함됩니다.
groupBy
지표에 대한 filter 속성에 여러 데이터 세트가 지정되고 요청에서 groupBy 옵션이 true로 설정된 경우 이 개체에는 해당 dps 속성이 적용되는 데이터 세트의 ID가 포함됩니다.

이 개체가 응답에 비어 있으면 해당 dps 속성이 filters 배열에 제공된 모든 데이터 세트(또는 필터가 제공되지 않은 경우 Platform의 모든 데이터 세트)에 적용됩니다.
dps
주어진 지표, 필터 및 시간 범위에 대해 반환된 데이터입니다. 이 개체의 각 키는 지정된 지표에 대한 해당 값이 있는 타임스탬프를 나타냅니다. 각 데이터 지점 사이의 기간은 요청에 지정된 granularity 값에 따라 다릅니다.

부록

다음 섹션에는 /metrics 끝점 작업에 대한 추가 정보가 포함되어 있습니다.

사용 가능한 지표 available-metrics

다음 표에는 Observability Insights에 의해 노출되는 모든 지표가 Platform 서비스별로 분류되어 있습니다. 각 지표에는 설명 및 허용된 ID 쿼리 매개 변수가 포함되어 있습니다.

NOTE
나열된 모든 ID 쿼리 매개 변수는 달리 명시되지 않는 한 선택 사항입니다.

Data Ingestion ingestion

다음 표에서는 Adobe Experience Platform Data Ingestion에 대한 지표에 대해 간략히 설명합니다. bold ​의 지표가 스트리밍 수집 지표입니다.

Insights 지표
설명
ID 쿼리 매개 변수
timeseries.ingestion.dataset.size
또는 모든 데이터 세트에 대한 하나의 데이터 세트에 대해 수집된 모든 데이터의 누적 크기입니다.
데이터 세트 ID
timeseries.ingestion.dataset.dailysize
한 데이터 세트 또는 모든 데이터 세트에 대해 일별 사용 기준으로 수집된 데이터의 크기입니다.
데이터 세트 ID
timeseries.ingestion.dataset.batchfailed.count
하나의 데이터 세트 또는 모든 데이터 세트에 대한 배치 수가 실패했습니다.
데이터 세트 ID
timeseries.ingestion.dataset.batchsuccess.count
하나의 데이터 세트 또는 모든 데이터 세트에 대해 수집된 배치 수입니다.
데이터 세트 ID
timeseries.ingestion.dataset.recordsuccess.count
하나의 데이터 세트 또는 모든 데이터 세트에 대해 수집된 레코드 수입니다.
데이터 세트 ID
timeseries.data.collection.validation.category.presence.count
한 데이터 세트 또는 모든 데이터 세트에 대해 잘못된 "현재 상태" 메시지의 총 수입니다.
데이터 세트 ID
timeseries.data.collection.inlet.total.messages.received
하나의 데이터 인렛 또는 모든 데이터 인렛에 대해 받은 총 메시지 수입니다.
인렛 ID
timeseries.data.collection.inlet.total.messages.size.received
하나의 데이터 인렛 또는 모든 데이터 인렛에 대해 받은 총 데이터 크기입니다.
인렛 ID
timeseries.data.collection.inlet.success
하나의 데이터 인렛 또는 모든 데이터 인렛에 대한 성공한 HTTP 호출의 총 수입니다.
인렛 ID
timeseries.data.collection.inlet.failure
하나의 데이터 인렛 또는 모든 데이터 인렛에 대한 실패한 총 HTTP 호출 수
인렛 ID

Identity Service identity

다음 표에서는 Adobe Experience Platform Identity Service에 대한 지표에 대해 간략히 설명합니다.

Insights 지표
설명
ID 쿼리 매개 변수
timeseries.identity.dataset.recordsuccess.count
Identity Service이(가) 한 데이터 세트 또는 모든 데이터 세트에 대해 해당 데이터 소스에 쓴 레코드 수입니다.
데이터 세트 ID
timeseries.identity.dataset.recordfailed.count
Identity Service이(가) 한 데이터 세트 또는 모든 데이터 세트에 대해 실패한 레코드 수입니다.
데이터 세트 ID
timeseries.identity.dataset.namespacecode.recordfailed.count
네임스페이스에서 실패한 ID 레코드 수.
네임스페이스 ID(필수)
timeseries.identity.dataset.namespacecode.recordskipped.count
네임스페이스에서 건너뛴 ID 레코드 수입니다.
네임스페이스 ID(필수)
timeseries.identity.graph.imsorg.uniqueidentities.count
조직의 ID 그래프에 저장된 고유 ID 수입니다.
N/A
timeseries.identity.graph.imsorg.namespacecode.uniqueidentities.count
네임스페이스의 ID 그래프에 저장된 고유 ID 수입니다.
네임스페이스 ID(필수)
timeseries.identity.graph.imsorg.graphstrength.uniqueidentities.count
특정 그래프 강도("알 수 없음", "약함" 또는 "강함")에 대해 조직의 ID 그래프에 저장된 고유한 ID 수입니다.
그래프 강도(필수)

Real-Time Customer Profile profile

다음 표에서는 Real-Time Customer Profile에 대한 지표에 대해 간략히 설명합니다.

Insights 지표
설명
ID 쿼리 매개 변수
timeseries.profiles.dataset.recordread.count
Profile이(가) Data Lake에서 읽은 레코드 수(한 데이터 세트 또는 모든 데이터 세트에 대해).
데이터 세트 ID
timeseries.profiles.dataset.recordsuccess.count
Profile이(가) 한 데이터 세트 또는 모든 데이터 세트에 대해 해당 데이터 소스에 쓴 레코드 수입니다.
데이터 세트 ID
timeseries.profiles.dataset.batchsuccess.count
데이터 집합 또는 모든 데이터 집합에 대해 수집된 Profile개 일괄 처리 수입니다.
데이터 세트 ID

오류 메시지

/metrics 끝점의 응답이 특정 조건에서 오류 메시지를 반환할 수 있습니다. 이러한 오류 메시지는 다음 형식으로 반환됩니다.

{
    "type": "http://ns.adobe.com/aep/errors/INSGHT-1000-400",
    "title": "Bad Request - Start date cannot be after end date.",
    "status": 400,
    "report": {
        "tenantInfo": {
            "sandboxName": "prod",
            "sandboxId": "49f58060-5d47-34rd-aawf-a5384333ff12",
            "imsOrgId": "{ORG_ID}"
        },
        "additionalContext": null
    },
    "error-chain": [
        {
            "serviceId": "INSGHT",
            "errorCode": "INSGHT-1000-400",
            "invokingServiceId": "INSGHT",
            "unixTimeStampMs": 1602095177129
        }
    ]
}
속성
설명
title
오류 메시지와 발생 가능한 이유를 포함하는 문자열입니다.
report
트리거한 작업에 사용 중인 샌드박스 및 조직을 포함하여 오류에 대한 컨텍스트 정보를 포함합니다.

다음 표에는 API에서 반환할 수 있는 다양한 오류 코드가 나와 있습니다.

오류 코드
제목
설명
INSGHT-1000-400
잘못된 요청 페이로드

요청 페이로드에 문제가 있습니다. 페이로드 형식이 위와(과) 정확히 일치하는지 확인하십시오. 가능한 원인 중 하나가 이 오류를 트리거할 수 있습니다.

  • aggregator과(와) 같은 필수 필드 누락
  • 잘못된 지표
  • 요청에 잘못된 집계자가 포함되어 있습니다.
  • 시작 일자는 종료 일자 이후입니다.
INSGHT-1001-400
지표 쿼리 실패
잘못된 요청이나 쿼리 자체를 구문 분석할 수 없기 때문에 지표 데이터베이스를 쿼리하는 동안 오류가 발생했습니다. 요청 형식이 제대로 지정되었는지 확인한 후 다시 시도하십시오.
INSGHT-1001-500
지표 쿼리 실패
서버 오류로 인해 지표 데이터베이스를 쿼리하는 동안 오류가 발생했습니다. 요청을 다시 시도하고 문제가 지속되면 Adobe 지원 센터에 문의하십시오.
INSGHT-1002-500
서비스 오류
내부 오류로 인해 요청을 처리할 수 없습니다. 요청을 다시 시도하고 문제가 지속되면 Adobe 지원 센터에 문의하십시오.
INSGHT-1003-401
샌드박스 유효성 검사 오류
샌드박스 유효성 검사 오류로 인해 요청을 처리할 수 없습니다. x-sandbox-name 헤더에 입력한 샌드박스 이름이 조직에 대해 유효하고 활성화된 샌드박스를 나타내는지 확인한 후 요청을 다시 시도하십시오.
recommendation-more-help
d82ad670-3501-465b-afee-a91200fdc02c