5.11. Prometheus による組み込みモニタリングの設定

手順

1. Operator SDK プロジェクトで、 config/default/kustomization.yamlファイルの次の行のコメントを解除します。

   ../prometheus

2. カスタムコントローラークラスを作成して、Operator からの追加のメトリックを公開します。次の例では、widgetsとwidget Failuresコレクターをグローバル変数として宣言してコントローラーのパッケージのinit()関数に登録します。

   例5.6 controllers/memcached_controller_test_metrics.go ファイル

   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. mainコントローラークラスの調整ループの任意の部分から、これらのコレクターに記録し、これをもとにメトリックのビジネスロジックを決定します。

   例5.7 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. ロールおよびロールバインディング定義を作成して、Operator のサービスモニターが OpenShift Container Platform クラスターの Prometheus インスタンスによってスクレイプされるようにします。

   サービスアカウントに namespace のメトリックをスクレイプする権限が指定されるように、ロールを割り当てる必要があります。

   例5.8 config/prometheus/role.yamlロール

   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.9 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"