About the MongoDB collector

Important

This collector is available in Private Preview. If you would like access to this collector, please contact your Customer Success Director.

The MongoDB collector harvests metadata from the MongoDB instance (cluster), databases, collections, indexes, search indexes, and document fields. It also supports harvesting of nested fields for the Document/Object field types.

The collector captures relationship information between instances (clusters), databases, collections, document fields, search indexes, and indexes.

Note

The latest version of the Collector is 2.252. To view the release notes for this version and all previous versions, please go here.

What is cataloged

The collector catalogs the following information.

Table 1.

Object	Information cataloged
MongoDB	MongoDB (instance, cluster) name, MongoDB (instance, cluster) version, Is Debug Mode
MongoDB Database	Database Name, Size On Disk, Is Empty, Views Number, Collections Number, Average Database Object Size, Data Size, Storage Size, Total Free Storage Size, Database Indexes Number, Database Indexes Size
MongoDB Collection (including Materialized View as kos-mongodb:MongodbCollection type)	Collection Name, Documents Count, Collection Size, Average Object Size, Orphan Documents Number, Storage Size, Collection Free Storage Size, Total Index Size, Index Number, Collection Total Size, Is Capped, Capped Collection Maximum Size, Capped Documents Maximum Number
MongoDB View	View Name
MongoDB Collection Field	Field Name
MongoDB Index	Index Name, Index Size, Is Unique, Default Language
MongoDB Search Index	Index Name, Type, Status, Is Queryable, Is Dynamic, Creation Time

Relationships between objects

By default, the data.world catalog includes catalog pages for the following resource types. Each catalog page has a relationship to the other related resource types. Note that the catalog presentation and relationships are fully configurable, so these will list the default configuration.

Table 2.

Resource page	Relationship
MongoDB	Has Database <MongoDB Database>
MongoDB Database	Contains Collection <MongoDB Collection> Is contained within MongoDB Contains MongoDB View
MongoDB Collection	Is contained within MongoDB Database Has Collection Field <MongoDB Collection Field> Has Index <MongoDB Index> Has Search Index <MongoDB Search Index>
MongoDB View	Has Collection Field <MongoDB Collection Field>
MongoDB Collection Field Note: The --analysis-samples-count parameter specifies the number of documents sampled from a collection to determine collection field types. This value must be a non-negative integer, with a default of 1000. Sampling is performed using the $sample aggregation. For more information, see the MongoDB sampling documentation.	Has Nested Field <MongoDB Collection Field> Is contained within MongoDB Collection Is contained within MongoDB View
MongoDB Index	Is contained within MongoDB Collection
MongoDB Search Index	Is contained within MongoDB Collection

Authentication supported

The MongoDB collector supports the following authentication methods:
- username and password authentication (SCRAM)
- X.509 authentication
- AWS Authentication

In this section: