5.13. Prometheus를 사용하여 기본 제공 모니터링 구성

절차

1. Operator SDK 프로젝트에서 config/default/kustomization.yaml 파일에서 다음 줄의 주석을 제거합니다.

   ../prometheus

2. Operator에서 추가 지표를 게시하도록 사용자 정의 컨트롤러 클래스를 생성합니다. 다음 예제에서는 위젯 및 위젯Failures 수집기를 글로벌 변수로 선언한 다음, 컨트롤러의 패키지에 init() 함수에 등록합니다.

   예 5.18. controllers/memcached_controller_test_metrics.go file

   package controllers
   
   import (
   	"github.com/prometheus/client_golang/prometheus"
   	"sigs.k8s.io/controller-runtime/pkg/metrics"
   )
   
   
   var (
       widgets = prometheus.NewCounter(
           prometheus.CounterOpts{
               Name: "widgets_total",
               Help: "Number of widgets processed",
           },
       )
       widgetFailures = prometheus.NewCounter(
           prometheus.CounterOpts{
               Name: "widget_failures_total",
               Help: "Number of failed widgets",
           },
       )
   )
   
   func init() {
       // Register custom metrics with the global prometheus registry
       metrics.Registry.MustRegister(widgets, widgetFailures)
   }

3. 기본 컨트롤러 클래스의 조정 루프 일부에서 이러한 수집기에 기록하여 메트릭에 대한 비즈니스 논리를 결정합니다.

   예 5.19. controllers/memcached_controller.go 파일

   func (r *MemcachedReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
   	...
   	...
   	// Add metrics
   	widgets.Inc()
   	widgetFailures.Inc()
   
   	return ctrl.Result{}, nil
   }

4. Operator를 빌드하고 내보냅니다.

   $ make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>

5. Operator를 배포합니다.

   $ make deploy IMG=<registry>/<user>/<image_name>:<tag>

6. OpenShift Container Platform 클러스터의 Prometheus 인스턴스에서 Operator의 서비스 모니터링을 스크랩할 수 있도록 역할 및 역할 바인딩 정의를 생성합니다.

   서비스 계정에 네임스페이스의 지표를 스크랩할 수 있는 권한이 있도록 역할을 할당해야 합니다.

   예 5.20. config/prometheus/role.yaml role

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: prometheus-k8s-role
     namespace: <operator_namespace>
   rules:
     - apiGroups:
         - ""
       resources:
         - endpoints
         - pods
         - services
         - nodes
         - secrets
       verbs:
         - get
         - list
         - watch

   예 5.21. config/prometheus/rolebinding.yaml 역할 바인딩

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: prometheus-k8s-rolebinding
     namespace: memcached-operator-system
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: ClusterRole
     name: prometheus-k8s-role
   subjects:
     - kind: ServiceAccount
       name: prometheus-k8s
       namespace: openshift-monitoring

7. 배포된 Operator에 역할 및 역할 바인딩을 적용합니다.

   $ oc apply -f config/prometheus/role.yaml

   $ oc apply -f config/prometheus/rolebinding.yaml

8. 스크랩할 네임스페이스의 레이블을 설정하여 해당 네임스페이스에 대한 OpenShift 클러스터 모니터링을 활성화합니다.

   $ oc label namespace <operator_namespace> openshift.io/cluster-monitoring="true"

절차

1. Ansible 기반 Operator를 생성합니다. 이 예에서는 testmetrics.com 도메인을 사용합니다.

   $ operator-sdk init \
       --plugins=ansible \
       --domain=testmetrics.com

2. 지표 API를 생성합니다. 이 예에서는 Testmetrics 라는 종류를 사용합니다.

   $ operator-sdk create api \
       --group metrics \
       --version v1 \
       --kind Testmetrics \
       --generate-role

