NerdGraphチュートリアル。エンティティデータを見る

エンティティ検索クエリの作成をどのように始めたらよいかわからない場合は、NerdGraphを使って構築してみましょう。次に、エンティティデータと、作成したクエリ文字列を取得します。

• queryBuilder 引数で構築されたクエリ文字列を見るために、結果のクエリフィールドを要求します。

• query と queryBuilder の引数を同時に使用することはできません。

• NerdGraph GraphiQL explorer を使ってAPIを探索し、そのインラインドキュメントを使って利用可能なクエリオプションを確認することを強くお勧めします。

  {
    actor {
      entitySearch(queryBuilder: {domain: APM, type: APPLICATION}) {
        query
        results {
          entities {
            reporting
            ... on AlertableEntityOutline {
              alertSeverity
            }
          }
        }
      }
    }
  }

  コピー

インフラストラクチャ統合エンティティにはさまざまな種類があり、他のエンティティタイプとは別にリストされています。これらを調べるには、 infrastructureIntegrationType 入力引数を使用します。

• query と queryBuilder の引数を同時に使用することはできません。

• infrastructureIntegrationType を、 type 入力引数の代わりに使用します。

• NerdGraph GraphiQL explorer を使ってAPIを探索し、そのインライン・ドキュメントを使って利用可能なクエリ・オプションを確認することを強くお勧めします。

  {
    actor {
      entitySearch(queryBuilder: {infrastructureIntegrationType: F5_NODE}) {
        query
        results {
          entities {
            entityType
            domain
          }
        }
      }
    }
  }

  コピー

New Relic のアラート で監視できる任意のエンティティのアラートの重大度をフェッチします。この NerdGraph クエリは、お客様のアプリケーションから現在データを受信しているかどうかを教えてくれます（ reporting フィールドを使用）。

• エンティティが警告可能なタイプである場合、結果にはエンティティの警告の深刻度が含まれます。

• 結果に警告可能ではないエンティティが含まれている場合、 AlertableEntityOutline フィールドは含まれません。

  {
    actor {
      entitySearch(query: "name like 'nerdgraph' and alertSeverity is not null") {
        results {
          entities {
            reporting
            ... on AlertableEntityOutline {
              alertSeverity
            }
          }
        }
      }
    }
  }

  コピー

エンティティの種類によって、関連する特定のデータがあります。次のNerdGraphクエリの例では、APMアプリケーションのエンティティで利用可能なフィールドの一部を示しています。

• より詳細なサマリーデータは、お問い合わせの際にご請求いただけます。

• 他のタイプのエンティティが検索結果として返された場合、これらのフィールドは含まれません。

  {
    actor {
      entitySearch(query: "name like 'nerdgraph' and domainType = 'APM-APPLICATION'") {
        results {
          entities {
            name
            ... on ApmApplicationEntityOutline {
              apmSummary {
                errorRate
                apdexScore
                webResponseTimeAverage
                responseTimeAverage
              }
            }
          }
        }
      }
    }
  }

  コピー

エンティティの種類によって、特定のデータが関連付けられています。このNerdGraphのクエリ例では、どのエンティティタイプであるかに関わらず、すべてのエンティティの名前と、APM、ブラウザモニタリング、モバイルエンティティのエラーレートを要求しています。

• 他のタイプのエンティティが検索結果として返された場合、エラーレートフィールドは含まれません。

  {
    actor {
      entitySearch(query: "name like 'nerdgraph'") {
        results {
          entities {
            name
            ... on ApmApplicationEntityOutline {
              apmSummary {
                errorRate
              }
            }
            ... on BrowserApplicationEntityOutline {
              browserSummary {
                jsErrorRate
              }
            }
            ... on MobileApplicationEntityOutline {
              mobileSummary {
                httpErrorRate
              }
            }
          }
        }
      }
    }
  }

  コピー

