NerdGraph チュートリアル: ダッシュボードウィジェットの作成と構成

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

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

type Widget {
  id
  visualization
  layout
  title
  linkedEntities
  configuration
  rawConfiguration
  description
  link
}

どこ：

id: ウィジェットの ID。
visualizationウィジェットの視覚化タイプを文字列で指定します。例えば： viz.line 、 viz.area 。以下の例をご覧ください。
layout: ダッシュボードでのウィジェットの位置とサイズ。列の最大数は 12 です。
title: ウィジェットのタイトル。
linkedEntities: ウィジェットに関連するダッシュボードエンティティ。現在、ダッシュボードエンティティのみがサポートされています。ファセットリンク機能で使用されます。
configurationウィジェットの型付き設定。これは、最も一般的なウィジェット（エリア、バー、ビルボード、ライン、マークダウン、パイ、テーブル）を便利な型付きGraphQLで表現したものです。
rawConfigurationウィジェットの型指定のない設定。これは、ヒートマップ、ヒストグラム、ブレット、ファネルなどの型指定された設定ではカバーされていないウィジェットプロパティを保存する自由形式の方法 (JSON スカラー) です。この場合、 configurationはnullであり、 rawConfigurationはウィジェットに必要なすべてのデータが含まれています。
descriptionウィジェットに関する追加情報を提供するオプションのテキスト。ユーザーがウィジェットにカーソルを合わせたときにツールチップとして表示されます。
linkウィジェットのタイトルをクリック可能にするオプションのURL。これにより、関連するダッシュボード、ドキュメント、または外部リソースへのナビゲーションが可能になります。http://またはhttps://プロトコルを使用する必要があり、2,048文字を超えることはできません。

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

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

入力として

configurationのみを提供する必要があります。
visualization 提供された構成から推測できる限り、null にすることができます。
出力として、API は、指定した構成とrawConfigurationの JSON での生の表現を提供します。したがって、 rawConfigurationは常にすべてのウィジェット構成のスーパーセットです。

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

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

入力として

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

エリア

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

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

説明

accountId

整数

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

query

弦

ウィジェットのデータを提供する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

整数

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

query

弦

ウィジェットのデータを提供する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

整数

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

query

弦

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

thresholds

[オブジェクト］

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

alertSeverity: NOT_ALERTING 、 WARNING 、およびCRITICALのいずれかです。
value: アラートグループのしきい値。

{  
  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

整数

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

query

弦

ウィジェットのデータを提供する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"
      }
    ]
  }
}

マークダウン

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

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

説明

text

弦

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

{
  "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

整数

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

query

弦

ウィジェットのデータを提供する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

整数

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

query

弦

ウィジェットのデータを提供する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"
      }
    ]
  }
}

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

ウィジェットのデータ要素	説明
`duration` ロング	要求されたタイム・ウィンドウの期間（ミリ秒単位）。 `endTime`を指定すると、タイムウィンドウは、指定された時刻で終了する最後の`x`ミリ秒に設定されます。 `endTime`が null の場合、タイムウィンドウは現在終了する最後の`x`ミリ秒に設定されます。
`endTime` ロング	オプションです。時間ウィンドウの終了時間をミリ秒単位で指定します。
`entityIds` [Integer]	データを取得するソースエージェントIDの配列。
`metrics` [オブジェクト］	`type` `SCOPE_BREAKDOWN`のみ。取得するメトリックのリスト。
`type` 弦	事前定義されたチャートのタイプ。`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

整数

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

query

弦

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

limit

浮く

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

{
  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

整数

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

query

弦

ウィジェットのデータを提供する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

整数

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

query

弦

ウィジェットのデータを提供する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, \n WHERE name ='Controller/about/main' AS 'Step 1', \n WHERE name ='Controller/about/careers' AS 'Step 2') \n FROM PageView"
      }
    ]
  }
}

ヒートマップ

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

説明

accountId

整数

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

query

弦

ウィジェットのデータを提供する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

整数

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

query

弦

ウィジェットのデータを提供する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

整数

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

filters

オブジェクト

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

sources

[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

整数

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

query

弦

ウィジェットのデータを提供する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" } }`
`duration` ロング	要求されたタイム・ウィンドウの期間（ミリ秒単位）。 `endTime`を指定すると、タイムウィンドウは、指定された時刻で終了する最後の`x`ミリ秒に設定されます。 `endTime`が null の場合、タイムウィンドウは現在終了する最後の`x`ミリ秒に設定されます。
`endTime` ロング	タイムウィンドウの終了時刻をミリ秒単位で指定します。
`entityIds` [Integer]	データを取得するソースエージェントIDの配列。
`facet` 弦	オプション。指定された属性でデータをファセットします。`host` 、 `agent` 、 `application` 、または`mobile_version`のいずれかです。
`limit` 整数	任意です。返すべきシリーズの最大量
`metrics` [オブジェクト］	フェッチするメトリクスのリスト。
`orderBy` 弦	オプションです。結果を降順でソートするために使用します。

{
  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` [オブジェクト］	任意です。マップから除外するエンティティ。
`primaryEntities` [オブジェクト］	マップを開始する主なエンティティ（最も上流）。

{
  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 チュートリアル: ダッシュボード ウィジェットの作成と構成

ウィジェットスキーマとタイプ .css-21sua1{background:none;border:none;width:0;padding:0;}

ウィジェットの種類

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

型付きウィジェット定義

エリア

入力

出力

バー

入力

出力

ビルボード

入力

出力

折れ線グラフ

入力

出力

マークダウン

入力

出力

パイ

入力

出力

テーブル

入力

出力

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

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

入力

出力

弾丸

入力

出力

イベントフィード

入力

出力

ファネル

入力

出力

ヒートマップ

入力

出力

ヒストグラム

入力

出力

インベントリ

入力

出力

JSON

入力

出力

ライン（測定値）

入力

出力

サービスマップ

入力

出力

NerdGraph チュートリアル: ダッシュボードウィジェットの作成と構成

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