NerdGraphチュートリアル。ダッシュボードの作成

New Relic dashboards API を使用すると、 NerdGraph を使用して、ダッシュボードを構築することができます。このドキュメントでは、ダッシュボードに追加できるさまざまな種類のウィジェットと、API を使用してそれらを作成および取得する方法について説明します。

クエリとミューテーションの出力のためのウィジェットGraphQLスキーマは次のようになります。

type Widget {
  id 
  visualization
  layout
  title
  linkedEntities
  configuration
  rawConfiguration
}

どこで？

id: ウィジェットのidです。
visualization: ウィジェットの可視化タイプを文字列で指定します。例： viz.line, viz.area.以下のの例を参照してください.
レイアウト: ダッシュボードにおけるウィジェットの位置とサイズ。列の最大数は12です。
title: ウィジェットのタイトルです。
linkedEntities: ウィジェットに関連するDashboard Entities。現在は、ダッシュボード・エンティティのみをサポートしています。ファセットのリンク機能で使用されています。
configuration: ウィジェットの型付けされた構成。 area, bar, billboard, line, markdown, pie, table といった最も一般的なウィジェットの便利な型付けされたGraphQL表現です。
rawConfiguration: ウィジェットの型付けされていない構成。これは、ヒートマップ, ヒストグラム, ビュレット, ファネルなど、型付けされた構成ではカバーされないウィジェットのプロパティを保存する自由形式の方法 (JSON スカラー)です。この場合、 構成 は NULL で、 rawConfiguration には、ウィジェットが必要とするすべてのデータが格納されます。

dashboards API は、型付きおよび型なしのウィジェットをサポートしています。

型付けされたウィジェットは、 area, bar, billboard, line, markdown, pie, and table 。これらのウィジェットは NerdGraph を使って直接作成することができ、必須項目の入力を支援してくれます。

入力として

必要なのは、 構成 を提供することだけです。
可視化 は、提供された構成から推測できる限り、NULLでも構いません。
出力として、API は提供された構成に加えて、JSON で生の表現を rawConfiguration で提供します。したがって、 rawConfiguration は、常にすべてのウィジェット構成のスーパーセットとなります。

タイプされていないウィジェットとは、 bullet, histogram, inventory など、他のすべてのウィジェットのことです。

型付けされていないウィジェットについては、提供されたJSONの形状を知り、検証します。例えば、ヒートマップは、事前に特定の構成が分かっているので、それを検証することができます。

入力として

設定 は、このケースでは考慮されません。
rawConfiguration を提供する必要があります。以下のの例を参照してください。
visualizationはnullではなく、 viz.heatmap や viz.bullet のような固定文字列でなければなりません。
出力として、APIは入力で提供されたものと正確に答えます。

エリア

エリアは複数のnrqlクエリに対応しています。

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{
  widgets: {
    configuration: {
      area: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
          }
        }
    }
    rawConfiguration: null
  }
}

{
  "visualization": "viz.area"
  "configuration": {
    "area": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
        }
      ]
    },
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": null,
    "table": null
  }
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
      }
    ]
  }
}

バー

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{  
  widgets: {
    configuration: {
      bar: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName"
          }
        }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.bar"
  "configuration": {
    "area": null, 
    "bar": { 
     "nrqlQueries": [ 
      { 
         "accountId": 12345678, 
         "query": "SELECT count(*) FROM Transaction FACET appName" 
       } 
     ] 
   },
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": null,
    "table": null
  }
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName"
      }
    ]
  }
}

ビルボード

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

閾値

[オブジェクト］

オプションです。クエリの結果を異なるグループに分類するためのしきい値の配列。

alertSeverity: NOT_ALERTING, WARNING, CRITICAL となります。
値: アラートグループのしきい値。

{  
  widgets: {
    configuration: {
      billboard: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName"
          }
        thresholds: {
          alertSeverity: CRITICAL
          value: 3
          }
        }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.billboard"
  "configuration": {
    "area": null,
    "bar": null, 
    "billboard": { 
     "nrqlQueries": [ 
       { 
         "accountId": 12345678, 
         "query": "SELECT count(*) FROM Transaction FACET appName" 
       } 
     ], 
     "thresholds": [ 
       { 
         "alertSeverity": "CRITICAL",
         "value": 3 
       } 
     ]
   },    
    "line": null,
    "markdown": null,
    "pie": null,
    "table": null
  }
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName"
      }
    ],
    "thresholds": [
      {
        "alertSeverity": "CRITICAL",
        "value": 3
      }
    ]
  }
}

