Documentación Experience Platform Guía de Observability Insights

Extremo de métricas

Last update: Wed May 24 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Observability

Creado para:

Developer

Las métricas de observabilidad proporcionan perspectivas sobre las estadísticas de uso, las tendencias históricas y los indicadores de rendimiento de varias funciones de Adobe Experience Platform. El /metrics punto final en la Observability Insights API le permite recuperar mediante programación datos de métricas de la actividad de su organización en Platform.

NOTE

La versión anterior del extremo de métricas (V1) ha quedado obsoleta. Este documento se centra exclusivamente en la versión actual (V2). Para obtener más información sobre el extremo V1 para implementaciones heredadas, consulte la Referencia de API.

Primeros pasos

El extremo de API utilizado en esta guía forma parte del Observability Insights API. Antes de continuar, consulte la guía de introducción para obtener vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar correctamente llamadas a cualquier Experience Platform API.

Recuperar métricas de observabilidad

Puede recuperar los datos de las métricas realizando una solicitud del POST a /metrics punto final, especificando las métricas que desea recuperar en la carga útil.

Formato de API

POST /metrics

Solicitud

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"
          }
        ]
      }'

Propiedad

Descripción

start

La primera fecha y hora a partir de la cual se recuperarán los datos de la métrica.

end

La última fecha y hora a partir de la cual se recuperarán los datos de la métrica.

granularity

Campo opcional que indica el intervalo de tiempo por el que se dividen los datos de la métrica. Por ejemplo, un valor de DAY devuelve las métricas de cada día entre las start y end fecha, mientras que un valor de MONTH agruparía los resultados de las métricas por mes en su lugar. Al utilizar este campo, se muestra un downsample también debe proporcionarse para indicar la función de agregación mediante la cual se agrupan los datos.

metrics

Una matriz de objetos, uno para cada métrica que desee recuperar.

name

El nombre de una métrica reconocida por Observability Insights. Consulte la apéndice para obtener una lista completa de los nombres de métricas aceptados.

filters

Campo opcional que le permite filtrar métricas por conjuntos de datos específicos. El campo es una matriz de objetos (uno para cada filtro), cada uno de los cuales contiene las siguientes propiedades:

name: tipo de entidad con la que filtrar las métricas. Actualmente, solo dataSets es compatible.
value: ID de uno o más conjuntos de datos. Se pueden proporcionar varios ID de conjunto de datos como una sola cadena, separados cada ID por caracteres de barra vertical (|).
groupBy: Cuando se establece en true, indica que la variable value representa varios conjuntos de datos cuyos resultados de métricas deben devolverse por separado. Si se establece en false, los resultados de las métricas de esos conjuntos de datos se agrupan.

aggregator

Especifica la función de agregación que debe utilizarse para agrupar varios registros de series temporales en resultados únicos. Para obtener información detallada sobre los acumuladores disponibles, consulte la Documentación de OpenTSDB.

downsample

Campo opcional que permite especificar una función de agregación para reducir la tasa de muestreo de los datos de métricas ordenando los campos en intervalos (o "contenedores"). El intervalo para la disminución de resolución viene determinado por la variable granularity propiedad. Para obtener información detallada sobre la disminución de resolución, consulte la Documentación de OpenTSDB.

Respuesta

Una respuesta correcta devuelve los puntos de datos resultantes para las métricas y filtros especificados en la solicitud.

{
  "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"
    }
  ]
}

Propiedad

Descripción

metricResponses

Una matriz cuyos objetos representen cada una de las métricas especificadas en la solicitud. Cada objeto contiene información sobre la configuración del filtro y los datos de métricas devueltos.

metric

El nombre de una de las métricas proporcionadas en la solicitud.

filters

La configuración del filtro para la métrica especificada.

datapoints

Matriz cuyos objetos representan los resultados de la métrica y los filtros especificados. El número de objetos de la matriz depende de las opciones de filtro proporcionadas en la solicitud. Si no se proporcionó ningún filtro, la matriz solo contendrá un único objeto que representa todos los conjuntos de datos.

groupBy

Si se especificaron varios conjuntos de datos en la variable filter para una métrica y la propiedad groupBy se estableció en true en la solicitud, este objeto contendrá el ID del conjunto de datos que el dps La propiedad se aplica a.

Si este objeto aparece vacío en la respuesta, el correspondiente dps se aplica a todos los conjuntos de datos proporcionados en la variable filters matriz (o todos los conjuntos de datos de Platform si no se proporcionaron filtros).

dps

Los datos devueltos para la métrica, el filtro y el intervalo de tiempo dados. Cada clave de este objeto representa una marca de tiempo con un valor correspondiente para la métrica especificada. El período de tiempo entre cada punto de datos depende del granularity valor especificado en la solicitud.

Apéndice

La siguiente sección contiene información adicional sobre cómo trabajar con /metrics punto final.

Métricas disponibles available-metrics

Las siguientes tablas enumeran todas las métricas expuestas por Observability Insights, desglosado por Platform servicio. Cada métrica incluye una descripción y un parámetro de consulta de ID aceptado.

NOTE

Todos los parámetros de consulta de ID enumerados son opcionales a menos que se indique lo contrario.

Data Ingestion ingestion

La siguiente tabla describe las métricas de Adobe Experience Platform Data Ingestion. Métricas en negrita son métricas de ingesta de transmisión.

Métrica de perspectivas

Descripción

Parámetro de consulta de ID

timeseries.ingestion.dataset.size

Tamaño acumulado de todos los datos introducidos para un conjunto de datos para o todos los conjuntos de datos.

ID de conjunto de datos

timeseries.ingestion.dataset.dailysize

