Apache CouchDB

Apache CouchDB の統合では、ノードへのリクエスト数やノードからのレスポンスなど、トラフィック関連の指標が収集されます。また、開いているオペレーション数などのデータベース指標も収集します。この統合では、一般的な CouchDB ログとアクセスログを収集して JSON ペイロードを生成します。結果には、user、host、level、message のフィールドが含まれます。

CouchDB の詳細については、Apache CouchDB のドキュメントをご覧ください。

前提条件

CouchDB テレメトリーを収集するには、Ops エージェントをインストールする必要があります。

指標の場合は、バージョン 2.10.0 以降をインストールします。
ログの場合は、バージョン 2.11.0 以降をインストールします。

このインテグレーションでは、CouchDB バージョン 2.3.x と 3.1 以降がサポートされます。

CouchDB 用に Ops エージェントを構成する

Ops エージェントを構成するのガイドに従って、CouchDB インスタンスからテレメトリーを収集するために必要な要素を追加し、エージェントを再起動します。

構成の例

次のコマンドは、CouchDB のテレメトリーを収集して取り込み、Ops エージェントを再起動するための構成を作成します。

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchdb:
      type: couchdb
      username: admin
      password: otelp
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF

sudo service google-cloud-ops-agent restart
sleep 30

ログの収集を構成する

CouchDB からログを取り込むには、CouchDB が生成するログのレシーバーを作成してから、新しいレシーバー用のパイプラインを作成する必要があります。

couchdb ログのレシーバーを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`exclude_paths`		`include_paths` の照合で除外するファイルシステムパスのパターンのリスト。
`include_paths`	`[/var/log/couchdb/couchdb.log]`	各ファイルのテーリングで読み込むファイルシステムのパスのリスト。パスには、`/var/log/couchdb/.log` のように、ワイルドカード（`*`）を使用できます。
`record_log_file_path`	`false`	`true` に設定すると、ログレコードの取得元のファイルのパスが `agent.googleapis.com/log_file_path` ラベルの値として出力ログエントリに表示されます。ワイルドカードを使用する場合、レコードを取得したファイルのパスのみが記録されます。
`type`		この値は、`couchdb` にする必要があります。
`wildcard_refresh_interval`	`60s`	`include_paths` のワイルドカードファイルのパスの更新間隔。期間を指定します（例: `30s`、`2m`）。このプロパティは、ログファイルのローテーションがデフォルトの間隔よりも速く、ロギングのスループットが高い場合に有用です。

ログの内容

logName は、構成で指定されたレシーバ ID から取得されます。LogEntry 内の詳細なフィールドは、次のとおりです。

couchdb ログの LogEntry には次のフィールドが含まれます。

フィールド	タイプ	説明
`httpRequest`	オブジェクト	`HttpRequest` を参照
`jsonPayload.host`	文字列	ホストインスタンス名
`jsonPayload.level`	文字列	ログエントリレベル
`jsonPayload.message`	文字列	ログメッセージ
`jsonPayload.node`	文字列	ノードのインスタンス名
`jsonPayload.path`	文字列	リクエストパス
`jsonPayload.pid`	文字列	プロセス ID
`jsonPayload.remote_user`	文字列	リクエストの認証済みユーザー名
`jsonPayload.status_message`	文字列	ステータスコードメッセージ
`severity`	文字列（`LogSeverity`）	ログエントリレベル（変換済み）。

指標の収集を構成する

CouchDB から指標を取り込むには、CouchDB が生成する指標のレシーバーを作成してから、新しいレシーバー用のパイプラインを作成する必要があります。

このレシーバーでは、複数のエンドポイントのモニタリングなど、構成で複数のインスタンスを使用することはできません。このようなインスタンスはすべて同じ時系列に書き込まれるため、Cloud Monitoring ではインスタンスを区別できません。

couchdb 指標のレシーバーを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`collection_interval`	`60s`	期間の値（例: `30s`、`5m`）。
`password`		サーバーへの接続に使用するパスワード。
`server_status_url`	`http://localhost:5984`	CouchDB によって公開される URL。
`type`		値は、`couchdb` にする必要があります。
`username`		サーバーへの接続に使用するユーザー名。

モニタリング対象

次の表に、Ops エージェントが CouchDB インスタンスから収集する指標の一覧を示します。

