Apache CouchDB

このドキュメントでは、Google Cloud Managed Service for Prometheus を使用して Apache CouchDB から指標を収集できるように、Google Kubernetes Engine の Deployment を構成する方法について説明します。このドキュメントでは、次の方法について説明します。

• CouchDB のエクスポータを設定して、指標を報告する。
• エクスポートされた指標を収集するために、Managed Service for Prometheus の PodMonitoring リソースを構成する。
• Cloud Monitoring のダッシュボードにアクセスして指標を表示する。
• 指標をモニタリングするようにアラートルールを構成する。

以下の手順は、Managed Service for Prometheus でマネージド コレクションを使用している場合にのみ適用されます。セルフデプロイ コレクションを使用している場合は、CouchDB エクスポータのソース リポジトリでインストール情報をご覧ください。

以下の手順は一例であり、ほとんどの Kubernetes 環境で機能します。セキュリティ ポリシーや組織のポリシーの制限により、アプリケーションやエクスポータのインストールに問題がある場合は、オープンソース ドキュメントでサポート情報を確認することをおすすめします。

CouchDB の詳細については、CouchDB をご覧ください。

前提条件

Managed Service for Prometheus とマネージド コレクションを使用して CouchDB から指標を収集するには、Deployment が次の要件を満たしている必要があります。

• クラスタで Google Kubernetes Engine バージョン 1.21.4-gke.300 以降を実行している必要があります。
• マネージド コレクションを有効にして、Managed Service for Prometheus を実行する必要があります。詳細については、マネージド コレクションを使ってみるをご覧ください。

• CouchDB とのインテグレーションに Cloud Monitoring で利用可能なダッシュボードを使用するには、couchdb-prometheus-exporter バージョン v30.4.3 以降を使用する必要があります。

  利用可能なダッシュボードの詳細については、ダッシュボードを表示するをご覧ください。

CouchDB エクスポータをインストールする

CouchDB エクスポータ（couchdb-prometheus-exporter）を CouchDB ワークロードのサイドカーとしてインストールすることをおすすめします。サイドカーの使用方法については、マルチコンテナ Pod を使用した Kubernetes での拡張アプリケーションをご覧ください。

couchdb-prometheus-exporter をサイドカーとして CouchDB にインストールするには、次の例に示すように CouchDB 構成を変更します。

# 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: apps/v1
kind: StatefulSet
metadata:
  name: couchdb
spec:
  serviceName: couchdb
  selector:
    matchLabels:
+     app.kubernetes.io/name: couchdb
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: couchdb
    spec:
      containers:
      - name: couchdb
        image: couchdb:3.2.2
        env:
          - name: COUCHDB_USER
            value: "otelu"
          - name: COUCHDB_PASSWORD
            value: "otelp"
          - name: NODENAME
            valueFrom:
              fieldRef:
                fieldPath: metadata.name
          - name: ERL_FLAGS
            value: "-setcookie otel"
        ports:
        - containerPort: 5984
+     - name: couchdb-exporter
+       image: gesellix/couchdb-prometheus-exporter:v30.4.3
+       args:
+       - --couchdb.uri=http://localhost:5984
+       - --logtostderr
+       env:
+         - name: COUCHDB_USERNAME
+           value: "otelu"
+         - name: COUCHDB_PASSWORD
+           value: "otelp"
+       ports:
+       - containerPort: 9984
+         name: prometheus

+ 記号で始まるすべての行を構成に追加する必要があります。

エクスポータの COUCHDB_USERNAME と COUCHDB_PASSWORD 環境変数をモニタリング ユーザーの値で更新します。

構成の変更をローカル ファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

PodMonitoring リソースを定義する

ターゲット ディスカバリの場合、Managed Service for Prometheus Operator には、同じ Namespace 内の CouchDB エクスポータに対応する 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: couchdb
  labels:
    app.kubernetes.io/name: couchdb
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
    params:
      format:
      - prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: couchdb

ラベルセレクタとポートが、CouchDB エクスポータをインストールするで使用されているセレクタとポートと一致していることを確認します。

構成の変更をローカル ファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

ルールとアラートを定義する

次の Rules 構成を使用して、CouchDB 指標に関するアラートを定義できます。

# Copyright 2023 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: Rules
metadata:
  name: couchdb-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: couchdb-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: couchdb
    interval: 30s
    rules:
    - alert: CouchDBHighRequestRate
      annotations:
        description: |-
          CouchDB high request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: CouchDB high request rate (instance {{ $labels.instance }})
      expr: rate(couchdb_httpd_requests[5m]) > 100
      for: 5m
      labels:
        severity: warning
    - alert: CouchDBHighServerErrorRate
      annotations:
        description: |-
          CouchDB high server error rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: CouchDB high server error rate (instance {{ $labels.instance }})
      expr: rate(couchdb_httpd_status_codes{code="500"}[5m]) > 0
      for: 5m
      labels:
        severity: warning
    - alert: CouchDBLowRequestRate
      annotations:
        description: |-
          CouchDB low request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: CouchDB low request rate (instance {{ $labels.instance }})
      expr: rate(couchdb_httpd_requests[5m]) < 10
      for: 5m
      labels:
        severity: warning

構成の変更をローカル ファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

ルールをクラスタに適用する方法については、マネージド ルールの評価とアラートをご覧ください。

アラートのしきい値は、アプリケーションに合わせて調整できます。

構成を確認する

Metrics Explorer を使用すると、CouchDB エクスポータが正しく構成されていることを確認できます。Cloud Monitoring が指標を取り込むまでに 1～2 分かかる場合があります。

指標が取り込まれていることを確認します。

1. Google Cloud コンソールで、[Metrics Explorer] ページに移動します。

   Metrics Explorer に移動

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。

2. クエリビルダー ペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
3. [言語] で [PromQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定と同じツールバーにあります。
4. 次のクエリを入力して実行します。
   

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

ダッシュボードを表示する

Cloud Monitoring インテグレーションには、CouchDB Prometheus の概要ダッシュボードが含まれています。ダッシュボードは、インテグレーションを構成すると自動的にインストールされます。インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

インストールされているダッシュボードを表示する手順は次のとおりです。

1. Google Cloud コンソールで [ダッシュボード] ページに移動します。

   [ダッシュボード] に移動

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。

2. [ダッシュボード リスト] タブを選択します。
3. [統合] カテゴリを選択します。
4. ダッシュボードの名前（CouchDB Prometheus Overview など）をクリックします。

ダッシュボードの静的プレビューを表示する手順は次のとおりです。

1. Google Cloud コンソールで [統合] ページに移動します。

   [インテグレーション] に移動

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。

2. [デプロイメント プラットフォーム] フィルタの [Kubernetes Engine] をクリックします。
3. Apache CouchDB インテグレーションを見つけ、[詳細を表示] をクリックします。
4. [ダッシュボード] タブを選択します。

トラブルシューティング

指標の取り込みに関する問題のトラブルシューティングについては、取り込み側の問題のトラブルシューティングのエクスポータからの収集に関する問題をご覧ください。