NerdGraph チュートリアル: 履歴データのエクスポートでより大きな NRQL 応答を返す

NRQL クエリを実行するときは、応答で返されるデータポイントの数の制限やクエリのタイムアウトなど、さまざまな制限によって制限されます。履歴データのエクスポート機能を使用すると、応答で (通常の制限である 5,000の代わりに) 200,000,000 データポイントを返し、クエリタイムアウトのない NRQL クエリを実行できます。結果は 1 つ以上の JSON ファイルとして返されます。

要件

データプラスが必要です
データをエクスポートするには、コアまたはフルプラットフォームユーザーである必要があります

制限と制限

この機能に関するいくつかの制限と制限は次のとおりです。

使用制限

エクスポートのデフォルトの使用制限は次のとおりです。

エクスポートは、2億未満のイベントを返すと見積もられる必要があります
エクスポートは、50 億未満のイベントを検査するように見積もる必要があります
アカウントごとに2つ以下の同時エクスポート

より高い制限が必要な場合は、アカウント担当者にご相談ください。

データ型の制限

次のデータタイプはいずれもエクスポートに使用できません。

時間範囲の制限

履歴データのエクスポート機能は、ライブデータまたは過去12時間のデータのクエリをサポートしていません。時間範囲は、少なくとも12時間前に終了する必要があります。

クエリ構文の要件

この機能は、特定の属性名とワイルドカード（ SELECT * ）の選択をサポートします。たとえば、次のようなクエリをサポートしています。

SELECT * FROM MobileRequest SINCE 3 days ago until 2 days ago

SELECT duration, appId FROM Transaction
WHERE appName = 'interesting-application'
SINCE '2022-06-11 11:05:00-0600' UNTIL '2022-06-11 11:10:00-0600'

クエリでは次のNRQL コンポーネントcannotを使用できます。

集計関数（ sum 、 count 、 average 、 max ）
評価可能な関数 (numeric、 log、 concat) は WHERE 節でのみサポートされています
FACET
TIMESERIES
COMPARE WITH
JOIN
ネストされた集計
サブクエリ
変数バインディング
クロスアカウントクエリ

エンドポイントの詳細

履歴データのエクスポート機能は、NerdGraph APIを使用し、次の3つのエンドポイントを利用します。

createエンドポイントを使用すると、ユーザーはエクスポートとして実行するアカウント ID と NRQL を指定できます。
get details for exportエンドポイントを使用すると、ユーザーはアカウント ID とエクスポート ID (作成エンドポイントからの応答本文にあります) を指定し、それを使用してエクスポートのステータスを取得できます。エクスポートが完了すると、このエンドポイントの応答に、1 つ以上のダウンロード URL の形式で結果が表示されます。
get details for account exportsエンドポイントを使用すると、ユーザーはアカウント ID を指定して、そのアカウントのすべてのアクティブで期限切れでないエクスポートの詳細を取得できます。

クエリの例

エクスポートを作成する

NerdGraph を使用する 1 つの方法は、 NerdGraph エクスプローラーを使用することです。このセクションの手順では、NerdGraph エクスプローラーの使用に焦点を当てます。独自のスクリプトの実行に興味がある場合は、「スクリプト」を参照してください。

NerdGraphスキーマでは、 historicalDataExportCreateExportエンドポイントはmutation > historicalDataExportの下にあります。次のようなクエリを使用して、エクスポートを実行します。

応答本文にはIDを選択することをお勧めします。これは、エクスポートの詳細を取得し、結果を取得するために使用されるためです。

mutation {
  historicalDataExportCreateExport(
    accountId: YOUR_ACCOUNT_ID
    nrql: "FROM Transaction SELECT duration, appId WHERE appName = 'interesting-application' SINCE '2022-06-11 11:05:00-0600' UNTIL '2022-06-11 11:10:00-0600'"
  ) {
    percentComplete
    nrql
    status
    id
    message
  }
}

応答例

エクスポートを作成するための応答の例を次に示します。

{
  "data": {
    "historicalDataExportCreateExport": {
      "id": "609b6916-8ca9-417c-bbf8-02e4cdc3afd2",
      "message": null,
      "nrql": "FROM Transaction SELECT duration, appId WHERE appName = 'interesting-application' SINCE '2022-06-11 11:05:00-0600' UNTIL '2022-06-11 11:10:00-0600'",
      "percentComplete": 5,
      "status": "WAITING"
    }
  }
}

エクスポートをキャンセル

NerdGraph スキーマでは、 historicalDataExportCancelExport エンドポイントは mutation > historicalDataExportの下にあります。以下のようなクエリを使用して、エクスポートを実行します。