指標タイプ
種類、タイプモニタリング対象リソース	ラベル
`workload.googleapis.com/couchdb.average_request_time`
`GAUGE`、`DOUBLE` gce_instance
`workload.googleapis.com/couchdb.database.open`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/couchdb.database.operations`
`CUMULATIVE`、`INT64` gce_instance	`operation`
`workload.googleapis.com/couchdb.file_descriptor.open`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.bulk_requests`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.requests`
`CUMULATIVE`、`INT64` gce_instance	`http_method`
`workload.googleapis.com/couchdb.httpd.responses`
`CUMULATIVE`、`INT64` gce_instance	`http_status_code`
`workload.googleapis.com/couchdb.httpd.views`
`CUMULATIVE`、`INT64` gce_instance	`view`

構成を確認する

このセクションでは、CouchDB レシーバー正しく構成されていることを確認する方法について説明します。Ops エージェントがテレメトリーの収集を開始するまでに 1～2 分かかる場合があります。

CouchDB ログが Cloud Logging に送信されていることを確認するには、次のようにします。

Google Cloud コンソールで、[ログエクスプローラ] ページに移動します。
[ログエクスプローラ] に移動

検索バーを使用してこのページを検索する場合は、小見出しが「Logging」の結果を選択します。
エディタに次のクエリを入力し、[クエリを実行] をクリックします。
```
resource.type="gce_instance"
log_id("couchdb")
```

CouchDB 指標が Cloud Monitoring に送信されていることを確認するには、次のようにします。

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

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
クエリビルダーペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
[言語] で [MQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定と同じツールバーにあります。
エディタに次のクエリを入力し、[クエリを実行] をクリックします。
```
fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m
```

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

CouchDB 指標を表示するには、グラフまたはダッシュボードが構成されている必要があります。CouchDB インテグレーションには、1 つ以上のダッシュボードが含まれています。インテグレーションを構成して Ops エージェントが指標データの収集を開始すると、ダッシュボードは自動的にインストールされます。

インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

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

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

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
[ダッシュボードリスト] タブを選択し、[統合] カテゴリを選択します。
表示するダッシュボードの名前をクリックします。

インテグレーションを構成してもダッシュボードがインストールされていない場合は、Ops エージェントが実行されていることを確認します。ダッシュボードにグラフの指標データがない場合、ダッシュボードのインストールは失敗します。Ops エージェントが指標の収集を開始した後に、ダッシュボードがインストールされます。

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

Google Cloud コンソールで [インテグレーション] ページに移動します。
[インテグレーション] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
[デプロイメントプラットフォーム] フィルタの [Compute Engine] をクリックします。
CouchDB のエントリを見つけて、[詳細を表示] をクリックします。
[ダッシュボード] タブを選択すると、静的プレビューが表示されます。ダッシュボードがインストールされている場合は、[ダッシュボードを表示] をクリックして移動できます。

Cloud Monitoring のダッシュボードについて詳しくは、ダッシュボードとグラフをご覧ください。

[インテグレーション] ページの使用方法については、インテグレーションを管理するをご覧ください。

アラートポリシーをインストールする

アラートポリシーは、指定した条件が成立した際に通知するように Cloud Monitoring に指示します。CouchDB インテグレーションには、使用する 1 つ以上のアラートポリシーが含まれています。これらのアラートポリシーは、Monitoring の [インテグレーション] ページで表示してインストールできます。

使用可能なアラートポリシーの説明を表示してインストールする手順は次のとおりです。

Google Cloud コンソールで [統合] ページに移動します。
[インテグレーション] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
CouchDB のエントリを見つけて、[詳細を表示] をクリックします。
[アラート] タブを選択します。このタブには、利用可能なアラートポリシーの説明と、それらをインストールするためのインターフェースが表示されます。
アラートポリシーをインストールします。アラートポリシーでは、アラートがトリガーされた通知の送信先を特定する必要があるため、インストール環境の情報が必要になります。アラートポリシーをインストールする手順は次のとおりです。
1. 利用可能なアラートポリシーのリストから、インストールするアラートポリシーを選択します。
2. [通知の構成] セクションで、1 つ以上の通知チャンネルを選択します。通知チャンネルの使用を無効にすることもできますが、無効にすると、アラートポリシーは通知なく起動します。Monitoring でステータスを確認できますが、通知は受信しません。
  
  通知チャンネルの詳細については、通知チャンネルを管理するをご覧ください。
3. [ポリシーの作成] をクリックします。

Cloud Monitoring のアラートポリシーの詳細については、アラートの概要をご覧ください。