MongoDB

This plugin discovers databases and collections from MongoDB instances.

Status: experimental

Example Configuration

host: "mongo-cluster.company.com"
port: 27017
user: "analytics_reader"
password: "mongo_pass_456"
auth_source: "admin"
tls: true
tags:
  - "mongodb"
  - "analytics"

Configuration

The following configuration options are available:

Property	Type	Required	Description
connection_uri	string	false	MongoDB connection URI (overrides host/port/user/password)
host	string	false	MongoDB server hostname or IP address
port	int	false	MongoDB server port (default: 27017)
user	string	false	Username for authentication
password	string	false	Password for authentication
auth_source	string	false	Authentication database name
tls	bool	false	Enable TLS/SSL for connection
tls_insecure	bool	false	Skip verification of server certificate
include_databases	bool	false	Whether to discover databases
include_collections	bool	false	Whether to discover collections
include_views	bool	false	Whether to include views
include_indexes	bool	false	Whether to include index information
sample_schema	bool	false	Sample documents to infer schema
sample_size	int	false	Number of documents to sample (default: 1000, -1 for entire collection)
use_random_sampling	bool	false	Use random sampling for schema inference
database_filter	plugin.Filter	false	Filter configuration for databases
collection_filter	plugin.Filter	false	Filter configuration for collections
exclude_system_dbs	bool	false	Whether to exclude system databases (admin, config, local)

Available Metadata

The following metadata fields are available:

Field	Type	Description
background	bool	Whether the index was built in the background
capped	bool	Whether the collection is capped
collection	string	Collection name
created	string	Creation timestamp if available
data_types	[]string	Observed data types
database	string	Database name
description	string	Field description from validation schema if available
document_count	int64	Approximate document count
field_name	string	Field name
fields	string	Fields included in the index
frequency	float64	Frequency of field occurrence in documents
host	string	MongoDB server hostname
index_count	int	Number of indexes on collection
is_required	bool	Whether field appears in all documents
max_documents	int64	Maximum document count for capped collections
max_size	int64	Maximum size for capped collections
name	string	Index name
object_type	string	Object type (collection, view)
partial	bool	Whether the index is partial
partial_filter	string	Filter expression for partial indexes
port	int	MongoDB server port
replicated	bool	Whether collection is replicated
sample_values	string	Sample values from documents
shard_key	string	Shard key if collection is sharded
sharding_enabled	bool	Whether sharding is enabled
size	int64	Collection size in bytes
sparse	bool	Whether the index is sparse
storage_engine	string	Storage engine used
ttl	int	Time-to-live in seconds if TTL index
type	string	Index type (e.g., single field, compound, text, geo)
unique	bool	Whether the index enforces uniqueness
validation_action	string	Validation action if schema validation is enabled
validation_level	string	Validation level if schema validation is enabled