応答本文でステータスを選択して、エクスポートが正常にキャンセルされたことを確認することをお勧めします。

mutation {
  historicalDataExportCancelExport(
    accountId: YOUR_ACCOUNT_ID
    id: "YOUR_EXPORT_ID"
  ) {
    status
    id
  }
}

応答例

エクスポートをキャンセルする場合の応答の例を次に示します。

{
  "data": {
    "historicalDataExportCancelExport": {
      "id": "YOUR_EXPORT_ID",
      "status": "CANCELED"
    }
  }
}

特定のエクスポートの詳細を取得する

以下に示すように、作成エンドポイントからの応答で見つかったエクスポート ID を使用して、エクスポートの詳細を照会します。このエンドポイントは、NerdGraph の query > actor > account > historicalDataExport > exportにあります。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      historicalDataExport {
        export(id: "YOUR_EXPORT_ID") {
          availableUntil
          eventCount
          eventTypes
          id
          message
          nrql
          percentComplete
          results
          status
        }
      }
    }
  }
}

応答例

特定のエクスポートの詳細を取得するための応答は次のとおりです。

{
  "data": {
    "actor": {
      "account": {
        "historicalDataExport": {
          "export": {
            "availableUntil": 1655499642845,
            "eventCount": 1291,
            "eventTypes": ["MobileRequest"],
            "id": "4776677a-1e0f-4ad5-a790-cdbe40a1f348",
            "message": null,
            "nrql": "SELECT * FROM MobileRequest SINCE 3 days ago UNTIL 2 days ago",
            "percentComplete": 100,
            "results": ["downloadLink1", "downloadLink2"],
            "status": "COMPLETE_SUCCESS"
          }
        }
      }
    }
  }
}

アカウントのエクスポートの詳細を取得する

以下に示すように、アカウント ID を使用して、そのアカウントからのすべてのエクスポートの詳細を取得できます。エンドポイントは、 query > actor > account > historicalDataExport > exportsの下の NerdGraph スキーマにあります。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      historicalDataExport {
        exports {
          availableUntil
          eventCount
          eventTypes
          id
          message
          nrql
          percentComplete
          results
          status
        }
      }
    }
  }
}

応答例

アカウントのエクスポートの詳細を取得するための応答例は次のとおりです。

{
  "data": {
    "actor": {
      "account": {
        "historicalDataExport": {
          "exports": [
            {
              "availableUntil": 1655499642845,
              "eventCount": 1291,
              "eventTypes": ["MobileRequest"],
              "id": "4776677a-1e0f-4ad5-a790-cdbe40a1f348",
              "message": null,
              "nrql": "SELECT * FROM MobileRequest SINCE 3 days ago UNTIL 2 days ago",
              "percentComplete": 100,
              "results": ["downloadLink1", "downloadLink2"],
              "status": "COMPLETE_SUCCESS"
            }
          ]
        }
      }
    }
  }
}

スクリプトを使用する

スクリプトからプログラム的に履歴データのエクスポートをクエリすると便利な場合があります。開始するには、次のcurlコマンドが役立つ場合があります。応答の例については、「クエリの例」セクションの応答を参照してください。

重要

