API로 대시보드 만들기 및 관리

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

콘솔

Google Cloud 콘솔을 사용하여 고정된 필터와 변수를 만드는 방법에 관한 자세한 내용은 다음 문서를 참조하세요.

• 필터 만들기 및 고정
• 변수 만들기

API

고정된 필터 및 변수를 정의하려면 dashboardFilters 데이터 구조를 사용합니다.

• 변수를 만들려면 templateVariable 필드의 값을 변수 이름으로 설정합니다. 대신 고정된 필터를 만들려면 이 필드를 생략하거나 값을 빈 문자열로 설정합니다.
• 고정된 필터 또는 라벨 기반의 변수를 만들려면 labelKey 필드를 지정해야 합니다. 값만 사용하는 변수를 만들려면 이 필드를 생략합니다.

• 필터 또는 변수의 기본값을 설정합니다. 이 필드의 구성에 따라 사용자가 값 메뉴에서 정확히 하나의 옵션을 선택할 수 있는지 또는 여러 값을 선택할 수 있는지 결정됩니다.

  • 단일 기본값을 설정하고 사용자가 값 메뉴에서 정확히 하나의 옵션만 선택하도록 제한하려면 valueType 필드를 STRING으로 설정하고 stringValue 필드도 설정합니다.

  "valueType": "STRING",
  "stringValue": "my-default-value",
  

  • 최소 하나 이상의 기본값을 설정하고 사용자가 값 메뉴에서 여러 옵션을 선택할 수 있도록 하려면 valueType 필드를 STRING_ARRAY로 설정하고 stringArrayValue 필드도 설정합니다. 다음 예시에는 세 가지 기본값이 있습니다.

  "valueType": "STRING_ARRAY",
  "stringArrayValue": {
    "values": [ "a", "b", "c" ]
  },
  

• 선택사항: 값 전용 변수에 사용 가능한 모든 값 목록을 지정하려면 stringArray 필드 또는 timeSeriesQuery 필드를 설정합니다. 쿼리를 지정하는 경우 분석 쿼리여야 합니다.

예를 들어 다음 dashboardFilters 객체를 고려하세요.

{
  "dashboardFilters": [
      {
        "labelKey": "zone"
        "stringValue": "us-central1-c",
        "valueType": "STRING",
        "filterType": "RESOURCE_LABEL"
      },
      {
        "labelKey": "instance_id",
        "stringValue": "3133577226154888113",
        "valueType": "STRING",
        "filterType": "RESOURCE_LABEL",
        "templateVariable": "my_label_based_variable"
      },
      {
        "filterType": "VALUE_ONLY",
        "templateVariable": "my_value_only_variable",
        timeSeriesQuery: {
          opsAnalyticsQuery: {
            sql: "
              SELECT log_name
              FROM `MY_TABLE`
              GROUP BY log_name
            ",
          }
        }
      }
    ],
  "displayName": "Illustrate Variables",
  ...
}

이전 JSON은 고정된 필터 1개와 변수 2개를 정의합니다.

• 고정된 필터에는 툴바에 표시되는 zone의 라벨 키가 포함됩니다. valueType 및 stringValue 필드는 단일 기본값을 지정합니다. 자세한 내용은 dashboardFilters 데이터 구조의 API 참조 페이지를 참조하세요.

• 라벨 기반 변수에는 my_label_based_variable 이름이 포함되고 해당 라벨 키는 instance_id입니다. 이 변수의 기본값은 특정 인스턴스 ID로 설정됩니다. 배열을 사용하여 기본값을 구성할 수도 있습니다. 툴바에 필터가 my_label_based_variable 이름으로 표시됩니다.

• 값 전용 변수는 이름이 my_value_only_variable입니다. 이 항목에는 기본값이 지정되어 있지 않으므로 와일드 카드 연산자 (*)가 자동으로 적용됩니다. 또한 이 변수는 SQL 쿼리를 사용하여 변수에 가능한 값 목록을 생성합니다.

dashboardFilters 객체는 변수가 적용되는 위젯을 나열하지 않습니다. 대신 변수를 사용하는 위젯의 쿼리를 업데이트합니다.

콘솔

