Endpunkt "Metriken"
Beobachtbarkeitsmetriken bieten Einblicke in Nutzungsstatistiken, historische Trends und Leistungsindikatoren für verschiedene Funktionen in Adobe Experience Platform. Die /metrics
-Endpunkt im Observability Insights API ermöglicht Ihnen das programmgesteuerte Abrufen von Metrikdaten für die Aktivität Ihres Unternehmens in Platform.
Erste Schritte
Der in diesem Handbuch verwendete API-Endpunkt ist Teil der Observability Insights API. Bevor Sie fortfahren, lesen Sie im Handbuch Erste Schritte die Links zu entsprechenden Dokumentationen, den Leitfaden zum Lesen der Beispiel-API-Aufrufe in diesem Dokument und wichtige Informationen zu Kopfzeilen, die für das erfolgreiche Aufrufen einer Experience Platform-API erforderlich sind.
Beobachtbarkeitsmetriken abrufen
Sie können Metrikdaten abrufen, indem Sie eine POST-Anfrage an die /metrics
-Endpunkt, der die Metriken angibt, die Sie in der Payload abrufen möchten.
API-Format
POST /metrics
Anfrage
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
gibt Metriken für jeden Tag zwischen start
und end
Datum, während der Wert MONTH
würde die Metrikergebnisse stattdessen nach Monat gruppieren. Bei Verwendung dieses Felds muss die downsample
-Eigenschaft muss auch angegeben werden, mit welcher Aggregationsfunktion Daten gruppiert werden sollen.metrics
name
filters
Ein optionales Feld, mit dem Sie Metriken nach bestimmten Datensätzen filtern können. Das Feld ist ein Array von Objekten (eines für jeden Filter), wobei jedes Objekt die folgenden Eigenschaften enthält:
name
: Der Typ der Entität, nach der Metriken gefiltert werden sollen. Derzeit wird nurdataSets
unterstützt.value
: Die ID eines oder mehrerer Datensätze. Mehrere Datensatz-IDs können als einzelne Zeichenfolge angegeben werden, wobei jede ID durch vertikale Balkenzeichen (|
).groupBy
: Wenn auf "true"gesetzt, zeigt an, dass die entsprechendevalue
stellt mehrere Datensätze dar, deren Metrikergebnisse separat zurückgegeben werden sollten. Wenn der Wert auf "false"gesetzt ist, werden die Metrikergebnisse für diese Datensätze gruppiert.
aggregator
downsample
granularity
-Eigenschaft. Ausführliche Informationen zum Downsampling finden Sie im Abschnitt OpenTSDB-Dokumentation.Antwort
Eine erfolgreiche Antwort gibt die resultierenden Datenpunkte für die in der Anfrage angegebenen Metriken und Filter zurück.
{
"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
-Eigenschaft für eine Metrik und die groupBy
in der Anfrage auf true festgelegt wurde, enthält dieses Objekt die Kennung des Datensatzes, zu dem die entsprechende dps
-Eigenschaft gilt für .Wenn dieses Objekt in der Antwort leer erscheint, wird die entsprechende
dps
-Eigenschaft gilt für alle Datensätze, die im filters
Array (oder alle Datensätze in Platform , wenn keine Filter angegeben wurden).dps
granularity
-Wert, der in der Anfrage angegeben ist.Anhang
Im folgenden Abschnitt finden Sie weitere Informationen zum Arbeiten mit der /metrics
-Endpunkt.
Verfügbare Metriken available-metrics
In den folgenden Tabellen sind alle Metriken aufgeführt, die durch Observability Insights, aufgeschlüsselt nach Platform Dienst. Jede Metrik enthält eine Beschreibung und einen akzeptierten ID-Abfrageparameter.
Data Ingestion ingestion
In der folgenden Tabelle sind die Metriken für Adobe Experience Platform aufgeführt Data Ingestion. Metriken in Fettdruck sind Streaming-Erfassungsmetriken.
Identity Service identity
In der folgenden Tabelle sind die Metriken für Adobe Experience Platform aufgeführt Identity Service.
Real-Time Customer Profile profile
In der folgenden Tabelle sind die Metriken für Real-Time Customer Profile.
Fehlermeldungen
Antworten von /metrics
Endpunkt kann unter bestimmten Bedingungen Fehlermeldungen zurückgeben. Diese Fehlermeldungen werden im folgenden Format zurückgegeben:
{
"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
In der folgenden Tabelle sind die verschiedenen Fehlercodes aufgeführt, die von der API zurückgegeben werden können:
INSGHT-1000-400
Mit der Anfrage-Payload ist etwas nicht in Ordnung. Stellen Sie sicher, dass Sie die Payload-Formatierung genau wie folgt einhalten above. Dieser Fehler kann aus allen möglichen Gründen Trigger werden:
- Erforderliche Felder fehlen, z. B.
aggregator
- Ungültige Metriken
- Die Anfrage enthält einen ungültigen Aggregator
- Ein Startdatum liegt nach dem Enddatum
INSGHT-1001-400
INSGHT-1001-500
INSGHT-1002-500
INSGHT-1003-401
x-sandbox-name
-Kopfzeile stellt eine gültige, aktivierte Sandbox für Ihre Organisation dar, bevor Sie die Anfrage erneut ausführen.