折れ線グラフ

Lineは複数のnrqlクエリをサポートしています。

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{  
  widgets: {
    configuration: {
      line: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
          }
        }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.line"
  "configuration": {
    "area": null, 
    "bar": null, 
    "billboard": null,
    "line": { 
     "nrqlQueries": [ 
      { 
         "accountId": 12345678, 
         "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES" 
       } 
     ] 
   },
    "markdown": null,
    "pie": null,
    "table": null
  }
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
      }
    ]
  }
}

マークダウン

ウィジェットのデータ要素	説明
`テキスト` 文字列	マークダウン・ウィジェットで追加されるコンテンツ。

ウィジェットのデータ要素

説明

テキスト

文字列

マークダウン・ウィジェットで追加されるコンテンツ。

{
  "visualization": "viz.markdown"
  "configuration": {
    "area": null, 
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": {
      "text": "My markdown"
    },
    "pie": null,
    "table": null
  }
  "rawConfiguration": {
    "text": "My markdown"
  }
}

パイ

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{  
  widgets: {
    configuration: {
      pie: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName"
          }
        }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.pie"
  "configuration": {
    "area": null, 
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": { 
      "nrqlQueries": [ 
      { 
         "accountId": 12345678, 
         "query": "SELECT count(*) FROM Transaction FACET appName" 
       } 
     ] 
   },
    "table": null
  }
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName"
      }
    ]
  }
}

テーブル

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{  
  widgets: {
    configuration: {
      table: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction"
          }
        }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.table"
  "configuration": {
    "area": null,
    "bar": null,
    "billboard": null, 
    "line": null, 
    "markdown": null, 
    "pie": null, 
    "table": { 
     "nrqlQueries": [ 
      { 
         "accountId": 12345678, 
         "query": "SELECT count(*) FROM Transaction" 
       } 
     ] 
   }
  }
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction"
      }
    ]
  }
}

エリア（定義済みの測定基準）

ウィジェットのデータ要素	説明
`デュレーション` ロング	要求されたタイム・ウィンドウの期間（ミリ秒単位）。 `endTime` を指定すると、時間ウィンドウは、指定した時間で終わる最後の `x` ミリ秒に設定されます。 `endTime` がNULLの場合、タイムウィンドウは、今から最後の `x` ミリ秒に設定されます。
`エンドタイム` ロング	オプションです。時間ウィンドウの終了時間をミリ秒単位で指定します。
`エンティティIds` [Integer]	データを取得するソースエージェントIDの配列。
`メトリックス` [オブジェクト］	For `type` `SCOPE_BREAKDOWN` only.フェッチするメトリクスのリスト。
`種類` 文字列	定義済みのチャートのタイプ。以下のようになります。 `APPLICATION_BREAKDOWN`, `BACKGROUND_BREAKDOWN`, `BROWSER_BREAKDOWN`, `GC_RUNS_BREAKDOWN`, `SCOPE_BREAKDOWN`, `SOLR_BREAKDOWN.`

{
  widgets: {
    visualization: "viz.area"
    configuration: null
    rawConfiguration: {
      type:SCOPE_BREAKDOWN
      endTime: null
      entityIds: [1]
      metrics: [{
        name: "Mobile/Activity/Name/Display"
      }]
      duration: 3600
    }
  }
}

{
  "visualization": "viz.area"
  "configuration": null
  "rawConfiguration": {
    "type": "SCOPE_BREAKDOWN"
    "endTime": null
    "entityIds": [1]
    "metrics": [{
      "name": "Mobile/Activity/Name/Display"
    }]
    "duration": 3600
  }
}

弾丸

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

リミット

フロート

すべてのクエリの結果を比較するための目標。

{
  widgets: {
   visualization: "viz.bullet"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction"
        }
      ]    
      limit: 2.4
    }
  }
}

