Dashboards API를 사용하면 대시보드를 만들고 관리할 수 있습니다.
NerdGraph로 시작하기
NerdGraph 및 GraphQL을 처음 사용하는 경우 먼저 NerdGraph 소개 를 읽어보십시오. Dashboards API에 이미 익숙 하다면 NerdGraph로 대시보드 생성 을 읽을 수 있습니다.
NerdGraph를 사용할 때 대시보드가 모니터링되는 앱, 호스트 및 서비스와 같은 다른 엔터티의 데이터를 보고하는 엔터티 임을 이해하는 데 도움이 됩니다.
api.newrelic.com/graphiql 에서 NerdGraph API 탐색기를 찾으십시오.
운영
목표와 범위에 따라 다양한 대시보드 작업을 실행할 수 있는 세분화된 GraphQL API를 정의했습니다.
대시보드 CRUD 작업
작업 | GraphQL 작업 유형 | Notes |
---|---|---|
actor > entity() | 질문 | 대시보드 작업을 가져옵니다. 지정된 대시보드 엔터티 GUID에 대한 모든 대시보드 및 위젯 데이터를 가져올 수 있습니다. |
dashboardCreate() | 돌연변이 | 대시보드 작업을 만듭니다. 메타데이터에서 위젯 구성에 이르기까지 모든 요소를 지정하여 특정 계정에 연결된 대시보드를 만들 수 있습니다. |
dashboardUpdate() | 돌연변이 | 대시보드 작업을 업데이트합니다. 대시보드 엔터티 GUID가 지정된 기존 대시보드를 업데이트할 수 있습니다. 메타데이터에서 위젯 구성에 이르기까지 업데이트된 전체 대시보드 요소를 지정해야 합니다. |
dashboardDelete() | 돌연변이 | 대시보드 작업을 삭제합니다. 대시보드 엔터티 GUID가 지정된 기존 대시보드를 삭제할 수 있습니다. 이 작업은 대시보드를 복구할 수 있는 논리적 삭제를 실행합니다. |
대시보드 삭제 취소() | 돌연변이 | 대시보드 작업 삭제를 취소합니다. 대시보드 엔터티 GUID가 주어지면 이전에 삭제된 대시보드를 복구할 수 있습니다. |
대시보드 페이지 작업
작업 | GraphQL 작업 유형 | Notes |
---|---|---|
대시보드업데이트 페이지() | 돌연변이 | 대시보드 페이지 작업을 업데이트합니다. 대시보드 페이지 엔터티 GUID가 주어지면 기존 대시보드의 한 페이지를 업데이트할 수 있습니다. 메타데이터에서 위젯 구성에 이르기까지 업데이트된 전체 대시보드 페이지 요소를 지정해야 합니다. |
대시보드UpdateWidgetsInPage() | 돌연변이 | 위젯 작업을 업데이트합니다. 대시보드 페이지 엔터티 GUID가 지정된 대시보드 페이지의 기존 위젯 세트를 업데이트할 수 있습니다. 업데이트할 위젯 세트와 전체 구성을 지정해야 합니다. |
대시보드AddWidgetsToPage() | 돌연변이 | 위젯 작업을 추가합니다. 대시보드 페이지 엔터티 GUID가 지정된 대시보드 페이지에 새 위젯 세트를 추가할 수 있습니다. 새 위젯 세트와 전체 구성을 지정해야 합니다. |
기타 작업
작업 | GraphQL 작업 유형 | Notes |
---|---|---|
대시보드CreateSnapshotUrl() | 돌연변이 | 대시보드 페이지 스냅샷 작업을 만듭니다. 지정된 대시보드 페이지 엔터티 GUID에 대한 공개 URL을 만들 수 있습니다. 그런 다음 결과 공개 URL에서 정적 스냅샷의 형태로 대시보드 페이지에 액세스할 수 있습니다. |
actor > dashboard > liveUrls() | 질문 | 모든 라이브 URL 작업을 나열합니다. 액세스 권한이 있는 실제 URL의 전체 목록을 얻을 수 있습니다. 라이브 URL은 최신 또는 라이브 데이터와 함께 대시보드 페이지 및 위젯을 공개적으로 공유할 수 있는 메커니즘입니다. |
대시보드위젯RevokeLiveUrl() | 돌연변이 | 위젯 라이브 URL 작업을 취소합니다. 이전에 생성된 위젯의 라이브 URL을 취소할 수 있습니다. 결과적으로 라이브 URL은 공개되지 않습니다. |
제한
일부 대시보드 속성에 설정할 수 있는 값을 제한했습니다. 이를 통해 대시보드를 좋은 상태로 유지하면서 유용성을 높일 수 있습니다.
대시보드 제한
한계 | 값 |
---|---|
대시보드의 최대 페이지 수 | 도면 1 |
대시보드 이름의 최대 길이 | 255 |
대시보드 설명의 최대 길이 | 1024 |
대시보드 페이지 제한
한계 | 값 |
---|---|
대시보드 페이지의 최대 위젯 수 | 도면 1 |
대시보드 페이지 이름의 최대 길이 | 255 |
대시보드 페이지 설명의 최대 길이 | 1024 |
위젯 제한
한계 | 값 |
---|---|
위젯 제목의 최대 길이 | 255 |
위젯에 연결된 최대 엔티티 수 | 1 |
위젯의 최대 쿼리 수 | 도면 1 |
위젯의 최대 레이아웃 열 | 12 |
위젯의 최소 레이아웃 열 | 1 |
위젯의 최소 레이아웃 행 | 1 |
위젯의 최대 레이아웃 너비 | 12 |
위젯의 최소 레이아웃 너비 | 1 |
위젯의 최대 레이아웃 높이 | 32 |
위젯의 최소 레이아웃 높이 | 1 |
일등 시민으로서의 오류
모든 대시보드 변형은 실행 시 오류를 요청하는 방법을 제공합니다. 즉, 예상되는 잠재적 문제를 감지하기 위해 대시보드 변형을 수행하고 응답을 확인할 수 있습니다. 모든 오류에는 문제의 원인을 식별하는 데 도움이 되는 유형과 설명이 있습니다.
이러한 오류는 우리가 미리 알고 있는 예상 오류임을 명심하십시오. 또한 표준 GraphQL 오류 필드 에 반환될 예기치 않은 오류가 있는지 확인해야 합니다.