커스텀 대시보드에 영구 필터 추가

이 문서에서는 커스텀 대시보드에 대시보드 수준 영구 필터를 추가하는 방법을 설명합니다. 영구 필터는 각 위젯을 수정할 필요 없이 대시보드에 표시되는 데이터를 수정할 수 있게 해 주고 기본 상태를 가지며 전체 대시보드에 또는 특정 위젯에만 적용될 수 있습니다. 대시보드 툴바에는 각 영구 필터와 필터 값을 일시적으로 변경할 수 있는 메뉴가 표시됩니다.

표시를 수정할 수 있는 메뉴 기반 옵션과 함께 대시보드의 기본 데이터 표현을 정의하려면 영구 필터를 추가합니다. 예를 들어 모든 영역의 측정항목을 보고 특정 영역의 측정항목도 보려면 zone 라벨을 기반으로 영구 필터를 만듭니다.

Google Cloud 콘솔 또는 Cloud Monitoring API를 사용하여 영구 필터를 만들고 적용할 수 있습니다. 이 문서에서는 Google Cloud 콘솔을 사용하는 방법을 설명합니다. Cloud Monitoring API 사용에 대한 자세한 내용은 API로 대시보드 만들기 및 관리: 대시보드 필터를 참조하세요.

임시 그룹화 및 필터를 추가하고 수정하는 방법에 대한 자세한 내용은 커스텀 대시보드에 임시 필터 추가를 참조하세요.

대시보드 필터의 작동 방식

대시보드 필터는 라벨과 값을 지정합니다. 대시보드에 표시되는 시계열에 따라 필터링에 사용할 수 있는 라벨이 결정됩니다. 위젯이 대시보드 전체 필터를 지원하는 방식은 위젯에 표시되는 데이터 유형과 위젯 구성에 따라 달라집니다.

  • 선 차트와 같이 시계열 데이터를 표시하는 위젯의 경우 다음 규칙이 적용됩니다.

    • 위젯으로 표시되는 시계열이 필터에서 라벨을 지원하지 않으면 대시보드 전체 필터는 표시된 데이터를 변경하지 않습니다.

      예를 들어 instance_id 라벨에 필터를 추가했는데 대시보드의 차트에 instance_id 라벨이 있는 데이터가 표시되지 않으면 해당 필터에서 표시된 데이터를 변경하지 않습니다.

    • 위젯이 라벨 값을 지정하면 대시보드 전체 필터에서 표시된 데이터를 변경하지 않습니다.

      예를 들어 instance_id 라벨에 필터를 추가했는데 대시보드의 차트에 instance_id 라벨을 기반으로 하는 필터가 포함된 경우 대시보드 전체 필터에서 표시된 데이터를 변경하지 않습니다.

    • 그렇지 않으면 차트는 대시보드 전체 필터를 충족하는 시계열로만 표시되는 데이터를 필터링합니다.

  • 로그 패널 위젯의 경우 리소스 라벨에 기반한 대시보드 전체 필터가 쿼리를 업데이트합니다. 예를 들어 대시보드 전체 필터 cluster_name: mycluster를 추가하면 resource.labels."cluster_name"="mycluster"가 포함되도록 쿼리가 업데이트됩니다.

대시보드 전체 필터를 여러 개 추가할 수 있습니다. 이러한 필터는 논리곱(AND)으로 조인됩니다.

시작하기 전에

Google Cloud 콘솔을 사용하여 영구 필터를 추가하거나 수정하는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 Monitoring 편집자(roles/monitoring.editor) IAM 역할을 부여해 달라고 요청하세요. 역할 부여에 대한 자세한 내용은 액세스 관리를 참조하세요.

커스텀 역할이나 다른 사전 정의된 역할을 통해 필요한 권한을 얻을 수도 있습니다.

역할에 대한 자세한 내용은 Identity and Access Management로 액세스 제어를 참조하세요.

영구 필터 만들기

대시보드를 설계할 때는 대시보드에 표시되는 데이터를 보는 여러 방법을 식별할 수 있습니다. 예를 들어 대시보드에 VM 인스턴스의 측정항목이 표시되면 모든 VM의 측정항목을 보고 특정 영역의 VM 측정항목을 볼 수 있습니다. 기본 설정이 모든 영역(*)으로 설정된 zone 라벨에 대한 영구 필터를 만들 수 있습니다. 대시보드를 볼 때 zone 필터의 메뉴를 사용하여 특정 영역을 선택할 수 있습니다.

영구 필터를 특정 위젯으로 제한할 수 있습니다. 두 개의 서로 다른 영역에 있는 VM의 측정항목을 나란히 보는 시나리오를 생각해 보겠습니다. 차트 컬렉션 두 개를 구성하고 각 컬렉션마다 필터를 만듭니다. 기본 구성은 원래 목표를 충족합니다. 하지만 대시보드를 볼 때는 툴바에 변수가 나열되고 다양한 값을 선택할 수 있는 메뉴가 포함됩니다. 이 메뉴를 사용하여 여러 영역의 데이터를 볼 수 있습니다.