{
    "visualization": "viz.bullet"
    "configuration": null
    "rawConfiguration": {
      "nrqlQueries": [      
        {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction"
        }
      ]    
      "limit": 2.4
    }
  }

イベントフィード

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{
  widgets: {
   visualization: "viz.event-feed"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT * FROM InfrastructureEvent"
        }
      ]    
    }
  }
}

{
   "visualization": "viz.event-feed"
    "configuration": null
    "rawConfiguration": {
      "nrqlQueries": [      
        {
          "accountId": 12345678,
          "query": "SELECT * FROM InfrastructureEvent"
        }
     ]    
   }
 }

ファネル

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{
  widgets: {
   visualization: "viz.funnel"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT funnel(SESSION,
            WHERE name ='Controller/about/main' AS 'Step 1',
            WHERE name ='Controller/about/careers' AS 'Step 2')
            FROM PageView"
        }
      ]    
    }
  }
}

{
   "visualization": "viz.funnel"
   "configuration": null
   "rawConfiguration": {
      "nrqlQueries": [      
        {
          "accountId": 12345678,
          "query": "SELECT funnel(SESSION,
            WHERE name ='Controller/about/main' AS 'Step 1',
            WHERE name ='Controller/about/careers' AS 'Step 2')
            FROM PageView"
        }
      ]    
    }
  }

ヒートマップ

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{
  widgets: {
   visualization: "viz.heatmap"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT histogram(duration) FROM Transaction Facet appName"
        }
      ]    
    }
  }
}

{
    "visualization": "viz.heatmap"
    "configuration": null
    "rawConfiguration": {
      "nrqlQueries": [      
        {
          "accountId": 12345678,
          "query": "SELECT histogram(duration) FROM Transaction Facet appName"
        }
    ]    
  }
}

ヒストグラム

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{
  widgets: {
   visualization: "viz.histogram"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT histogram(duration) FROM Transaction"
        }
      ]    
    }
  }
}

{
   "visualization": "viz.histogram"
   "configuration": null
   "rawConfiguration": {
      "nrqlQueries": [      
        {
          "accountId": 12345678,
          "query": "SELECT histogram(duration) FROM Transaction"
        }
     ]    
  }
}

インベントリ

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

フィルター

オブジェクト

インフラストラクチャのソースに適用されるフィルタのマップ。

ソース

[String] (文字列)

データを取得するインフラストラクチャソースのリスト。詳しくは、 how inventory entries look like のドキュメントをご覧ください。

{
  widgets: {
   visualization: "infra.inventory"
    configuration: null
    rawConfiguration: {
      accountId: 12345678,  
      filters: {
          providerAccountId: "1"
         }
      sources: ["aws/elastocache/cluster","aws/elasticache/node"]
    }
  }
}

{
    "visualization": "infra.inventory"
    "configuration": null
    "rawConfiguration": {
      "accountId": 12345678,      
      "filters": {
          "providerAccountId": "1"
         }
      "sources": ["aws/elastocache/cluster","aws/elasticache/node"]
  }
}

JSON

ウィジェットのデータ要素

説明

accountId

整数

データを取得するソースアカウント。

問い合わせ

文字列

ウィジェットのデータを提供するNRQLクエリ。

{
  widgets: {
   visualization: "viz.json"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT * FROM Transaction"
        }
      ]    
    }
  }
}

{
    "visualization": "viz.json"
    "configuration": null
    "rawConfiguration": {
      "nrqlQueries": [      
        {
          "accountId": 12345678,
          "query": "SELECT * FROM Transaction"
        }
     ]    
   }
 }

ライン（測定値）

