The MongoDB integration primarily collects database metrics, such as the number of operations and objects, as well as resource usage. The integration also collects logs and parses them into a JSON payload. The result includes fields for context, component, level, and message.
For more information about MongoDB, see MongoDB.
Prerequisites
To collect and ingest MongoDB logs and metrics, you must install Ops Agent version 2.11.0 or higher.
This receiver supports MongoDB versions 2.6, 3.x, 4.x, and 5.0.
Configure the Ops Agent for MongoDB
Following the guide for Configuring the Ops Agent, add the required elements to collect logs and metrics from your MongoDB instances, and restart the agent.
Example configuration
The following command creates the configuration file to collect and ingest logs and metrics for MongoDB and restarts the Ops Agent on Linux.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
receivers:
mongodb:
type: mongodb
service:
pipelines:
mongodb:
receivers:
- mongodb
metrics:
receivers:
mongodb:
type: mongodb
service:
pipelines:
mongodb:
receivers:
- mongodb
EOF
sudo service google-cloud-ops-agent restart
Configure logs collection
To ingest logs from MongoDB, you must create receivers for the logs MongoDB produces and then create a pipeline for the new receivers.
To configure a receiver for your mongodb
logs, specify the following fields:
Field | Default | Description |
---|---|---|
type |
This value must be mongodb . |
|
include_paths |
[/var/log/mongodb/mongod.log*] |
A list of filesystem paths to read by tailing each file. A wild card (* ) can be used in the paths; for example, /var/log/mongodb/*.log . |
exclude_paths |
[] |
A list of filesystem path patterns to exclude from the set matched by include_paths . |
record_log_file_path |
false |
If set to true , then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path label. When using a wildcard, only the path of the file from which the record was obtained is recorded. |
wildcard_refresh_interval |
60s |
The interval at which wildcard file paths in include_paths are refreshed. Specified as a time interval parsable by time.ParseDuration. Must be a multiple of 1s. |
What is logged
The logName
of the mongodb
logs are derived from the receiver IDs specified
in the configuration. Detailed fields inside the
LogEntry
are as follows.
Field | Type | Description |
---|---|---|
jsonPayload.component |
string | Categorization of the log message. A full list can be found in the MongoDB documentation. |
jsonPayload.ctx |
string | The name of the thread issuing the log statement. |
jsonPayload.id |
number | Log ID. |
jsonPayload.message |
string | Log message. |
jsonPayload.attributes |
object (optional) | Object containing one or more key-value pairs for any additional attributes provided. |
severity |
string (LogSeverity ) |
Log entry level (translated). |
timestamp |
string (Timestamp ) |
Time the entry was logged. |
Configure metrics collection
To collect metrics from MongoDB, you must create a receiver for MongoDB metrics and then create a pipeline for the new receiver. To configure a receiver for your MongoDB metrics, specify the following fields:
Field | Default | Description |
---|---|---|
type |
This value must be mongodb . |
|
collection_interval |
60s |
A time.Duration value, such as 30s or 5m . |
endpoint |
http://localhost:27017 |
The hostname, IP address, or UNIX domain socket. A port can be specified like <hostname>:<port>. If no port is specified the default 27017 will be used. |
username |
Username for authentication with the MongoDB instance. Required if password is set. |
|
password |
Password for authentication with the MongoDB instance. Required if username is set. |
|
insecure |
true |
Sets whether or not to use a secure TLS connection. If set to false , then TLS is enabled. |
insecure_skip_verify |
false |
Sets whether or not to skip verifying the certificate. If insecure is set to true , then the insecure_skip_verify value is not used. |
cert_file |
Path to the TLS certificate to use for TLS-required connections. | |
key_file |
Path to the TLS key to use for TLS-required connections. | |
ca_file |
Path to the CA certificate. As a client, this verifies the server certificate. If empty, the receiver uses the system root CA. |
What is monitored
The following table provides the list of metrics that the Ops Agent collects from the MongoDB instance.
Metric type | |
---|---|
Kind, Type Monitored resources |
Labels |
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 |
type
database
|
workload.googleapis.com/mongodb.data.size
|
|
GAUGE , INT64 gce_instance |
database
|
workload.googleapis.com/mongodb.global_lock.time
|
|
CUMULATIVE , INT64 gce_instance |
|
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 |
type
database
|
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.storage.size
|
|
CUMULATIVE , INT64 gce_instance |
database
|
Verify the configuration
You can use the Logs Explorer and Metrics Explorer to verify that you correctly configured the MongoDB receiver. It might take one or two minutes for the Ops Agent to begin collecting logs and metrics.
To verify the logs are ingested, go to the Logs Explorer and run the following query to view the MongoDB logs:
resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/mongodb")
To verify the metrics are ingested, go to
Metrics Explorer
and run the following query in the MQL tab.
fetch gce_instance
| metric 'workload.googleapis.com/mongodb.operation.count'
| align rate(1m)
| every 1m