예를 들어 다음 쿼리는 정규 표현식을 사용해서 jsonPayload.message 필드의 값을 라벨 기반 변수 값이 포함된 문자열 값과 비교합니다.

jsonPayload.message=~"Connected to instance: ${my_label_based_variable.value}"

또 다른 예시로 값 전용 변수 value_only_severity_variable을 생각해 보겠습니다. 값 메뉴에서 ERROR, INFO, NOTICE의 세 가지 값이 선택되었다고 가정해 보겠습니다. 그런 후 로그 패널 위젯의 쿼리 창에 다음을 추가합니다.

severity =~ "${value_only_severity_variable}"

다음은 렌더링된 양식을 보여줍니다.

severity =~ "^(ERROR|INFO|NOTICE)$"

API

예를 들어 다음 JSON은 라벨 기반 변수를 사용해서 로그 패널 위젯의 쿼리를 업데이트하는 방법을 보여줍니다.

"logsPanel": {
  "filter": "${my_label_based_variable}",
  "resourceNames": [
    "projects/1234512345"
  ]
},

예를 들어 다음 쿼리는 정규 표현식을 사용해서 jsonPayload.message 필드의 값을 라벨 기반 변수 값이 포함된 문자열 값과 비교합니다.

"logsPanel": {
  "filter": "resource.type=\"gce_instance\"\n
             resource.labels.project_id=~\"${my_label_based_variable.value}\"\n",
  "resourceNames": [
    "projects/012345"
  ]
}

다른 예시로 값 전용 변수 value_only_severity_variable를 고려하고 메뉴에서 ERROR, INFO, NOTICE의 세 가지 값이 선택되었다고 가정해 보겠습니다. 그런 후 로그 패널 위젯의 쿼리 창에 다음을 추가합니다.

"logsPanel": {
  "filter": "severity =~ \"${value_only_severity_variable}\"\n",
  ...
}

다음은 로그 패널 위젯에서 실행되는 쿼리를 보여줍니다.

severity =~ "^(ERROR|INFO|NOTICE)$"

콘솔

예를 들어 다음 쿼리는 라벨 기반 변수 my_label_based_variable이 필터 표현식으로 확인되는 것을 사용합니다.

compute_googleapis_com:instance_cpu_utilization{
    monitored_resource="gce_instance", ${my_label_based_variable} }

쿼리를 수정하여 변수의 값만 확인할 수도 있습니다. 다음 예시에서는 정규 표현식을 사용하여 라벨 기반 쿼리의 값을 instance_id와 비교합니다.

compute_googleapis_com:instance_cpu_utilization{
    instance_id=~"${my_label_based_variable.value}"
}

값 전용 변수를 사용하는 경우 .value 절을 생략합니다. 예를 들어 값 전용 변수를 사용하여 영역별로 필터링하려면 쿼리에 다음과 비슷한 내용이 포함됩니다.

zone=~"${my_value_only_variable}"

API

예를 들어 다음 JSON은 라벨 기반 변수 my_label_based_variable을 사용하여 필터 표현식으로 확인되는 쿼리를 보여줍니다.

"timeSeriesQuery": {
  "prometheusQuery": "avg_over_time(
    compute_googleapis_com:instance_cpu_utilization{
      monitored_resource=\"gce_instance\",
      ${my_label_based_variable}
      }[${__interval}])",
  "unitOverride": "",
  "outputFullDuration": false
},

쿼리를 수정하여 변수의 값만 확인할 수도 있습니다. 다음 예시에서는 정규 표현식을 사용하여 라벨 기반 쿼리의 값을 instance_id와 비교합니다.

"timeSeriesQuery": {
  "prometheusQuery": "avg_over_time(
    compute_googleapis_com:instance_cpu_utilization{
    monitored_resource=\"gce_instance\",
    instance_id=~\"${my_label_based_variable.value}\"
    }[${__interval}])",
  "unitOverride": "",
  "outputFullDuration": false
},

값 전용 변수를 사용하는 경우 .value 절을 생략합니다. 예를 들어 값 전용 변수를 사용하여 영역별로 필터링하려면 쿼리에 다음과 비슷한 내용이 포함됩니다.

zone=~\"${my_value_only_variable}\"

콘솔