ウィジェットのデータ要素	説明
`accountId` 整数	データを取得するソースアカウント。
`compareWith` オブジェクト	オプションです。照会する追加の時間帯。例えば、以下のようになります。 `{ offsetDuration: 86400000 presentation: {"#c001", "Yesterday"} }`
`デュレーション` ロング	要求されたタイム・ウィンドウの期間（ミリ秒単位）。 `endTime` を指定すると、時間ウィンドウは、指定した時間で終わる最後の `x` ミリ秒に設定されます。 `endTime` がNULLの場合、タイムウィンドウは、今から最後の `x` ミリ秒に設定されます。
エンドタイムロング	タイムウィンドウの終了時刻をミリ秒単位で指定します。
`エンティティIds` [Integer]	データを取得するソースエージェントIDの配列。
`ファセット` 文字列	オプションです。与えられた属性によるデータのファセット。 `host`, `agent`, `application`, or `mobile_version` とすることができます。
`リミット` 整数	任意です。返すべきシリーズの最大量
`メトリックス` [オブジェクト］	フェッチするメトリクスのリスト。
`オーダーバイ` 文字列	オプションです。結果を降順でソートするために使用します。

{
  widgets: {
    visualization: "viz.line"
    configuration: null
    rawConfiguration: {
      accountId: 12345678,      
      duration: 36000
      endTime: null
      entityIds: [100]
      facet: null
      limit: null
      metrics: [{
          name: "Errors/all"
          values: ["error_rate"]
      }]
      orderBy: null
      compareWith: []
      rawMetricName: "Errors/all"
    }
  }
}

{
  "visualization": "viz.line"
  "configuration": null
  "rawConfiguration": {
    "accountId": 12345678,     
    "duration": 36000
    "endTime": null
    "entityIds": [100]
    "facet": null
    "limit": null
    "metrics": [{
        "name": "Errors/all"
        "values": ["error_rate"]
    }]
    "orderBy": null
    "compareWith": []
    "rawMetricName": "Errors/all"
  }
}

サービスマップ

ウィジェットのデータ要素	説明
`accountId` 整数	データを取得するソースアカウント。
`additionalEntities` [オブジェクト］	オプションです。含める追加のエンティティの配列です。 `Type`, `vendor`, `target`, `source` はオプションです。
`deemphasizedConditions` [オブジェクト］	オプションです。これらの条件を持つエンティティは、地図上では色あせて表示されます。
`hiddenEntities` [オブジェクト］	任意です。マップから除外するエンティティ。
`プライマリエンティティー` [オブジェクト］	マップを開始する主なエンティティ（最も上流）。

{
  widgets: {
    visualization: "topology.service-map"
    configuration: null
    rawConfiguration: {
      accountId: 12345678,       
      entitySearchQuery: "alertStatus IN ('RED')"
      additionalEntities: [{
        guid: "AAA"
        type: "APPLICATION"
        vendor: "Company inc."
        sourceGuid: "BBB"
        targetGuid: "CCC"
      }]
      deemphasizedConditions: {
        alertStatus: [GREEN]
        entityType: [APM_APPLICATION_ENTITY]
      }
      hiddenEntities: [{
        guid: "XXX_2"
        sourceGuid: "YYY_2"
        targetGuid: "ZZZ_2"
      }]
      primaryEntities: [{
        guid: "AAA"
      }]
    }
  }
}

{
  "visualization": "topology.service-map"
  "configuration": null
  "rawConfiguration": {
    "accountId": 12345678,     
    "entitySearchQuery": "alertStatus IN ('RED')"
    "additionalEntities": [{
      "guid": "AAA"
      "type": "APPLICATION"
      "vendor": "Company inc."
      "sourceGuid": "BBB"
      "targetGuid": "CCC"
    }]
    "deemphasizedConditions": {
      "alertStatus": ["GREEN"]
      "entityType": ["APM_APPLICATION_ENTITY"]
    }
    "hiddenEntities": [{
      "guid": "XXX_2"
      "sourceGuid": "YYY_2"
      "targetGuid": "ZZZ_2"
    }]
    "primaryEntities": [{
      "guid": "AAA"
    }]
  }
}

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

NerdGraphチュートリアル。ダッシュボードの作成

ウィジェットスキーマとタイプ

ウィジェットの種類

型にはまらないウィジェット

型付きウィジェット定義

エリア

入力

出力

バー

入力

出力

ビルボード

入力

出力

折れ線グラフ

入力

出力

マークダウン

入力

出力

パイ

入力

出力

テーブル

入力

出力

型にはまらないウィジェットの定義

エリア（定義済みの測定基準）

入力

出力

弾丸

入力

出力

イベントフィード

入力

出力

ファネル

入力

出力

ヒートマップ

入力

出力

ヒストグラム

入力

出力

インベントリ

入力

出力

JSON

入力

出力

ライン（測定値）

入力

出力

サービスマップ

入力

出力