Tamaño de los datos introducidos diariamente para un conjunto de datos o para todos.

ID de conjunto de datos

timeseries.ingestion.dataset.batchfailed.count

Error en el número de lotes para un conjunto de datos o para todos ellos.

ID de conjunto de datos

timeseries.ingestion.dataset.batchsuccess.count

Número de lotes introducidos para un conjunto de datos o para todos ellos.

ID de conjunto de datos

timeseries.ingestion.dataset.recordsuccess.count

Número de registros ingeridos para un conjunto de datos o para todos ellos.

ID de conjunto de datos

timeseries.data.collection.validation.category.presence.count

Número total de mensajes de "presencia" no válidos para un conjunto de datos o para todos ellos.

ID de conjunto de datos

timeseries.data.collection.inlet.total.messages.received

Número total de mensajes recibidos para una entrada de datos o para todas.

ID de entrada

timeseries.data.collection.inlet.total.messages.size.received

Tamaño total de los datos recibidos para una entrada de datos o para todas.

ID de entrada

timeseries.data.collection.inlet.success

Número total de llamadas HTTP correctas a una entrada o a todas las entradas de datos.

ID de entrada

timeseries.data.collection.inlet.failure

Número total de llamadas HTTP fallidas a una entrada de datos o a todas las entradas de datos.

ID de entrada

Identity Service identity

La siguiente tabla describe las métricas de Adobe Experience Platform Identity Service.

Métrica de perspectivas

Descripción

Parámetro de consulta de ID

timeseries.identity.dataset.recordsuccess.count

Número de registros escritos en su fuente de datos por Identity Service, para un conjunto de datos o todos.

ID de conjunto de datos

timeseries.identity.dataset.recordfailed.count

Número de registros con errores de Identity Service, para un conjunto de datos o para todos.

ID de conjunto de datos

timeseries.identity.dataset.namespacecode.recordfailed.count

Número de registros de identidad erróneos por un área de nombres.

ID de área de nombres (Requerido)

timeseries.identity.dataset.namespacecode.recordskipped.count

Número de registros de identidad omitidos por un área de nombres.

ID de área de nombres (Requerido)

timeseries.identity.graph.imsorg.uniqueidentities.count

Número de identidades únicas almacenadas en el gráfico de identidades de su organización.

N/A

timeseries.identity.graph.imsorg.namespacecode.uniqueidentities.count

Número de identidades únicas almacenadas en el gráfico de identidad de un área de nombres.

ID de área de nombres (Requerido)

timeseries.identity.graph.imsorg.graphstrength.uniqueidentities.count

Número de identidades únicas almacenadas en el gráfico de identidad de su organización para una intensidad de gráfico determinada ("desconocida", "débil" o "fuerte").

Intensidad del gráfico (Requerido)

Real-Time Customer Profile profile

En la tabla siguiente se describen las métricas de Real-Time Customer Profile.

Métrica de perspectivas

Descripción

Parámetro de consulta de ID

timeseries.profiles.dataset.recordread.count

Número de registros leídos desde el Data Lake por Profile, para un conjunto de datos o para todos.

ID de conjunto de datos

timeseries.profiles.dataset.recordsuccess.count

Número de registros escritos en su fuente de datos por Profile, para un conjunto de datos o para todos.

ID de conjunto de datos

timeseries.profiles.dataset.batchsuccess.count

Número de Profile lotes ingeridos para un conjunto de datos o para todos ellos.

ID de conjunto de datos

Mensajes de error

Respuestas de la /metrics el punto de conexión puede devolver mensajes de error en ciertas condiciones. Estos mensajes de error se devuelven en el siguiente formato:

{
    "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
        }
    ]
}

Propiedad

Descripción

title

Una cadena que contiene el mensaje de error y el motivo potencial por el que puede haberse producido.

report

Contiene información contextual sobre el error, incluida la zona protegida y la organización que se está utilizando en la operación que lo activó.

En la tabla siguiente se enumeran los diferentes códigos de error que puede devolver la API:

Código de error

Título

Descripción

INSGHT-1000-400

Carga útil de solicitud incorrecta

Error en la carga útil de la solicitud. Asegúrese de que coincide con el formato de carga útil exactamente como se muestra superior. Cualquiera de las posibles razones puede almacenar en déclencheur este error:

Faltan campos obligatorios como aggregator
Métricas no válidas
La solicitud contiene un acumulador no válido
La fecha de inicio es posterior a la de finalización

INSGHT-1001-400

Error de consulta de métricas

Se ha producido un error al intentar consultar la base de datos de métricas debido a una solicitud incorrecta o a que la consulta en sí no se puede analizar. Asegúrese de que la solicitud tenga el formato correcto antes de intentarlo de nuevo.

INSGHT-1001-500

Error de consulta de métricas

Se ha producido un error al intentar consultar la base de datos de métricas, debido a un error del servidor. Vuelva a intentar la solicitud y, si el problema persiste, póngase en contacto con el servicio de soporte técnico del Adobe.

INSGHT-1002-500

Error de servicio

La solicitud no se ha podido procesar debido a un error interno. Vuelva a intentar la solicitud y, si el problema persiste, póngase en contacto con el servicio de soporte técnico del Adobe.

INSGHT-1003-401

Error de validación de zona protegida

La solicitud no se ha podido procesar debido a un error de validación de zona protegida. Asegúrese de que el nombre de la zona protegida proporcionado en la x-sandbox-name El encabezado representa una zona protegida válida y habilitada para su organización antes de volver a intentar la solicitud.

recommendation-more-help

d82ad670-3501-465b-afee-a91200fdc02c