특정 위젯에만 적용되는 영구 필터는 템플릿 변수라고 부르기도 합니다. 이 유형의 필터를 만들면 대시보드에 위젯을 추가할 때 해당 위젯에 필터를 적용할 수도 있습니다. 자세한 내용은 위젯에 영구 필터 적용을 참조하세요.

영구 필터를 만들려면 다음 안내를 따르세요.

  1. Google Cloud 콘솔에서  대시보드 페이지로 이동합니다.

    대시보드로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Trace인 결과를 선택합니다.

  2. 대시보드 툴바에서 설정을 클릭한 다음 필터 관리를 선택합니다.
  3. 라벨을 클릭한 다음 라벨을 선택합니다. 예를 들어 zone을 선택할 수 있습니다.

  4. 기본값을 클릭한 다음 라벨의 기본값을 선택합니다. 모든 값을 일치시키려면 *를 선택합니다.

    필터가 생성되면 대시보드 툴바에 추가됩니다. 필터 값을 일시적으로 변경하려면 필터를 선택한 다음 메뉴에서 선택합니다.

  5. 다음 중 하나를 수행합니다.

    • 대시보드의 모든 위젯에 필터를 적용하려면 모두 적용을 선택한 다음 적용을 선택합니다.

    • 대시보드의 일부 위젯에 필터를 적용하려면 다음 안내를 따르세요.

      1. 모두 적용을 선택 해제합니다.
      2. 변수 이름 필드에 변수의 표시 이름을 입력합니다.

      3. 차트에 적용 메뉴를 펼치고 필터를 적용할 위젯을 선택한 다음 확인을 선택합니다.

      4. 적용을 클릭합니다.

위젯에 영구 필터 적용

위젯에 영구 필터를 적용하려면 해당 위젯을 변수와 연결해야 합니다.

  • 메뉴를 사용하여 구성하는 차트의 경우 필터를 만들거나 수정할 때 이 연결을 수행할 수 있습니다.

  • 로그 패널의 경우 위젯을 수정하고 기본 쿼리를 구성합니다. 영구 필터를 적용하는 문법이라는 제목의 섹션에 있는 안내를 따라야 합니다.

  • MQL 또는 PromQL 정의 차트 및 테이블의 경우 차트나 테이블을 수정한 다음 MQL 또는 PromQL을 수정합니다. 영구 필터를 적용하는 문법이라는 제목의 섹션에 있는 안내를 따라야 합니다.

영구 필터를 적용하는 문법

예를 들어 다음은 템플릿 변수 및 대시보드 전체 필터를 정의하는 대시보드의 부분 JSON 표현을 보여줍니다.

