Install the JDBC Driver for MongoDB Atlas

Distributed deployments

Use the tables below to determine where and how to install this add-on in a distributed deployment of Splunk Enterprise or any deployment for which you are using forwarders to get your data in. Depending on your environment, your preferences, and the requirements of the add-on, you may need to install the add-on in multiple places.

Where to install this add-on

Unless otherwise noted, all supported add-ons can be safely installed to all tiers of a distributed Splunk platform deployment. See Where to install Splunk add-ons in Splunk Add-ons for more information.

This table provides a reference for installing this specific add-on to a distributed deployment of the Splunk platform.

Splunk platform instance type	Supported	Required	Actions required / Comments
Search Heads	Yes	Yes	Install this add-on on Search Heads to enable the driver
Indexers	No	No	Not required, as apps which may require drivers run on Search Heads or Heavy Forwarder.
Heavy Forwarders	Yes	Yes	Install this add-on on Heavy Forwarder to enable the driver
Universal Forwarders	No	No	Install this add-on on Heavy Forwarder to enable the driver.

Distributed deployment feature compatibility

This table describes the compatibility of this add-on with Splunk distributed deployment features.

Distributed deployment feature	Supported	Actions required / Comments
Search Head Clusters	Yes	You can install this add-on on a search head cluster for having access to driver on search heads
Indexer Clusters	Yes
Deployment Server	Yes	Supported for deploying on Deployment Server.

Installation walkthroughs

The Splunk Add-Ons manual includes an Installing add-ons guide that helps you successfully install any Splunk-supported add-on to your Splunk platform.

For a walkthrough of the installation procedure, follow the link that matches your deployment scenario:

• Single-instance Splunk Enterprise
• Distributed Splunk Enterprise
• Splunk Cloud

Configure a JDBC connection to MongoDB Atlas using Splunk JDBC Driver for MongoDB Atlas

Authentication

It supports a basic authentication method using user and password attributes passed as a property or as a part of the connection string as query parameters. It requires to provide the authSource value as the database name associated with the user's credentials.

JDBC connection string

To be able to connect to your MongoDB Atlas using this driver you will need to enable the SQL Atlas Interface, go to Data Services > Database click Connect and select Atlas SQL, then in Select your driver choose JDBC Driver, copy the value from the URL field.

More about Atlas SQL Interface

Using this driver The JDBC connection string should start with the prefix jdbc:mongodb:// followed by the IP address / FQDN, port and database name, such as jdbc:mongodb://my-mongodb-atlas.net/my-database?authSource=my-user-credentials-database.

SSL connection

To use SSL connection specify ssl=true as part of the connection string as a query parameter.

Driver class

It supports auto loading according to JDBC 4.0, but in case there is a need for register it manually the driver class is com.splunk.dbx.mongodb.MongoDbDriver.