SQL은 와일드 카드 연산자를 "모든 값"을 의미하는 것으로 해석하지 않기 때문에 SQL 쿼리에서 변수를 사용할 때는 항상 IF 문을 사용하는 것이 좋습니다. 다음 예시는 데이터 유형이 문자열인 값 전용 변수의 사용을 보여줍니다.

WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)

변수의 메뉴 옵션을 통해 사용자가 여러 값을 선택할 수 있으면 CAST 함수를 사용해서 변수 값을 GoogleSQL 데이터 유형으로 변환해야 합니다. 다음 쿼리는 이 구문을 보여줍니다.

IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE,
   severity IN UNNEST(@my_value_only_variable))

SQL은 와일드 카드 연산자를 '모든 값'으로 해석하지 않으므로 이전 예시에 표시된 IF 문이 권장됩니다. 따라서 IF 문을 생략하고 와일드 카드 연산자를 선택하면 쿼리 결과가 빈 테이블이 됩니다. 두 번째 예시에서 UNNEST 함수는 배열을 테이블로 변환합니다.

올바른 형식의 WHERE 절을 추가하려면 다음을 수행합니다.

1. 위젯을 수정합니다.
2. 툴바에서 변수 필터 삽입을 선택한 후 WHERE 절을 업데이트하려는 변수를 선택합니다.
3. 대화상자가 열리면 생성된 코드를 검토한 후 복사 및 닫기를 클릭합니다.

4. 복사한 코드를 쿼리 창에 붙여넣고 필요한 항목을 수정합니다.

   예를 들어 로그 이름 목록을 생성하고 log_name이라는 단일 열이 있는 테이블에 결과를 출력하는 LogName이라는 변수를 만든다고 가정해 보겠습니다. 그런 다음 차트를 만들고 변수 필터 삽입을 선택한 다음 LogName 변수를 선택합니다. 다음 코드가 생성됩니다.

   WHERE IF(@LogName = '*', TRUE, LogName = @LogName)
   

   이 예시에서는 생성된 코드를 수정하고 LogName =을 log_name =으로 바꿔야 테이블 조인이 발생할 수 있습니다.

   WHERE IF(@LogName = '*', TRUE, log_name = @LogName)
   

5. 실행을 클릭한 다음 적용을 클릭합니다.

6. 수정된 대시보드를 저장하려면 툴바에서 저장을 클릭합니다.

API

SQL은 와일드 카드 연산자를 "모든 값"을 의미하는 것으로 해석하지 않기 때문에 SQL 쿼리에서 변수를 사용할 때는 항상 IF 문을 사용하는 것이 좋습니다. 다음 예시는 데이터 유형이 문자열인 값 전용 변수의 사용을 보여줍니다.

WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)

예를 들어 다음은 SQL 쿼리 결과를 표시하는 차트의 일부 JSON 표현입니다. 로그 이름으로 결과를 필터링할 수 있도록 LogName이라는 변수를 참조하는 WHERE 절이 추가되었습니다.

"plotType": "STACKED_BAR",
"targetAxis": "Y1",
"timeSeriesQuery": {
  "opsAnalyticsQuery": {
    "queryExecutionRules": {},
    "queryHandle": "",
    "sql": "SELECT\n timestamp, severity, resource.type, log_name, text_payload, proto_payload, json_payload\n
            FROM\n `my-project.global._Default._Default`\n
            WHERE \n IF (@LogName = \"*\", TRUE, log_name=@LogName)\nLIMIT 10000"
  }
}

변수 LogName은 가능한 로그 이름 목록을 확인하기 위한 쿼리도 실행합니다.

"dashboardFilters": [
  {
    "filterType": "VALUE_ONLY",
    "templateVariable": "LogName",
    "valueType": "STRING",
    "timeSeriesQuery": {
      "opsAnalyticsQuery": {
        "savedQueryId": "",
        "sql": "SELECT log_name FROM `my-project.global._Default._Default` GROUP BY log_name LIMIT 1000",
        "queryHandle": ""
      },
      "unitOverride": "",
      "outputFullDuration": false
    }
  }
],

변수의 메뉴 옵션을 통해 사용자가 여러 값을 선택할 수 있으면 CAST 함수를 사용해서 변수 값을 GoogleSQL 데이터 유형으로 변환해야 합니다. 다음 쿼리는 이 구문을 보여줍니다.

IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE,
   severity IN UNNEST(@my_value_only_variable))

