MongoDB

MongoDB 統合により、オペレーションとオブジェクトの数、リソースの使用状況など、主にデータベース指標が収集されます。この統合では、ログも収集され、JSON ペイロードが生成されます。結果には、context、component、level、message のフィールドが含まれます。

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

前提条件

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

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

この統合は、MongoDB バージョン 2.6、3.x、4.x、5.0、6.0 をサポートしています。

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

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

構成の例

次のコマンドは、MongoDB のテレメトリーを収集して取り込むための構成を作成します。

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# 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:
    mongodb:
      type: mongodb
      insecure: true
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
logging:
  receivers:
    mongodb:
      type: mongodb
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
EOF

これらの変更を有効にするには、Ops エージェントを再起動する必要があります。

Linux

エージェントを再起動するには、インスタンスで次のコマンドを実行します。
```
sudo systemctl restart google-cloud-ops-agent
```
エージェントが再起動したことを確認するには、次のコマンドを実行して「Metrics Agent」と「Logging エージェント」のコンポーネントが起動したことを確認します。
```
sudo systemctl status "google-cloud-ops-agent*"
```

Windows

RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。
PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。
エージェントを再起動するには、次の PowerShell コマンドを実行します。
```
Restart-Service google-cloud-ops-agent -Force
```
エージェントが再起動したことを確認するには、次のコマンドを実行して「Metrics Agent」と「Logging エージェント」のコンポーネントが起動したことを確認します。
```
Get-Service google-cloud-ops-agent*
```

ログの収集を構成する

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

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

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

ログの内容

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

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

フィールド	タイプ	説明
`jsonPayload.attributes`	オブジェクト（オプション）	指定された追加属性に対応する 1 つ以上の Key-Value ペアを含むオブジェクト
`jsonPayload.component`	文字列	ログメッセージのカテゴリ。詳細なリストについては、MongoDB のドキュメントをご覧ください。
`jsonPayload.context`	文字列
`jsonPayload.ctx`	文字列	ログステートメントを発行するスレッドの名前
`jsonPayload.id`	数値	ログ ID
`jsonPayload.message`	文字列	ログメッセージ
`jsonPayload.severity`	文字列	ログエントリレベル
`severity`	文字列（`LogSeverity`）	ログエントリレベル（変換済み）。

指標の収集を構成する

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

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

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

フィールド	デフォルト	説明
`ca_file`		CA 証明書のパス。クライアントとして、これによりサーバー証明書が検証されます。空の場合、レシーバーはシステムルート CA を使用します。
`cert_file`		mTLS で必要な接続に使用する TLS 証明書のパス。
`collection_interval`	`60s`	期間の値（例: `30s`、`5m`）。
`endpoint`	`localhost:27017`	ホスト名、IP アドレス、または UNIX ドメインソケット。ポートは `<hostname>:<port>` のように指定できます。ポートが指定されていない場合は、デフォルトの 27017 が使用されます。
`insecure`	`true`	セキュア TLS 接続を使用するかどうかを設定します。`false` に設定すると、TLS が有効になります。
`insecure_skip_verify`	`false`	証明書の検証をスキップするかどうかを指定します。`insecure` が `true` に設定されている場合、`insecure_skip_verify` 値は使用されません。
`key_file`		mTLS で必要な接続に使用する TLS キーのパス（`--tlsCertificateKeyFile` で使用されるキーなど）。
`password`		MongoDB インスタンスでの認証用パスワード。`username` が設定されている場合は必須。
`type`		値は、`mongodb` にする必要があります。
`username`		MongoDB インスタンスでの認証用ユーザー名。`password` が設定されている場合は必須。

モニタリング対象

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

指標タイプ
種類、タイプモニタリング対象リソース	ラベル
`workload.googleapis.com/mongodb.cache.operations`
`CUMULATIVE`、`INT64` gce_instance	`type`
`workload.googleapis.com/mongodb.collection.count`
`GAUGE`、`INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.connection.count`
`GAUGE`、`INT64` gce_instance	`database` `type`
`workload.googleapis.com/mongodb.cursor.count`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.cursor.timeout.count`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.data.size`
`GAUGE`、`INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.database.count`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.document.operation.count`
`GAUGE`、`INT64` gce_instance	`database` `operation`
`workload.googleapis.com/mongodb.global_lock.time`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.index.access.count`
`GAUGE`、`INT64` gce_instance	`collection` `database`
`workload.googleapis.com/mongodb.index.count`
`GAUGE`、`INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.index.size`
`GAUGE`、`INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.memory.usage`
`GAUGE`、`INT64` gce_instance	`database` `type`
`workload.googleapis.com/mongodb.network.io.receive`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.network.io.transmit`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.network.request.count`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.object.count`
`GAUGE`、`INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.operation.count`
`CUMULATIVE`、`INT64` gce_instance	`operation`
`workload.googleapis.com/mongodb.operation.time`
`CUMULATIVE`、`INT64` gce_instance	`operation`
`workload.googleapis.com/mongodb.session.count`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/mongodb.storage.size`
`CUMULATIVE`、`INT64` gce_instance	`database`

構成を確認する

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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