HashiCorp Consul

이 문서에서는 Google Cloud Managed Service for Prometheus를 사용하여 Consul 내보내기 도구에서 측정항목을 수집할 수 있도록 Google Kubernetes Engine 배포를 구성하는 방법을 설명합니다. 이 문서에서는 다음을 수행하는 방법을 보여줍니다.

측정항목을 보고하도록 Consul 내보내기 도구를 설정합니다.
내보낸 측정항목을 수집하도록 Managed Service for Prometheus의 PodMonitoring 리소스를 구성합니다.
측정항목을 보도록 Cloud Monitoring의 대시보드에 액세스합니다.

이 안내는 관리형 컬렉션을 Managed Service for Prometheus와 함께 사용하는 경우에만 적용됩니다. 자체 배포 컬렉션을 사용하는 경우 Consul 문서에서 설치 정보를 참조하세요.

이 안내는 예시로서 제공되며 대부분의 Kubernetes 환경에서 작동합니다. 제한적인 보안 또는 조직 정책으로 인해 애플리케이션 또는 내보내기 도구를 설치하는 데 문제가 있으면 지원을 위한 오픈소스 문서를 참조하는 것이 좋습니다.

Consul에 대한 자세한 내용은 Consul을 참조하세요.

기본 요건

Managed Service for Prometheus 및 관리형 컬렉션을 사용하여 Consul 내보내기 도구에서 측정항목을 수집하려면 배포가 다음 요구사항을 충족해야 합니다.

클러스터가 Google Kubernetes Engine 버전 1.21.4-gke.300 이상을 실행 중이어야 합니다.
관리형 컬렉션이 사용 설정된 상태에서 Managed Service for Prometheus를 실행 중이어야 합니다. 자세한 내용은 관리형 컬렉션 시작하기를 참조하세요.
Cloud Monitoring에서 사용할 수 있는 대시보드를 Consul 통합에 사용하려면 consul 버전 1.13.3 이상을 사용해야 합니다.
사용 가능한 대시보드에 대한 자세한 내용은 대시보드 보기를 참조하세요.

원격 분석 구성 옵션인 prometheus_retention_time 및 disable_hostname이 설정되면 Consul이 Prometheus 형식 측정항목을 노출합니다. 이러한 옵션은 /consul/config/metrics.hcl에서 configmap을 마운트하여 설정할 수 있습니다. HashiCorp에서는 보관 간격의 두 배에 해당하는 보관 기간을 사용할 것을 권장합니다.

Consul 구성 수정

다음 예시와 같이 Consul 구성을 수정합니다.

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

kind: StatefulSet
metadata:
  name: consul
spec:
  serviceName: consul
  selector:
    matchLabels:
+     app.kubernetes.io/name: consul
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: consul
    spec:
      containers:
      - name: consul
        image: hashicorp/consul:1.16.0
        ports:
        - containerPort: 8500
          name: consul
          protocol: TCP
+       volumeMounts:
+       - mountPath: /consul/config/metrics.hcl
+         subPath: metrics.hcl
+         name: consul-telemetry
+     volumes:
+     - name: consul-telemetry
+       configMap:
+         name: consul-telemetry
+         items:
+         - key: metrics.hcl
+           path: metrics.hcl

+ 기호로 시작하는 모든 줄을 구성에 추가해야 합니다.

로컬 파일에서 구성 변경사항을 적용하려면 다음 명령어를 실행합니다.

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform을 사용하여 구성을 관리할 수도 있습니다.

Consul에서 측정항목을 노출하고 있는지 확인하려면 다음 명령어를 실행합니다.

  kubectl exec -n NAMESPACE_NAME POD_NAME -- curl -sS localhost:8500/v1/agent/metrics?format=prometheus

PodMonitoring 리소스 정의

대상 검색을 위해 Managed Service for Prometheus 연산자에는 동일한 네임스페이스의 Consul 내보내기 도구에 해당하는 PodMonitoring 리소스가 필요합니다.

다음 PodMonitoring 구성을 사용할 수 있습니다.

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: consul
  labels:
    app.kubernetes.io/name: consul
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 8500
    scheme: http
    interval: 30s
    path: /v1/agent/metrics
    params:
      format:
      - prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: consul

로컬 파일에서 구성 변경사항을 적용하려면 다음 명령어를 실행합니다.

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform을 사용하여 구성을 관리할 수도 있습니다.

구성 확인

측정항목 탐색기를 사용하여 Consul 내보내기 도구를 올바르게 구성했는지 확인할 수 있습니다. Cloud Monitoring이 측정항목을 수집하는 데 1~2분 정도 걸릴 수 있습니다.

측정항목이 수집되었는지 확인하려면 다음을 수행하세요.

Google Cloud 콘솔에서 측정항목 탐색기 페이지로 이동합니다.
측정항목 탐색기로 이동

검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.
쿼리 빌더 창의 툴바에서 이름이 MQL 또는 PromQL인 버튼을 선택합니다.
PromQL 전환 버튼에 PromQL이 선택되어 있는지 확인합니다. 언어 전환 버튼은 쿼리 형식을 지정할 수 있는 동일한 툴바에 있습니다.

다음 쿼리를 입력하고 실행합니다.

up{job="consul", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

대시보드 보기

Cloud Monitoring 통합에는 Consul Prometheus 개요 대시보드가 포함됩니다. 대시보드는 통합을 구성할 때 자동으로 설치됩니다. 통합을 설치하지 않고도 대시보드의 정적 미리보기를 볼 수 있습니다.

설치된 대시보드를 보려면 다음을 수행합니다.

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

검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.
대시보드 목록 탭을 선택합니다.
통합 카테고리를 선택합니다.
대시보드의 이름을 클릭합니다(예: Consul Prometheus 개요).

대시보드의 정적 미리보기를 보려면 다음을 수행합니다.

Google Cloud 콘솔에서 통합 페이지로 이동합니다.
통합으로 이동

검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.
Kubernetes Engine 배포 플랫폼 필터를 클릭합니다.
HashiCorp Consul 통합을 찾고 세부정보 보기를 클릭합니다.
대시보드 탭을 선택합니다.

문제 해결

측정항목 수집 문제 해결에 대한 자세한 내용은 수집 측 문제 해결에서 내보내기 도구의 수집 관련 문제를 참조하세요.