대시보드 JSON 모델 - Amazon Managed Grafana

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

대시보드 JSON 모델

이 설명서 주제는 Grafana 버전 9.x를 지원하는 Grafana 워크스페이스를 위해 설계되었습니다.

Grafana 버전 10.x를 지원하는 Grafana 워크스페이스의 경우 Grafana 버전 10에서 작업 섹션을 참조하세요.

Grafana 버전 8.x를 지원하는 Grafana 워크스페이스의 경우 Grafana 버전 8에서 작업 섹션을 참조하세요.

Grafana의 대시보드는 대시보드의 메타데이터를 저장하는 JSON 객체로 표시됩니다. 대시보드 메타데이터에는 대시보드 속성, 패널의 메타데이터, 템플릿 변수 및 패널 쿼리가 포함됩니다.

대시보드의 JSON을 보는 방법.

  1. 대시보드로 이동하세요.

  2. 상단 탐색 메뉴에서 대시보드 설정(톱니) 아이콘을 클릭하세요.

  3. JSON 모델을 클릭하세요.

JSON 필드

사용자가 새 대시보드를 생성하면 새 대시보드 JSON 객체가 다음 필드로 초기화됩니다.

참고

다음 JSON에서는 ID가 null로 표시되며, 이는 대시보드가 저장될 때까지 할당된 기본 값입니다. 대시보드가 저장되면 id 필드에 정수 값이 할당됩니다.

{
  "id": null,
  "uid": "cLV5GDCkz",
  "title": "New dashboard",
  "tags": [],
  "style": "dark",
  "timezone": "browser",
  "editable": true,
  "graphTooltip": 1,
  "panels": [],
  "time": {
    "from": "now-6h",
    "to": "now"
  },
  "timepicker": {
    "time_options": [],
    "refresh_intervals": []
  },
  "templating": {
    "list": []
  },
  "annotations": {
    "list": []
  },
  "refresh": "5s",
  "schemaVersion": 17,
  "version": 0,
  "links": []
}

다음에서는 대시보드 JSON의 각 필드를 설명합니다.

명칭 사용법

id

대시보드의 고유 숫자 식별자(db에서 생성됨)

uid

누구나 생성할 수 있는 고유한 대시보드 식별자, 문자열(8~40)

제목

대시보드의 현재 제목

tags

대시보드와 연결된 태그, 문자열 배열

style

dark 또는 light와 같은 대시보드 테마

시간대

utc 또는 browser와 같은 대시보드 시간대

editable

대시보드 편집 가능 여부

graphTooltip

공유 십자선 또는 툴팁이 없는 경우 0(기본값), 공유 십자선의 경우 1, 공유 십자선 및 공유 툴팁의 경우 2

time

지난 6시간 또는 지난 7일과 같은 대시보드의 시간 범위

timepicker

시간 선택기 메타데이터, 자세한 내용은 시간 선택기 섹션 참조

템플릿 지정

템플릿 지정 메타데이터, 자세한 내용은 템플릿 지정 섹션 참조

주석

주석 메타데이터, 주석을 추가하는 방법은 주석 참조

refresh

자동 새로 고침 간격

schemaVersion

JSON 스키마 버전(정수), Grafana 업데이트에서 해당 스키마를 변경할 때마다 증가

version

대시보드 버전(정수), 대시보드가 업데이트될 때마다 증가

패널

패널 배열(자세한 내용은 아래 참조)

패널

패널은 대시보드의 구성 요소입니다. 데이터 소스 쿼리, 그래프 유형, 별칭 등으로 구성됩니다. 패널 JSON은 JSON 객체 배열로 구성되며, 각각 서로 다른 패널을 나타냅니다. 대부분의 필드는 모든 패널에 공통이지만 일부 필드는 패널 유형에 따라 다릅니다. 다음은 텍스트 패널의 패널 JSON에 대한 예제입니다.

"panels": [
  {
    "type": "text",
    "title": "Panel Title",
    "gridPos": {
      "x": 0,
      "y": 0,
      "w": 12,
      "h": 9
    },
    "id": 4,
    "mode": "markdown",
    "content": "# title"
  }

패널 크기 및 위치

gridPos 속성은 패널 크기와 위치를 그리드 좌표로 설명합니다.

  • w: 1~24(대시보드의 너비는 24개 열로 구분됨)

  • h: 그리드 높이 단위로, 각각 30픽셀을 나타냅니다.

  • x: w와 동일한 단위의 x 위치.

  • y: h와 동일한 단위의 y 위치.

그리드에서 패널 위에 빈 공간이 있는 경우 패널을 위로 이동하는 중력(음의 방향)이 작용합니다.

시간 선택기

"timepicker": {
    "collapse": false,
    "enable": true,
    "notice": false,
    "now": true,
    "refresh_intervals": [
      "5s",
      "10s",
      "30s",
      "1m",
      "5m",
      "15m",
      "30m",
      "1h",
      "2h",
      "1d"
    ],
    "status": "Stable",
    "type": "timepicker"
  }

템플릿 지정

templating 필드에는 저장된 값 및 기타 메타데이터와 함께 템플릿 변수 배열이 포함되어 있습니다.

"templating": {
    "enable": true,
    "list": [
       {
        "allFormat": "wildcard",
        "current":  {
          "tags": [],
          "text": "prod",
          "value": "prod"
        },
        "datasource": null,
        "includeAll": true,
        "name": "env",
        "options": [
           {
            "selected": false,
            "text": "All",
            "value": "*"
          },
           {
            "selected": false,
            "text": "stage",
            "value": "stage"
          },
           {
            "selected": false,
            "text": "test",
            "value": "test"
          }
        ],
        "query": "tag_values(cpu.utilization.average,env)",
        "refresh": false,
        "type": "query"
      },
       {
        "allFormat": "wildcard",
        "current":  {
          "text": "apache",
          "value": "apache"
        },
        "datasource": null,
        "includeAll": false,
        "multi": false,
        "multiFormat": "glob",
        "name": "app",
        "options": [
           {
            "selected": true,
            "text": "tomcat",
            "value": "tomcat"
          },
           {
            "selected": false,
            "text": "cassandra",
            "value": "cassandra"
          }
        ],
        "query": "tag_values(cpu.utilization.average,app)",
        "refresh": false,
        "regex": "",
        "type": "query"
      }
    ]
  }