SQL은 와일드 카드 연산자를 '모든 값'으로 해석하지 않으므로 이전 예시에 표시된 IF 문이 권장됩니다. 따라서 IF 문을 생략하고 와일드 카드 연산자를 선택하면 쿼리 결과가 빈 테이블이 됩니다. 두 번째 예시에서 UNNEST 함수는 배열을 테이블로 변환합니다.

콘솔

예를 들어 다음 쿼리는 라벨 기반 변수 my_label_based_variable이 필터 표현식으로 확인되는 것을 사용합니다.

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| every 1m
| ${my_label_based_variable}

쿼리를 수정하여 변수의 값만 확인할 수도 있습니다. 다음 예시에서는 정규 표현식을 사용하여 라벨 기반 쿼리의 값을 instance_id와 비교합니다.

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| filter resource.instance_id=~'${my_label_based_variable.value}'
| group_by 1m, [value_utilization_mean: mean(value.utilization)]
| every 1m

값 전용 변수를 사용하는 경우 .value 절을 생략합니다. 예를 들어 값 전용 변수를 사용하여 영역별로 필터링하려면 쿼리에 다음과 비슷한 내용이 포함됩니다.

resource.zone=~'${my_value_only_variable}'

API

예를 들어 다음 JSON은 라벨 기반 변수 my_label_based_variable을 사용하여 필터 표현식으로 확인되는 쿼리를 보여줍니다.

"timeSeriesQuery": {
  "timeSeriesQueryLanguage": "fetch gce_instance\n
    | metric 'compute.googleapis.com/instance/cpu/utilization'\n
    | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n
    | every 1m\n
    | ${my_label_based_variable}",
  "unitOverride": "",
  "outputFullDuration": false
},

쿼리를 수정하여 변수의 값만 확인할 수도 있습니다. 다음 예시에서는 정규 표현식을 사용하여 라벨 기반 쿼리의 값을 instance_id와 비교합니다.

"timeSeriesQuery": {
  "timeSeriesQueryLanguage": "fetch gce_instance\n
    | metric 'compute.googleapis.com/instance/cpu/utilization'\n
    | filter resource.instance_id=~'${my_label_based_variable.value}'\n
    | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n
    | every 1m\n",
  "unitOverride": "",
  "outputFullDuration": false
},

값 전용 변수를 사용하는 경우 .value 절을 생략합니다. 예를 들어 값 전용 변수를 사용하여 영역별로 필터링하려면 쿼리에 다음과 비슷한 내용이 포함됩니다.

resource.zone=~'${my_value_only_variable}'

콘솔

Google Cloud 콘솔을 사용하여 차트를 만들고 메뉴 기반 인터페이스를 사용 중이면 변수의 차트에 적용 필드를 사용하거나 위젯을 수정하고 필터 메뉴에서 라벨 기반 변수를 선택하여 차트의 쿼리를 업데이트할 수 있습니다. 필터 메뉴에는 모든 라벨 기반 변수와 모든 라벨 키가 표시됩니다.

값 기반 변수를 사용하도록 차트 쿼리를 업데이트하려면 다음을 수행합니다.

1. 차트를 수정합니다.
2. 쿼리 창에서 필터 추가를 클릭하고 라벨 키를 선택합니다. 예를 들어 영역을 선택할 수 있습니다.
3. 값 메뉴에서 값 전용 변수를 선택합니다.
4. 적용을 클릭합니다.
5. 수정된 대시보드를 저장하려면 툴바에서 저장을 클릭합니다.

예를 들어 다음 JSON은 라벨 기반 변수 my_label_based_variable을 사용하여 필터 표현식으로 확인되는 쿼리를 보여줍니다.

metric.type="compute.googleapis.com/instance/cpu/utilization"
resource.type="gce_instance" ${my_label_based_variable}"

