MongoDB (deprecated)

Use this Splunk Observability Cloud integration for the MongoDB monitor. See benefits, install, configuration, and metrics.

Note: The MongoDB monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won’t be able to use it to send data to Splunk Observability Cloud. To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. See MongoDB receiver to learn more.

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the MongoDB monitor type to capture the following metrics about MongoDB:

Memory
Network input/output bytes count
Heap usage
DB connections
Operations count
Active client connections
Queued operations

The plugin also captures the following DB-specific metrics:

DB size
DB counters

Prerequisites

The following applies:

This integration is only available on Kubernetes and Linux.
This integration requires MongoDB 2.6 or higher.
This integration is not supported for Splunk OTel Collector versions 0.99.0 or higher. Use the MongoDB receiver instead.

Benefits

インテグレーションを設定すると、これらの機能にアクセスできるようになります：

メトリクスを表示します。独自のカスタムダッシュボードを作成することができ、ほとんどのモニターは組み込みのダッシュボードも提供しています。ダッシュボードの詳細については、「Splunk Observability Cloudでダッシュボードを表示する」を参照してください。
Infrastructure Monitoring に表示される環境内の物理サーバー、仮想マシン、AWS インスタンス、およびその他リソースのデータ駆動型の視覚化を表示します。ナビゲータの詳細については、「Splunk Infrastructure Monitoring でナビゲーターを使用する」を参照してください。
Metric Finder へアクセスし、モニターから送信されたメトリクスを検索します。詳細は、「メトリクス・ファインダーとメタデータ・カタログを検索する」を参照してください。

Installation

このインテグレーションを導入するには、以下の手順に従ってください：

Splunk Distribution of OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします：
- Kubernetes にインストールする
- Linux にインストールする
設定のセクションで説明するように、モニターを設定します。
Splunk Distribution of OpenTelemetry Collector を再起動します。

Authentication

If you’re monitoring a secured MongoDB deployment, create a MongoDB user with minimal read-only roles, as follows:

db.createUser( {
  user: "<username>",
  pwd: "<password>",
  roles: [ { role: "readAnyDatabase", db: "admin" }, { role: "clusterMonitor", db: "admin" } ]
});

Note: Only SCRAM-SHA-1 authentication is supported.

Configuration

Smart Agent モニターとCollector のインテグレーションを使用するには、以下の手順に従います：

Smart Agent レシーバーを設定ファイルに含めます。
レシーバーセクションおよびパイプラインセクションの両方で、Collector 構成にモニタータイプを追加します。
- 「Collector でSmart Agent モニターを使用する」を参照してください。
- Smart Agent レシーバーの設定方法を参照してください。
- 一般的な構成オプションのリストについては、「モニターの共通設定」を参照してください。
- Collector の詳細については、「はじめに：Collector を理解して使用する」を参照してください。

Example

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/mongodb:
    type: collectd/mongodb
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/mongodb]

Configuration settings

The following table shows the configuration options for the MongoDB monitor:


Option	Required	Type	Description
`pythonBinary`	No	`string`	Path to the Python binary. If not set, a built-in runtime is used. This setting can include arguments to the binary.
`host`	Yes	`string`	Hostname or IP address of the MongoDB instance.
`port`	Yes	`integer`	Port of the MongoDB instance. The default value is `27017`.
`databases`	Yes	`list of strings`	Name of the databases you want to monitor. The first database in this list must be `admin`, as it’s used to perform a `serverStatus()` call.
`username`	No	`string`	MongoDB user.
`password`	No	`string`	Password of the user defined in `username`.
`useTLS`	No	`bool`	If `true`, the monitor connects to MongoDB using TLS. The default value is `false`.
`caCerts`	No	`string`	Path to a CA cert used to verify the certificate that MongoDB presents. Not needed if not using TLS or if MongoDB certificate is signed by a globally trusted issuer already installed in the default location on your system.
`tlsClientCert`	No	`string`	Path to a client certificate. Not needed unless your MongoDB instance requires x509 client verification.
`tlsClientKey`	No	`string`	Path to a client certificate key. Not needed unless your MongoDB instance requires x509 client verification, or if your client certificate defined in `tlsClientCert` includes the key.
`tlsClientKeyPassPhrase`	No	`string`	Passphrase for the TLS client key defined in `tlsClientKey`.
`sendCollectionMetrics`	No	`bool`	Whether to send collection level metrics or not. The default value is `false`.
`sendCollectionTopMetrics`	No	`bool`	Whether to send collection level top timing metrics or not. The default value is `false`.

Note: When using TLS authentication, SCRAM-SHA-256 is not supported. Use SCRAM-SHA-1 authentication.

Troubleshooting

__ ___ ___ _ ______ _____________ _____ ________ ___ ___ ___ ____ __ ___ ____ ____ __ ______ _____________ ______ ___ ___ ___ ____ __ ___ _________ _____

_________ __ ______ _____________ _____ _________

______ _ ____ __ ___ ______ _______ _______
_______ ______ ________

_________ __ ___________ _________ ___ ____ _____ _____

___ _ ________ ___ ___ _______ _______ _________ _______ __ ______ ________
____ ___ ______ ______________ ____ _____ _____ _______ __ ___________ ____ __________ _________ ___ ______ _________ __________ __ _____ ___ ____ _______