Mätvärden för observerbarhet ger insikt i användningsstatistik, historiska trender och resultatindikatorer för olika funktioner i Adobe Experience Platform. The /metrics
slutpunkt i Observability Insights API gör att du kan hämta mätdata för organisationens aktiviteter i Platform.
Den tidigare versionen av måttslutpunkten (V1) har tagits bort. Det här dokumentet fokuserar enbart på den aktuella versionen (V2). Mer information om V1-slutpunkten för äldre implementeringar finns i API-referens.
API-slutpunkten som används i den här guiden är en del av Observability Insights API. Läs igenom komma igång-guide för länkar till relaterad dokumentation, en guide till hur du läser exempel-API-anrop i det här dokumentet och viktig information om vilka huvuden som behövs för att kunna ringa anrop till Experience Platform API.
Du kan hämta mätdata genom att göra en POST-förfrågan till /metrics
slutpunkt, ange de mått som du vill hämta i nyttolasten.
API-format
POST /metrics
Begäran
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"
}
]
}'
Egenskap | Beskrivning |
---|---|
start |
Det tidigaste datum/den tidigaste tid från vilken mätdata ska hämtas. |
end |
Det senaste datumet/den senaste tiden från vilket mätdata ska hämtas. |
granularity |
Ett valfritt fält som anger tidsintervallet för att dividera mätdata med. Ett värde på DAY returnerar mått för varje dag mellan start och end datum, medan värdet MONTH skulle gruppera mätresultaten per månad i stället. När du använder det här fältet, en downsample Egenskapen måste också anges för att ange den aggregeringsfunktion som data ska grupperas efter. |
metrics |
En array med objekt, en för varje mätvärde som du vill hämta. |
name |
Namnet på ett mätvärde som identifieras av observabilitetsinsikter. Se appendix om du vill ha en fullständig lista över godkända måttnamn. |
filters |
Ett valfritt fält där du kan filtrera mätvärden efter specifika datauppsättningar. Fältet är en array med objekt (ett för varje filter), där varje objekt innehåller följande egenskaper:
|
aggregator |
Anger den aggregeringsfunktion som ska användas för att gruppera poster med flera serier till enstaka resultat. Detaljerad information om tillgängliga aggregatorer finns i OpenTSDB-dokumentation. |
downsample |
Ett valfritt fält som gör att du kan ange en aggregeringsfunktion för att minska samplingsfrekvensen för mätdata genom att sortera fält i intervall (eller"bucket"). Intervallet för nedsampling bestäms av granularity -egenskap. Mer information om nedsampling finns i OpenTSDB-dokumentation. |
Svar
Ett lyckat svar returnerar de resulterande datapunkterna för de mätvärden och filter som anges i begäran.
{
"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"
}
]
}
Egenskap | Beskrivning |
---|---|
metricResponses |
En array vars objekt representerar alla mått som anges i begäran. Varje objekt innehåller information om filterkonfigurationen och returnerade mätdata. |
metric |
Namnet på ett av måtten som anges i begäran. |
filters |
Filterkonfigurationen för det angivna måttet. |
datapoints |
En array vars objekt representerar resultatet av det angivna måttet och filtren. Antalet objekt i arrayen beror på de filteralternativ som anges i begäran. Om inga filter har angetts innehåller arrayen bara ett objekt som representerar alla datauppsättningar. |
groupBy |
Om flera datauppsättningar har angetts i filter för ett mätresultat och groupBy alternativet var inställt på true i begäran, kommer det här objektet att innehålla ID:t för datauppsättningen som motsvarar dps egenskapen gäller för.Om objektet är tomt i svaret visas motsvarande dps egenskapen gäller för alla datauppsättningar som finns i filters array (eller alla datauppsättningar i Platform om inga filter har angetts). |
dps |
Returnerade data för angivet mått, filter och tidsintervall. Varje nyckel i det här objektet representerar en tidsstämpel med ett motsvarande värde för det angivna måttet. Tidsperioden mellan varje datapunkt beror på granularity det värde som anges i begäran. |
Följande avsnitt innehåller ytterligare information om hur du arbetar med /metrics
slutpunkt.
I följande tabeller visas alla mätvärden som visas av Observability Insights, uppdelat efter Platform service. Varje mätvärde innehåller en beskrivning och en godkänd ID-frågeparameter.
Alla ID-frågeparametrar i listan är valfria om inget annat anges.
I följande tabell visas mätvärden för Adobe Experience Platform Data Ingestion. Mätvärden i fet är mätvärden för direktuppspelad konsumtion.
Insikter - mått | Beskrivning | ID-frågeparameter |
---|---|---|
timeseries.ingestion.dataset.size | Kumulativ storlek för alla data som har importerats för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.ingestion.dataset.dailysize | Storlek på data som hämtas dagligen för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.ingestion.dataset.batchfailed.count | Antal misslyckade batchar för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.ingestion.dataset.batchsuccess.count | Antal batchar som har importerats för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.ingestion.dataset.recordsuccess.count | Antal poster som har importerats för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.data.collection.validation.category.presence.count | Totalt antal ogiltiga närvaromeddelanden för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.data.collection.inlet.total.messages.receive | Totalt antal meddelanden som tagits emot för ett dataintag eller för alla datainmatningar. | Intag-ID |
timeseries.data.collection.inlet.total.messages.size.receive | Total storlek på data som tagits emot för ett dataintag eller för alla datainmatningar. | Intag-ID |
timeseries.data.collection.inlet.success | Totalt antal lyckade HTTP-anrop till ett dataintag eller till alla datainmatningar. | Intag-ID |
timeseries.data.collection.inlet.error | Totalt antal misslyckade HTTP-anrop till en datainmatning eller till alla datainmatningar. | Intag-ID |
I följande tabell visas mätvärden för Adobe Experience Platform Identity Service.
Insikter - mått | Beskrivning | ID-frågeparameter |
---|---|---|
timeseries.identity.dataset.recordsuccess.count | Antal poster som skrivits till datakällan per Identity Service, för en datauppsättning eller alla datauppsättningar. | Datauppsättnings-ID |
timeseries.identity.dataset.recordfailed.count | Antal poster som misslyckades av Identity Service, för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.identity.dataset.namespacecode.recordfailed.count | Antal Identity-poster som misslyckades av ett namnutrymme. | Namnområdes-ID (Obligatoriskt) |
timeseries.identity.dataset.namespacecode.recordskipped.count | Antal Identitetsposter som hoppats över av ett namnutrymme. | Namnområdes-ID (Obligatoriskt) |
timeseries.identity.graph.imsorg.uniqueidentities.count | Antal unika identiteter som lagras i identitetsdiagrammet för din IMS-organisation. | Ej tillämpligt |
timeseries.identity.graph.imsorg.namespacecode.uniqueidentities.count | Antal unika identiteter som lagras i identitetsdiagrammet för ett namnutrymme. | Namnområdes-ID (Obligatoriskt) |
timeseries.identity.graph.imsorg.graphstrength.uniqueidentities.count | Antal unika identiteter som lagras i identitetsdiagrammet för IMS-organisationen för en viss grafikstyrka ("unknown","svag" eller"strong"). | Diagramstyrka (Obligatoriskt) |
Följande tabell visar mätvärden för Real-time Customer Profile.
Insikter - mått | Beskrivning | ID-frågeparameter |
---|---|---|
timeseries.profiles.dataset.recordread.count | Antal poster som har lästs från Data Lake av Profile, för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.profiles.dataset.recordsuccess.count | Antal poster som skrivits till datakällan per Profile, för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
timeseries.profiles.dataset.batchsuccess.count | Antal Profile batchar som har kapslats för en datauppsättning eller för alla datauppsättningar. | Datauppsättnings-ID |
Svar från /metrics
slutpunkten kan returnera felmeddelanden under vissa förhållanden. Dessa felmeddelanden returneras i följande format:
{
"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
}
]
}
Egenskap | Beskrivning |
---|---|
title |
En sträng som innehåller felmeddelandet och den möjliga orsaken till felet. |
report |
Innehåller sammanhangsbaserad information om felet, inklusive den sandlåda och den IMS-organisation som används i åtgärden som utlöste felet. |
I följande tabell visas de olika felkoderna som kan returneras av API:t:
Felkod | Titel | Beskrivning |
---|---|---|
INSGHT-1000-400 |
Ogiltig nyttolast för begäran | Något var fel med nyttolasten för begäran. Kontrollera att du matchar nyttolastens formatering exakt som den visas ovan. Alla möjliga orsaker kan utlösa det här felet:
|
INSGHT-1001-400 |
Mätningsfrågan misslyckades | Det uppstod ett fel när mätdatabasen skulle frågas på grund av en felaktig begäran eller att själva frågan inte kunde tolkas. Kontrollera att din begäran är korrekt formaterad innan du försöker igen. |
INSGHT-1001-500 |
Mätningsfrågan misslyckades | Det uppstod ett fel när mätdatabasen skulle frågas på grund av ett serverfel. Försök igen. Om problemet kvarstår kan du kontakta Adobe support. |
INSGHT-1002-500 |
Tjänstfel | Begäran kunde inte behandlas på grund av ett internt fel. Försök igen. Om problemet kvarstår kan du kontakta Adobe support. |
INSGHT-1003-401 |
Valideringsfel för sandlådan | Begäran kunde inte behandlas på grund av ett valideringsfel i sandlådan. Kontrollera att namnet på sandlådan som du angav finns i x-sandbox-name header representerar en giltig, aktiverad sandlåda för din IMS-organisation innan du försöker utföra begäran igen. |