NerdGraph 튜토리얼: 대시보드 위젯 만들기 및 구성

New Relic 대시보드 API를 사용하면 NerdGraph 를 사용하여 대시보드 를 구축할 수 있습니다. 이 문서에서는 대시보드에 추가할 수 있는 다양한 유형의 위젯과 API를 사용하여 위젯을 만들고 가져오는 방법에 대해 설명합니다.

쿼리 및 변형 출력을 위한 위젯 GraphQL 스키마는 다음과 같습니다.

type Widget {
  id 
  visualization
  layout
  title
  linkedEntities
  configuration
  rawConfiguration
}

어디에:

id: 위젯의 ID입니다.
visualization: 위젯의 시각화 유형(문자열). 예: viz.line , viz.area . 아래의 예를 참조하십시오.
layout: 대시보드에서 위젯의 위치와 크기입니다. 최대 열 수는 12개입니다.
title: 위젯의 제목입니다.
linkedEntities: 위젯과 관련된 대시보드 엔터티입니다. 현재 대시보드 엔터티만 지원합니다. 패싯 연결 기능 에서 사용됩니다.
configuration: 위젯의 입력된 구성 입니다. area , bar , billboard , line , markdown , pie 및 table 과 같은 가장 일반적인 위젯의 편리한 형식의 GraphQL 표현입니다.
rawConfiguration: 위젯의 유형이 지정되지 않은 구성 입니다. Heatmap , histogram , bullet , funnel 등과 같은 유형이 지정된 구성에서 다루지 않는 위젯 속성을 저장하는 자유 형식 방식(JSON 스칼라)입니다. 이 경우 configuration 은 null이고 rawConfiguration 은 다음에서 요구하는 모든 데이터를 보유합니다. 위젯.

대시보드 API는 유형이 지정된 위젯과 유형이 지정되지 않은 위젯을 지원합니다.

유형이 지정된 위젯은 area , bar , billboard , line , markdown , pie 및 table 입니다. 필요한 필드에 대한 지원을 제공하는 NerdGraph를 사용하여 직접 구축할 수 있습니다.

입력으로:

configuration 만 제공하면 됩니다.
visualization 제공된 구성에서 추론할 수 있는 한 null일 수 있습니다.
API는 rawConfiguration 에서 제공한 구성과 JSON의 원시 표현을 출력으로 제공합니다. 따라서 rawConfiguration 은 항상 모든 위젯 구성의 상위 집합입니다.

유형이 지정되지 않은 위젯은 총알 , 히스토그램 , 인벤토리 등과 같은 다른 모든 위젯입니다.

유형이 지정되지 않은 위젯의 경우 제공된 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` [정수]	데이터를 가져올 소스 에이전트 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

[끈]

데이터를 가져올 인프라 소스 목록입니다. 자세한 내용은 인벤토리 항목이 어떻게 보이는지 에 대한 문서를 참조하세요.

{
  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` [정수]	데이터를 가져올 소스 에이전트 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

입력

산출

선(메트릭)

입력

산출

서비스 맵

입력

산출

위젯 스키마 및 유형