エクスポート NRQL クエリでは、一重引用符 ( ' ) のすべてのインスタンスをバックスラッシュ ( \' ) でエスケープする必要があります。以下のcurlコマンドは、ANSI-C 引用符が提供する機能である、 --data-raw引数の先頭の$に依存します。詳細については、公式 GNU マニュアルを参照してください。

エクスポートを作成する

bash

$curl --location --request POST 'https://api.newrelic.com/graphql' \
>     --header 'Content-Type: application/json' \
>     --header 'API-Key: $USER_API_KEY' \
>     --data-raw $'{"query":"mutation {historicalDataExportCreateExport(accountId: $ACCOUNT_ID, nrql: \\"$NRQL_QUERY_TO_EXPORT\\") {percentComplete nrql status message id}}","variables":{}}'

エクスポートをキャンセル

bash

$curl --location --request POST 'https://api.newrelic.com/graphql' \
>     --header 'Content-Type: application/json' \
>     --header 'API-Key: $USER_API_KEY' \
>     --data-raw $'{"query":"mutation {historicalDataExportCancelExport(accountId: $ACCOUNT_ID, id: \\"$YOUR_EXPORT_ID\\") { status message id}}","variables":{}}'

エクスポートの詳細を取得する

bash

$curl --location --request POST 'https://api.newrelic.com/graphql' \
>     --header 'Content-Type: application/json' \
>     --header 'API-Key: $USER_API_KEY' \
>     --data-raw $'{"query":"{actor {account(id: $ACCOUNT_ID) {historicalDataExport {export(id: \\"$YOUR_EXPORT_ID\\") {availableUntil eventCount eventTypes id message nrql percentComplete results status}}}}}","variables":{}}'

アカウントのエクスポートの詳細を取得する

bash

$curl --location --request POST 'https://api.newrelic.com/graphql' \
>     --header 'Content-Type: application/json' \
>     --header 'API-Key: $USER_API_KEY' \
>     --data-raw $'{"query":"{actor {account(id: $USER_API_KEY) {historicalDataExport {exports {availableUntil eventCount eventTypes id message nrql percentComplete results status}}}}}","variables":{}}'

結果の形式をエクスポート

クエリの結果は、2つのget detailsエンドポイントのいずれかからの結果フィールドにあります。それらは1つ以上のダウンロードリンクの形式です。結果ファイル自体は、エクスポートが実行されてから1週間有効であり、約100MB以下のGZIP圧縮JSONが含まれています。各リンクは、6時間有効になるように事前に署名されています。リンクの有効期限が切れた場合は、NerdGraphのエクスポート詳細オブジェクトを再クエリして結果を取得することで、新しいリンクを取得できます。

解凍された結果ファイルの例を以下に示します。

[
  {
    "attributes": {
      "duration": 36,
      "eventType": "Transaction",
      "accountId": YOUR_ACCOUNT_ID,
      "timestamp": 1655174793213
    }
  },
  {
    "attributes": {
      "duration": 3,
      "eventType": "MobileRequest",
      "accountId": YOUR_ACCOUNT_ID,
      "timestamp": 1655174793215
    }
  }
]

エクスポート関連のイベントに関するクエリとアラート

この機能は、エクスポートが実行されたNewRelicアカウントでカスタムイベントを生成します。アカウントで実行されたエクスポートに関する情報を取得するには、これらのイベントに関するアラートをクエリまたは作成すると便利な場合があります。

HistoricalDataExportイベントタイプには、エクスポートのステータス（ Created 、 Completed 、 Failed 、 Canceled ）、エクスポートID、エクスポートの生成元のNRQL文字列などの情報が含まれます。

クエリビルダーで実行したり、ダッシュボードに追加したりできる次のクエリは、先週作成されたすべてのエクスポートと、正常に完了してエラーが発生しなかったエクスポートの数を返します。

FROM HistoricalDataExport SELECT * WHERE status = 'Created' SINCE 1 WEEK AGO

FROM HistoricalDataExport SELECT count(*) WHERE status != 'Completed' FACET status SINCE 1 WEEK AGO

トラブルシューティング

アカウントはまだ有効になっていません

エクスポートを作成しようとすると、次のようなエラーメッセージが表示される場合があります。

Cannot query field \"historicalDataExportCreateExport\" on type \"RootMutationType\".

これを取得している場合は、エクスポート元のアカウントで履歴データのエクスポート機能がまだ有効になっていない可能性があります。質問がある場合は、要件を確認し、アカウント担当者に相談してアクセスについて質問してください。

結果リンクの有効期限が切れました

事前に署名されたURLを使用して結果をダウンロードしようとすると、次のようなエラーが表示される場合があります。

<Error>
  <Code>AccessDenied</Code>
  <Message>Request has expired</Message>
  <X-Amz-Expires>120</X-Amz-Expires>
  <Expires>2022-06-24T15:16:45Z</Expires>
  <ServerTime>2022-06-24T17:56:40Z</ServerTime>
  <RequestId>1234567890ABC</RequestId>
  <HostId>ABCD1234HOST-ID098765-XYZ</HostId>
</Error>

このようなエラーは、結果のURLの有効期限が切れていることを示しており、新しい結果のURLを取得するためにエクスポートオブジェクトを再クエリする必要があります。エクスポートを再実行する必要はありません。結果の新しいURLセットを取得するだけです。

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: 履歴データのエクスポートでより大きな NRQL 応答を返す

要件 .css-21sua1{background:none;border:none;width:0;padding:0;}

制限と制限

使用制限

データ型の制限

時間範囲の制限

クエリ構文の要件

エンドポイントの詳細

クエリの例

エクスポートを作成する

応答例

エクスポートをキャンセル

応答例

特定のエクスポートの詳細を取得する

応答例

アカウントのエクスポートの詳細を取得する

応答例

スクリプトを使用する

重要

エクスポートを作成する

エクスポートをキャンセル

エクスポートの詳細を取得する

アカウントのエクスポートの詳細を取得する

結果の形式をエクスポート

エクスポート関連のイベントに関するクエリとアラート

トラブルシューティング

アカウントはまだ有効になっていません

結果リンクの有効期限が切れました

要件