指標エンドポイント
可観測性指標は、Adobe Experience Platformの様々な機能の使用状況の統計、過去の傾向およびパフォーマンス指標に関するインサイトを提供します。 Observability Insights API の /metrics
エンドポイントを使用すると、Platform での組織のアクティビティの指標データをプログラムによって取得できます。
はじめに
このガイドで使用する API エンドポイントは、Observability Insights API の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。
観察性指標の取得
/metrics
エンドポイントに対してPOSTリクエストを実行し、取得する指標をペイロードで指定することで、指標データを取得できます。
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}' \
-H 'x-sandbox-id: {SANDBOX_ID}'
-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"
},
{
"name": "timeseries.ingestion.dataset.dailysize",
"filters": [
{
"name": "dataSetId",
"value": "5eddb21420f516191b7a8dad",
"groupBy": false
}
],
"aggregator": "sum",
}
]
}'
start
end
granularity
DAY
の場合は、start
日から end
日までの各日の指標が返されますが、値が MONTH
の場合は、指標の結果が月でグループ化されます。metrics
name
filters
特定のデータセットで指標をフィルタリングできるオプションのフィールド。 フィールドはオブジェクトの配列(フィルターごとに 1 つ)で、各オブジェクトには次のプロパティが含まれます。
name
:指標をフィルタリングするエンティティのタイプ。 現在は、dataSets
のみがサポートされています。value
: 1 つ以上のデータセットの ID。 複数のデータセット ID を 1 つの文字列として指定し、各 ID を縦棒(|
)で区切ることができます。groupBy
: true に設定した場合、対応するvalue
が、指標の結果を個別に返す必要がある複数のデータセットを表すことを示します。 false に設定した場合、これらのデータセットの指標の結果はグループ化されます。
aggregator
応答
応答が成功すると、リクエストで指定された指標とフィルターの結果のデータポイントが返されます。
{
"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 に設定された場合、このオブジェクトには、対応する dps
プロパティが適用されるデータセットの ID が含まれます。応答でこのオブジェクトが空と表示される場合、対応する
dps
プロパティは、filters
配列で提供されるすべてのデータセット(またはフィルターが指定されていない場合は Platform のすべてのデータセット)に適用されます。dps
granularity
値によって異なります。付録
次の節では、/metrics
エンドポイントの操作に関する追加情報を示します。
使用可能な指標 available-metrics
次の表に、Observability Insights によって公開されるすべての指標をサービス別に分類し Platform 示します。 各指標には、説明と受け入れられた ID クエリーパラメーターが含まれます。
Data Ingestion ingestion
次の表に、Adobe Experience Platform Data Ingestion の指標の概要を示します。 太字 の指標はストリーミング取得指標です。
Identity Service identity
次の表に、Adobe Experience Platform Identity Service の指標の概要を示します。
Real-Time Customer Profile profile
次の表に、Real-Time Customer Profile の指標の概要を示します。
エラーメッセージ
/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
次の表に、API から返される可能性のある様々なエラーコードを示します。
INSGHT-1000-400
リクエストペイロードに問題が発生しました。 ペイロード形式が 上記と完全に一致することを確認してください。 考えられる理由のいずれかにより、このエラーがトリガーする場合があります。
aggregator
などの必須フィールドがありません- 無効な指標
- リクエストに無効なアグリゲータが含まれています
- 開始日は終了日の後に行われます
INSGHT-1001-400
INSGHT-1001-500
INSGHT-1002-500
INSGHT-1003-401
x-sandbox-name
ヘッダーで指定したサンドボックス名が、組織に対して有効な有効なサンドボックスを表していることを確認してください。