지표 끝점

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

노트

이전 버전의 지표 엔드포인트(V1)는 더 이상 사용되지 않습니다. 이 문서는 현재 버전(V2)에만 중점을 둡니다. 이전 구현에 대한 V1 종단점에 대한 자세한 내용은 API 참조.

시작하기

이 안내서에서 사용되는 API 엔드포인트는 Observability Insights API. 계속하기 전에 시작 안내서 관련 설명서에 대한 링크의 경우, 이 문서에서 샘플 API 호출을 읽는 안내서와 모든 호출을 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보를 제공합니다 Experience Platform API.

가시성 지표 검색

에 POST 요청을 작성하여 지표 데이터를 검색할 수 있습니다 /metrics 엔드포인트, 페이로드에서 검색할 지표 지정.

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 다음 사이의 각 날에 대한 지표를 반환합니다 startend 날짜, 값 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로 설정되어 있으면 이 개체에는 해당 데이터 집합의 ID가 포함됩니다 dps 속성은 다음에 적용됩니다.

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

부록

다음 섹션에서는 /metrics 엔드포인트.

사용 가능한 지표

다음 표에는 Observability Insights: Platform 서비스. 각 지표에는 설명 및 수락된 ID 쿼리 매개 변수가 포함되어 있습니다.

노트

별도로 명시하지 않는 한 나열된 모든 ID 쿼리 매개 변수는 선택 사항입니다.

Data Ingestion

다음 표에서는 Adobe Experience Platform에 대한 지표에 대해 설명합니다 Data Ingestion. 의 지표 굵게 스트리밍 수집 지표입니다.

통찰력 지표 설명 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

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

통찰력 지표 설명 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 IMS 조직의 ID 그래프에 저장된 고유 ID 수. 해당 없음
timeseries.identity.graph.imsorg.namespacecode.uniqueidentities.count 네임스페이스에 대한 ID 그래프에 저장된 고유 ID의 수입니다. 네임스페이스 ID(필수 여부)
timeseries.identity.graph.imsorg.graphstrength.uniqueidentities.count 특정 그래프 강도("알 수 없음", "약함" 또는 "strong")에 대한 IMS 조직의 ID 그래프에 저장된 고유 ID의 수입니다. 그래프 강도(필수 여부)

Real-time Customer Profile

다음 표에서는 Real-time Customer Profile.

통찰력 지표 설명 ID 쿼리 매개 변수
timeseries.profiles.dataset.recordread.count 에서 읽은 레코드 수입니다. Data Lake by Profile한 개의 데이터 세트 또는 모든 데이터 세트에 대해 입니다. 데이터 세트 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 트리거한 작업에서 사용되는 샌드박스 및 IMS 조직을 포함하여 오류에 대한 컨텍스트 정보를 포함합니다.

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

오류 코드 Title 설명
INSGHT-1000-400 잘못된 요청 페이로드 요청 페이로드에 문제가 있습니다. 페이로드 형식을 표시된 대로 정확히 일치하는지 확인합니다 . 가능한 모든 이유가 이 오류를 트리거할 수 있습니다.
  • 필수 필드 누락(예: ) aggregator
  • 잘못된 지표
  • 요청에 잘못된 집계가 포함되어 있습니다.
  • 종료 날짜 이후에 시작 날짜가 발생합니다
INSGHT-1001-400 지표 쿼리 실패 잘못된 요청 또는 쿼리 자체를 구문 분석할 수 없어서 지표 데이터베이스를 쿼리하는 동안 오류가 발생했습니다. 다시 시도하기 전에 요청의 형식이 제대로 지정되었는지 확인하십시오.
INSGHT-1001-500 지표 쿼리 실패 서버 오류로 인해 지표 데이터베이스를 쿼리하는 동안 오류가 발생했습니다. 요청을 다시 시도하십시오. 문제가 계속되면 Adobe 지원에 문의하십시오.
INSGHT-1002-500 서비스 오류 내부 오류로 인해 요청을 처리할 수 없습니다. 요청을 다시 시도하십시오. 문제가 계속되면 Adobe 지원에 문의하십시오.
INSGHT-1003-401 샌드박스 유효성 검사 오류 샌드박스 유효성 검사 오류로 인해 요청을 처리할 수 없습니다. 에서 제공한 샌드박스 이름을 확인합니다. x-sandbox-name header는 요청을 다시 시도하기 전에 IMS 조직에 대해 유효한 활성화된 샌드박스를 나타냅니다.

이 페이지에서는