Show Menu
ARGOMENTI×

Panoramica sull'osservabilità Adobe Experience Platform

Observability Insights è una RESTful API che consente di esporre le metriche di osservabilità chiave in Adobe Experience Platform. Queste metriche forniscono informazioni approfondite sulle statistiche di Platform utilizzo, sui controlli dello stato dei Platform servizi, sulle tendenze storiche e sugli indicatori di prestazioni per diverse Platform funzionalità.
Questo documento illustra una chiamata di esempio all'API Observability Insights. Per un elenco completo degli endpoint di osservabilità, fare riferimento al riferimento API Observability Insights.

Introduzione

Per effettuare chiamate alle Platform API, è prima necessario completare l'esercitazione sull' autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate Experience Platform API, come illustrato di seguito:
  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform sono isolate in sandbox virtuali specifiche. Tutte le richieste alle Platform API richiedono un'intestazione che specifica il nome della sandbox in cui avrà luogo l'operazione. Per ulteriori informazioni sulle sandbox in Platform, consultate la documentazione sulla panoramica della sandbox.
  • x-sandbox-name: {SANDBOX_NAME}

Recuperare le metriche di osservabilità

Potete recuperare le metriche di osservabilità effettuando una richiesta di GET all' /metrics endpoint nell'API Observability Insights.
Formato API
Quando si utilizza l' /metrics endpoint, è necessario fornire almeno un parametro di richiesta della metrica. Altri parametri di query sono facoltativi per filtrare i risultati.
GET /metrics?metric={METRIC}
GET /metrics?metric={METRIC}&metric={METRIC_2}
GET /metrics?metric={METRIC}&id={ID}
GET /metrics?metric={METRIC}&dateRange={DATE_RANGE}
GET /metrics?metric={METRIC}&metric={METRIC_2}&id={ID}&dateRange={DATE_RANGE}

Parametro
Descrizione
{METRIC}
La metrica da esporre. Quando combini più metriche in una singola chiamata, devi usare una e commerciale ( & ) per separare le singole metriche. Ad esempio, metric={METRIC_1}&metric={METRIC_2} .
{ID}
Identificatore per una particolare Platform risorsa di cui si desidera esporre le metriche. Questo ID può essere facoltativo, obbligatorio o non applicabile a seconda delle metriche utilizzate. Per un elenco delle metriche disponibili, nonché degli ID supportati (obbligatori e facoltativi) per ciascuna metrica, consultate il documento di riferimento sulle metriche Elenco delle metriche disponibili disponibili.
{DATE_RANGE}
L'intervallo di date per le metriche da esporre, in formato ISO 8601 (ad esempio, 2018-10-01T07:00:00.000Z/2018-10-09T07:00:00.000Z ).
Richiesta
curl -X GET \
  https://platform.adobe.io/data/infrastructure/observability/insights/metrics?metric=timeseries.ingestion.dataset.size&metric=timeseries.ingestion.dataset.recordsuccess.count&id=5cf8ab4ec48aba145214abeb&dateRange=2018-10-01T07:00:00.000Z/2019-06-06T07:00:00.000Z \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Risposta
Una risposta corretta restituisce un elenco di oggetti, ciascuno contenente una marca temporale all'interno dei valori forniti dateRange e corrispondenti per le metriche specificate nel percorso della richiesta. Se il percorso id di richiesta include una Platform risorsa, i risultati verranno applicati solo a tale risorsa. Se id viene omesso, i risultati verranno applicati a tutte le risorse applicabili all'interno dell'organizzazione IMS.
{
    "id": "5cf8ab4ec48aba145214abeb",
    "imsOrgId": "{IMS_ORG}",
    "timeseries": {
        "granularity": "MONTH",
        "items": [
            {
                "timestamp": "2019-06-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 1125,
                    "timeseries.ingestion.dataset.size": 32320
                }
            },
            {
                "timestamp": "2019-05-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 1003,
                    "timeseries.ingestion.dataset.size": 31409
                }
            },
            {
                "timestamp": "2019-04-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 740,
                    "timeseries.ingestion.dataset.size": 25809
                }
            },
            {
                "timestamp": "2019-03-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 740,
                    "timeseries.ingestion.dataset.size": 25809
                }
            },
            {
                "timestamp": "2019-02-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 390,
                    "timeseries.ingestion.dataset.size": 16801
                }
            }
        ],
        "_page": null,
        "_links": null
    },
    "stats": {}
}

Passaggi successivi

Questo documento fornisce una panoramica dell'API Observability Insights. Consultate il documento sulle metriche Elenco delle metriche disponibili disponibili per un elenco completo delle metriche utilizzabili nell'API.