{
  "dashboardFilters": [
      {
        "filterType": "RESOURCE_LABEL",
        "labelKey": "instance_id",
        "stringValue": "3133577226154888113",
        "templateVariable": "iid"
      },
      {
        "filterType": "RESOURCE_LABEL",
        "labelKey": "zone"
      }
    ],
  "displayName": "Illustrate Template Variables",
  ...

표시된 JSON에서 dashboardFilters 구조의 첫 번째 항목은 이름이 iid인 템플릿 변수와 라벨 키 zone가 있는 대시보드 전체 필터에 대한 것입니다. 템플릿 변수는 라벨 instance_id의 별칭입니다.

템플릿 변수의 데이터 구조는 적용되는 위젯을 나열하지 않습니다. 대신 변수 참조를 포함하도록 위젯의 쿼리를 수정하여 위젯을 템플릿 변수와 연결합니다. 대시보드에 위젯이 표시되면 템플릿 변수 값이 확인됩니다.

로그 패널과 차트에 주석을 추가하는 방법은 다음 섹션을 참조하세요.

로그 패널

템플릿 변수 값에 따라 표시를 필터링하도록 로그 패널을 구성하려면 쿼리 창에 변수를 추가합니다. 다음 예시는 템플릿 변수 iid의 값으로 필터링하는 쿼리를 보여줍니다.

${iid}

로그 패널에서 표시할 로그를 쿼리하기 전에 템플릿 변수가 확인됩니다. 이 예시에서 템플릿 변수 값이 "12345"이면 ${iid}는 resource.labels."instance_id"="12345" 문으로 대체됩니다.

쿼리에 템플릿 변수의 값만 포함할 수도 있습니다. 정규 표현식으로 정의된 필터의 일부로만 값을 사용하는 것이 좋습니다. 예를 들어 다음 쿼리는 정규 표현식을 사용하여 설명된 문자열이 포함된 JSON 페이로드가 있는 로그 항목과 일치시킵니다.

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

로그 패널에 대한 쿼리를 구성한 다음 로그 탐색기를 여는 버튼을 선택하면 로그 탐색기가 열리기 전에 템플릿 변수가 확인됩니다.

다음 테이블에서는 로그 패널에서 템플릿 변수를 확인하는 방법을 보여줍니다.

구문 선택된
값		 확인된 로그 패널 표현식
${iid} 12345 resource.labels."instance_id"="12345"
${iid} * ""
${iid.value} 12345 12345
${iid.value} * .*

MQL 정의 차트 및 테이블

Monitoring 쿼리 언어(MQL)를 사용하여 차트를 구성할 때 쿼리 문자열에 파이프와 변수를 추가합니다.

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

차트에서 표시할 시계열을 쿼리하기 전에 템플릿 변수가 확인됩니다. 이 예시에서 템플릿 변수 값이 "12345"이면 ${iid}는 filter (resource.instance_id == '12345') 문으로 대체됩니다. 이 필터는 resource.instance_id 라벨이 있는 시계열과 일치하며 해당 라벨 값이 정확히 12345인 경우에만 일치합니다.

정규 표현식을 사용하여 시계열을 필터링하려면 템플릿 변수 값만 포함하도록 쿼리를 구성합니다. 구문을 설명하기 위해 다음은 정규 표현식을 사용하여 resource.instance_id 라벨 값에 템플릿 변수 iid 값이 포함되어 있는지 확인하는 방법을 보여줍니다.

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

다음 표에서는 MQL 쿼리의 템플릿 변수가 확인되는 방법을 보여줍니다.

구문 선택된
값		 확인된 MQL 표현식
${iid} 12345 filter (resource.instance_id == '12345')
${iid} * filter (true)
${iid.value} 12345 12345
${iid.value} * .*

PromQL 정의 차트 및 테이블

PromQL을 사용하여 차트를 정의할 때 중괄호로 묶인 변수를 쿼리 문자열에 추가합니다.

compute_googleapis_com:instance_cpu_utilization {
    project_id="my-project", ${iid}
}

차트에서 표시할 시계열을 쿼리하기 전에 템플릿 변수가 확인됩니다. 이 예시에서 템플릿 변수 값이 "12345"이면 ${iid}는 instance_id == '12345' 문으로 대체됩니다.

MQL과 마찬가지로 PromQL로 위젯을 정의할 때 쿼리는 템플릿 변수의 값만 추출할 수 있습니다. 정규 표현식으로 정의된 필터의 일부로만 값을 사용하는 것이 좋습니다. 구문을 설명하기 위해 다음은 정규 표현식을 사용하여 instance_id 라벨 값에 템플릿 변수 iid 값이 포함되어 있는지 확인하는 방법을 보여줍니다.

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

다음 표에서는 PromQL 쿼리의 템플릿 변수가 확인되는 방법을 보여줍니다.

구문 선택된
값		 확인된 PromQL 표현식
${iid} 12345 instance_id == '12345'
${iid} * noop_filter=~".*"
${iid.value} 12345 12345
${iid.value} * .+

시계열 필터로 정의된 차트 및 테이블

시계열 필터를 사용하여 차트를 정의할 때 필터 문자열에 변수를 추가합니다.

"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
           resource.type=\"gce_instance\" ${iid}"

MQL 및 PromQL 정의 차트와 달리 시계열 필터에서 템플릿 변수의 값을 사용할 수 없습니다.

다음 표에서는 템플릿 변수를 확인하는 방법을 보여줍니다.

구문 선택된
값		 해결된 필터 표현식
${iid} 12345 resource.instance_id == "12345"
${iid} * 중략
${iid.value} 12345 지원되지 않음
${iid.value} * 지원되지 않음

영구 필터 수정

대시보드 툴바에 표시되는 필터의 값을 일시적으로 변경하려면 필터 이름을 클릭하고 값을 입력하거나 메뉴에서 선택합니다.

영구 필터의 구성을 변경하려면 다음 안내를 따르세요.

  1. Google Cloud 콘솔에서  대시보드 페이지로 이동합니다.

    대시보드로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Trace인 결과를 선택합니다.

  2. 대시보드 툴바에서 설정을 클릭한 다음 필터 관리를 선택합니다.
  3. 수정하려는 필터를 찾은 다음 메뉴를 사용하여 수정합니다.
  4. 적용을 클릭합니다.

영구 필터 삭제

  1. Google Cloud 콘솔에서  대시보드 페이지로 이동합니다.

    대시보드로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Trace인 결과를 선택합니다.

  2. 대시보드 툴바에서 설정을 클릭한 다음 필터 관리를 선택합니다.
  3. 삭제할 필터를 찾은 다음 삭제를 클릭합니다.
  4. 적용을 클릭합니다.

다음 단계