Monitoring 필터의 형식으로 쿼리를 사용하는 위젯은 라벨 기반 변수의 값으로 시계열을 필터링할 수 없습니다. 하지만 값 전용 변수로 필터링할 수 있습니다. 예를 들어 다음 쿼리는 값 전용 변수의 값을 기반으로 zone으로 필터링하는 쿼리의 필터 필드 값을 보여줍니다.

metric.type="compute.googleapis.com/instance/cpu/utilization"
resource.type="gce_instance"
resource.label."zone"=monitoring.regex.full_match(${my_value_only_variable})

API

예를 들어 다음 JSON은 라벨 기반 변수 my_label_based_variable을 사용하여 필터 표현식으로 확인되는 쿼리를 보여줍니다.

"timeSeriesQuery": {
  "timeSeriesFilter": {
    "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
               resource.type=\"gce_instance\"
               ${my_label_based_variable} ",
    "aggregation": {
      "alignmentPeriod": "60s",
      "perSeriesAligner": "ALIGN_MEAN",
      "groupByFields": []
    }
  },
  "unitOverride": "",
  "outputFullDuration": false
},

Monitoring 필터의 형식으로 쿼리를 사용하는 위젯은 라벨 기반 변수의 값으로 시계열을 필터링할 수 없습니다. 하지만 값 전용 변수로 필터링할 수 있습니다. 예를 들어 다음 쿼리는 값 전용 변수의 값을 기반으로 zone으로 필터링하는 쿼리의 "filter" 필드를 보여줍니다.

"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
          resource.type=\"gce_instance\"
          resource.labels.\"zone\"=monitoring.regex.full_match(${my_value_only_variable})"

gcloud

프로젝트에서 대시보드를 만들려면 gcloud monitoring dashboards create 명령어를 실행합니다.

gcloud monitoring dashboards create --config-from-file=my-dashboard.json --project=PROJECT_ID

위 명령어를 실행하기 전에 다음을 교체합니다.

• PROJECT_ID: 프로젝트 식별자입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

예를 들어 대시보드를 복제하려면 다음을 수행합니다.

1. 대시보드 가져오기의 단계를 완료해서 원래 대시보드의 정의를 다운로드합니다.
2. 반환된 JSON을 편집하여 etag 및 name 필드를 삭제하고 displayName 필드 값을 변경합니다.
3. 명령어를 실행하여 대시보드를 만듭니다.

자세한 내용은 gcloud monitoring dashboards create 참조를 확인하세요.

Terraform

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요. 자세한 내용은 Terraform 제공업체 참고 문서를 확인하세요.

Terraform을 사용하여 대시보드를 만들려면 다음을 수행합니다.

1. 프로젝트에 Terraform을 설치하고 구성합니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

2. Terraform 리소스 google_monitoring_dashboard를 사용합니다.

   명령어에서 다음 필드를 설정합니다.

   • dashboard_json: Dashboards 형식을 사용하는 대시보드의 JSON 표현입니다.

     이 형식의 경우 API 탐색기를 사용하여 대시보드를 나열하거나 Google Cloud 콘솔에서 대시보드를 열고 JSON 표현을 볼 수 있습니다.

   • parent: 프로젝트의 정규화된 이름입니다. 예를 들어 이 필드를 "projects/PROJECT_ID"로 설정할 수 있습니다. 여기서 PROJECT_ID는 Google Cloud 프로젝트 ID입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

REST

새 대시보드를 만들려면 POST 요청을 Dashboard 엔드포인트에 보냅니다.

curl -d @my-dashboard.json -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' -X POST https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards

위 명령어를 실행하기 전에 다음을 구성합니다.

• ${PROJECT_ID}: 대시보드를 만들려는 프로젝트 ID가 저장된 환경 변수입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

gcloud

커스텀 대시보드를 삭제하려면 gcloud monitoring dashboards delete를 사용하고 삭제할 대시보드의 정규화된 ID를 지정합니다.

gcloud monitoring dashboards delete DASHBOARD_ID --project=PROJECT_ID

위 명령어를 실행하기 전에 다음을 교체합니다.

• PROJECT_ID: 프로젝트 식별자입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.
• DASHBOARD_ID: 대시보드의 ID입니다.

자세한 내용은 gcloud monitoring dashboards delete 참조를 확인하세요.

Terraform