3. roles/testmetrics/tasks/main.yml 파일을 편집하고 osdk_metrics 모듈을 사용하여 Operator 프로젝트에 대한 사용자 지정 지표를 생성합니다.

   예 5.22. roles/testmetrics/tasks/main.yml 파일의 예

   ---
   # tasks file for Memcached
   - name: start k8sstatus
     k8s:
       definition:
         kind: Deployment
         apiVersion: apps/v1
         metadata:
           name: '{{ ansible_operator_meta.name }}-memcached'
           namespace: '{{ ansible_operator_meta.namespace }}'
         spec:
           replicas: "{{size}}"
           selector:
             matchLabels:
               app: memcached
           template:
             metadata:
               labels:
                 app: memcached
             spec:
               containers:
               - name: memcached
                 command:
                 - memcached
                 - -m=64
                 - -o
                 - modern
                 - -v
                 image: "docker.io/memcached:1.4.36-alpine"
                 ports:
                   - containerPort: 11211
   
   - osdk_metric:
       name: my_thing_counter
       description: This metric counts things
       counter: {}
   
   - osdk_metric:
       name: my_counter_metric
       description: Add 3.14 to the counter
       counter:
         increment: yes
   
   - osdk_metric:
       name: my_gauge_metric
       description: Create my gauge and set it to 2.
       gauge:
         set: 2
   
   - osdk_metric:
       name: my_histogram_metric
       description: Observe my histogram
       histogram:
         observe: 2
   
   - osdk_metric:
       name: my_summary_metric
       description: Observe my summary
       summary:
         observe: 2

검증

1. 클러스터에서 Operator를 실행합니다. 예를 들어 "run as a deployment" 방법을 사용하려면 다음을 수행합니다.

   1. Operator 이미지를 빌드하고 레지스트리로 푸시합니다.

      $ make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>

   2. 클러스터에 Operator를 설치합니다.

      $ make install

   3. Operator를 배포합니다.

      $ make deploy IMG=<registry>/<user>/<image_name>:<tag>

2. Testmetrics 사용자 정의 리소스 (CR)를 만듭니다.

   1. CR 사양을 정의합니다.

      예 5.23. config/samples/metrics_v1_testmetrics.yaml 파일 예

      apiVersion: metrics.testmetrics.com/v1
      kind: Testmetrics
      metadata:
        name: testmetrics-sample
      spec:
        size: 1

   2. 오브젝트를 생성합니다.

      $ oc create -f config/samples/metrics_v1_testmetrics.yaml

3. Pod 세부 정보를 가져옵니다.

   $ oc get pods

   출력 예

   NAME                                    READY   STATUS    RESTARTS   AGE
   ansiblemetrics-controller-manager-<id>  2/2     Running   0          149m
   testmetrics-sample-memcached-<id>       1/1     Running   0          147m

4. 끝점 세부 정보를 가져옵니다.

   $ oc get ep

   출력 예

   NAME                                                ENDPOINTS          AGE
   ansiblemetrics-controller-manager-metrics-service   10.129.2.70:8443   150m

5. 사용자 정의 메트릭 토큰을 요청합니다.

   $ token=`oc create token prometheus-k8s -n openshift-monitoring`

6. 메트릭 값을 확인합니다.

   1. my_counter_metric 값을 확인합니다.

      $ oc exec ansiblemetrics-controller-manager-<id> -- curl -k -H "Authoriza
      tion: Bearer $token" 'https://10.129.2.70:8443/metrics' | grep  my_counter

      출력 예

      HELP my_counter_metric Add 3.14 to the counter
      TYPE my_counter_metric counter
      my_counter_metric 2

   2. my_gauge_metric 값을 확인합니다.

      $ oc exec ansiblemetrics-controller-manager-<id> -- curl -k -H "Authoriza
      tion: Bearer $token" 'https://10.129.2.70:8443/metrics' | grep  gauge

      출력 예

      HELP my_gauge_metric Create my gauge and set it to 2.

   3. my_histogram_metric 및 my_summary_metric 값을 확인합니다.

      $ oc exec ansiblemetrics-controller-manager-<id> -- curl -k -H "Authoriza
      tion: Bearer $token" 'https://10.129.2.70:8443/metrics' | grep  Observe

      출력 예

      HELP my_histogram_metric Observe my histogram
      HELP my_summary_metric Observe my summary