この NerdGraph クエリの例では、検索結果で返されたすべてのエンティティのタグを取得しています。詳細については、 NerdGraph GraphiQL tagging tutorial をご覧ください。

{
  actor {
    entitySearch(query: "name like 'nerdgraph'") {
      results {
        entities {
          name
          tags {
            key
            values
          }
        }
      }
    }
  }
}

このNerdGraphクエリの例では、 INFRA ドメインに属し、awsRegion us-east-1 に属するエンティティをフィルタリングし、検索結果にその名前を返しています。

{
  actor {
    entitySearch(query: "domain = 'INFRA' and tags.aws.awsRegion = 'us-east-1'") {
      results {
        entities {
          name
        }
      }
    }
  }
}

さらに、所定のタグが存在するかどうかでフィルタリングすることもできます。次のクエリは、 domainType BROWSER-APPLICATION のエンティティをフィルタリングし、タグ clusterAgentId が定義されています。

{
  actor {
    entitySearch(query: "domainType = 'BROWSER-APPLICATION' and tags.clusterAgentId is not null") {
      results {
        entities {
          name
        }
      }
    }
  }
}

詳細については、 NerdGraph GraphiQL tagging tutorial をご覧ください。

このNerdGraphクエリの例では、awsRegion us-east-1 に属する domainType APM-APPLICATION ドメインのエンティティをフィルタリングし、その名前を検索結果に返します。そして結果を集約し、New Relic アカウント ID でグループ化されたエンティティの総数を得る。

{
  actor {
    entitySearch(query: "domainType = 'APM-APPLICATION'") {
      facetedCounts(facets: {facetCriterion: {facet: ACCOUNT_ID}}) {
        counts {
          count
          facet
        }
      }
    }
  }
}

さらに、タグによる集約も可能で、以下のクエリでは、awsRegion us-east-1 に属する domainType APM-APPLICATION ドメインのエンティティをフィルタリングし、結果を集約してAgent言語でグループ化されたエンティティの総数を取得しています。

{
  actor {
    entitySearch(query: "domainType = 'APM-APPLICATION' and tags.aws.awsRegion = 'us-east-1'") {
      facetedCounts(facets: {facetCriterion: {tag: "language"}}) {
        counts {
          count
          facet
        }
      }
    }
  }
}

詳細については、 NerdGraph GraphiQL tagging tutorial をご覧ください。

NerdGraph GraphiQLエクスプローラは、エンティティ検索の結果をページングして表示します。

• 検索条件により、1つのレスポンスでAPIの制限である200個のエンティティを超える結果が得られ、残りの結果を表示したい場合は、最初のリクエストで nextCursor をリクエストし、その値を別のクエリで使用して、次の"ページ" の結果を取得することができます。

• それ以上の結果がない場合、 nextCursor は null になります。

  {
    actor {
      entitySearch(query: "name like 'nerd-graph'") {
        results {
          nextCursor
          entities {
            name
          }
        }
      }
    }
  }

  コピー

  nextCursor の値を次の検索で使用します。

  {
    actor {
      entitySearch(query: "name like 'nerd-graph'") {
        results(cursor: "next_cursor_value") {
          nextCursor
          entities {
            name
          }
        }
      }
    }
  }

  コピー

NerdGraph GraphiQLエクスプローラでは、alertable is true|falseでエンティティをフィルタリングし、エンティティがalertableプロパティを持っているかどうかを表示することができます。参照： エンティティ定義

• 上記の属性のいずれかでフィルタリングすることができます。さらに、タグを使ったフィルタリングも可能です。

• Alertableはエンティティタイプの設定なので、結果に存在しないのはそのためです。

  {
    actor {
      entitySearch(query: "alertable is true") {
        results {
          entities {
            name
          }
        }
      }
    }
  }

  コピー

  クエリの中で他のフィルターと組み合わせることもできます。

  {
    actor {
      entitySearch(query: "domain='APP' and alertable is false") {
        results( {
          entities {
            name
          }
        }
      }
    }
  }

  コピー