Terraform을 사용하여 리소스를 삭제할 수 있습니다. 리소스 삭제에 대한 자세한 내용은 Terraform 명령어 destroy를 참조하세요.

REST

커스텀 대시보드를 삭제하려면 삭제할 대시보드의 ID로 Dashboard 엔드포인트에 DELETE 요청을 보냅니다.

curl -H "Authorization: Bearer $ACCESS_TOKEN" -X DELETE https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

위 명령어를 실행하기 전에 다음을 구성합니다.

• ${PROJECT_ID}: 대시보드를 만들려는 프로젝트 ID가 저장된 환경 변수입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.
• ${DASHBOARD_ID}: 대시보드의 ID를 저장하는 환경 변수입니다.

성공하면 메서드가 빈 응답을 반환합니다. 그렇지 않으면 오류가 반환됩니다.

gcloud

프로젝트의 모든 커스텀 대시보드를 나열하려면 gcloud monitoring dashboards list 명령어를 사용합니다.

gcloud monitoring dashboards list --project=PROJECT_ID

위 명령어를 실행하기 전에 다음을 교체합니다.

• PROJECT_ID: 프로젝트 식별자입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

자세한 내용은 gcloud monitoring dashboards list 참조를 확인하세요.

Terraform

Terraform을 사용해서는 대시보드 목록을 응답으로 반환하는 쿼리를 프로젝트로 전송할 수 없습니다. 하지만 Google Cloud 콘솔을 사용하면 이러한 대시보드를 확인할 수 있습니다.

REST

프로젝트의 모든 커스텀 대시보드를 나열하려면 프로젝트 ID를 Dashboard 엔드포인트로 보냅니다.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards

위 명령어를 실행하기 전에 다음을 구성합니다.

• ${PROJECT_ID}: 대시보드를 만들려는 프로젝트 ID가 저장된 환경 변수입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

gcloud

페이지당 리소스 수를 지정하려면 명령어로 --page-size 플래그를 사용합니다. 예를 들면 다음과 같습니다.

gcloud monitoring dashboards list --page-size=1 --project=PROJECT_ID

위 명령어를 실행하기 전에 다음을 교체합니다.

• PROJECT_ID: 프로젝트 식별자입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

Terraform

Terraform을 사용해서는 페이지로 나눠진 대시보드 목록을 응답으로 반환하는 쿼리를 프로젝트로 전송할 수 없습니다. 하지만 Google Cloud 콘솔을 사용하면 이러한 대시보드를 확인할 수 있습니다.

REST

결과 목록의 첫 페이지에 요청과 함께 pageSize 쿼리 파라미터를 지정합니다.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards?page_size=1

위 명령어를 실행하기 전에 다음을 구성합니다.

• ${PROJECT_ID}: 대시보드를 만들려는 프로젝트 ID가 저장된 환경 변수입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

이 메서드는 목록의 첫 페이지와 nextPageToken을 반환합니다. 예를 들면 다음과 같습니다.

{
  "dashboards" : [
    {
       "displayName" : "Grid Layout Example",
       "gridLayout" : {
         "widgets" : [
            { ... },
            { ... },
            { ... },
          ]
       }
    }
  ]
},
"nextPageToken": "ChYqFDEyMzkzMzUwNzg0OTE1MDI4MjM3"

나머지 각 페이지의 경우 요청에 해당 nextPageToken을 포함해야 합니다.

gcloud

특정 커스텀 대시보드를 가져오려면 gcloud monitoring dashboards describe 명령어를 사용하고 대시보드 ID를 지정합니다.

gcloud monitoring dashboards describe DASHBOARD_ID --format=json -project=PROJECT_ID

위 명령어를 실행하기 전에 다음을 교체합니다.

• PROJECT_ID: 프로젝트 식별자입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.
• DASHBOARD_ID: 대시보드의 ID입니다.

이 명령어는 요청된 대시보드를 반환합니다.

{
  "columnLayout": {
    "columns": [
      {
        "widgets": [
          {
            "text": {
              "content": "Text Widget 1",
              "format": "RAW"
            }
          },
          {
            "text": {
              "content": "**Text Widget 2**",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "_Text Widget 3_",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  },
  "displayName": "Column-layout example",
  "etag": "cb3070baf15de7c79d78761baac3a386",
  "name": "projects/730041941835/dashboards/e4cd063e-5414-4e07-9e1e-450d6d3a531d"
}

자세한 내용은 gcloud monitoring dashboards describe 참조를 확인하세요.

Terraform

Terraform을 사용해서는 개별 대시보드를 응답으로 반환하는 쿼리를 프로젝트로 전송할 수 없습니다. 하지만 Google Cloud 콘솔을 사용하면 이러한 대시보드를 확인할 수 있습니다.

REST

특정 커스텀 대시보드를 가져오려면 대시보드 ID를 Dashboard 엔드포인트로 보냅니다.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

위 명령어를 실행하기 전에 다음을 구성합니다.

• ${PROJECT_ID}: 대시보드를 만들려는 프로젝트 ID가 저장된 환경 변수입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.
• ${DASHBOARD_ID}: 대시보드의 ID를 저장하는 환경 변수입니다.

이전 표현식에서 ${DASHBOARD_ID}는 대시보드의 정규화된 이름을 저장하는 환경 변수입니다.

이 메서드는 다음 예시와 비슷한 응답을 반환합니다.

{
  "columnLayout": {
    "columns": [
      {
        "widgets": [
          {
            "text": {
              "content": "Text Widget 1",
              "format": "RAW"
            }
          },
          {
            "text": {
              "content": "**Text Widget 2**",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "_Text Widget 3_",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  },
  "displayName": "Column-layout example",
  "etag": "cb3070baf15de7c79d78761baac3a386",
  "name": "projects/730041941835/dashboards/e4cd063e-5414-4e07-9e1e-450d6d3a531d"
}

gcloud

커스텀 대시보드를 업데이트하려면 gcloud monitoring dashboards update를 사용하고, 업데이트할 대시보드의 ID를 지정하고, 대시보드에 변경 사항을 제공합니다.

gcloud monitoring dashboards update DASHBOARD_ID --config-from-file=my-updated-dashboard.json --project=PROJECT_ID

위 명령어를 실행하기 전에 다음을 교체합니다.

• PROJECT_ID: 프로젝트 식별자입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.
• DASHBOARD_ID: 대시보드의 ID입니다.

자세한 내용은 gcloud monitoring dashboards update 참조를 확인하세요.

이전 예시에서는 my-updated-dashboard.json 파일을 사용하여 기존 커스텀 대시보드를 업데이트합니다. 새 etag 값이 포함된 응답은 업데이트된 대시보드 목록의 사본입니다.

Terraform

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요. 자세한 내용은 Terraform 제공업체 참고 문서를 확인하세요.

Terraform을 사용하여 대시보드를 업데이트하려면 다음을 수행합니다.

1. 프로젝트에 Terraform을 설치하고 구성합니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

2. Terraform 리소스 google_monitoring_dashboard를 사용합니다.

   명령어에서 다음 필드를 설정합니다.

   • dashboard_json: Dashboards 형식을 사용하는 대시보드의 JSON 표현입니다.

   • parent: 프로젝트의 정규화된 이름입니다. 예를 들어 이 필드를 "projects/PROJECT_ID"로 설정할 수 있습니다. 여기서 PROJECT_ID는 Google Cloud 프로젝트 ID입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.

REST

커스텀 대시보드를 업데이트하려면 Dashboard 엔드포인트에 PATCH 요청을 보내고 최신 dashboards.get 응답에서 수정된 Dashboard 객체와 etag 값을 제공합니다.

curl -d @my-updated-dashboard.json -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' -X PATCH https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

위 명령어를 실행하기 전에 다음을 구성합니다.

• ${PROJECT_ID}: 대시보드를 만들려는 프로젝트 ID가 저장된 환경 변수입니다. App Hub 구성의 경우 App Hub 호스트 프로젝트 또는 앱 지원 폴더의 관리 프로젝트를 선택합니다.
• ${DASHBOARD_ID}: 대시보드의 ID를 저장하는 환경 변수입니다.

이전 예시에서는 my-updated-dashboard.json 파일을 사용하여 기존 커스텀 대시보드를 업데이트합니다. 새 etag 값이 포함된 응답은 업데이트된 대시보드 목록의 사본입니다.