Connection Details

MongoDB Atlas endpoint hostnames

When connecting to a MongoDB Atlas cluster, the Hostname or IP Address field can use either a public endpoint hostname or a private endpoint, depending on your network configuration.

Public endpoint hostnames

To monitor your MongoDB Atlas cluster, add the IP address of the host running the Database Agent to the Database & Network Access > IP Access List.

Private endpoint hostnames

To use private endpoint discovery, configure the following feature flag on the Database Agent:

PLAINTEXT 
-Ddbagent.mongo.atlas.private.endpoint.discovery=true
Note: Private endpoint discovery is disabled by default.

After enabling the feature flag, configure the collector in one of the following ways:

  1. If the Database Agent host IP is included in the MongoDB Atlas network access list, use the MongoDB Atlas hostname.

    Example connection string:

    PLAINTEXT 
    mongodb://<username>:<password>@cluster0.example.mongodb.net/?tls=true

  2. If the Database Agent host IP is not included in the MongoDB Atlas network access list, use the private endpoint IP address and port. Keep TLS enabled for most cloud provider private endpoints.

    Example connection string:

    PLAINTEXT 
    mongodb://<username>:<password>@pl-XYZ-*:1027/?tls=true
Section Field Description
Create New Collector Database Type The database type that you want to monitor.
Agent The Database Agent that manages the collector.
Collector Name The name you want to identify the collector by.
Connection Details Hostname or IP Address The hostname or IP address of the machine that your database is running on.
Listener Port The TCP/IP address of the port on which your database communicates with the Database Agent.
Custom Connection String

The connection string generated by the database agent. You can also specify a custom connection string, which is useful for setting custom authentication options.

Note: Ensure that you do not specify the username and password in the custom connection string because it can cause a security risk.
SRV Record Enable this field to use the SRV record, where the connection string includes mongodb+srv .
Database Credentials Username The name of the user who is connecting to and monitoring the database through the Database Agent. The user should have the permissions described in User Permissions for MongoDB.
Password The password of the user who is connecting to and monitoring the database through the Database Agent.
CyberArk Click to enable CyberArk for database username and password. When CyberArk is enabled, information about Application, Safe, Folder, and Object is required to fetch the username and password for your database. To use CyberArk with Database Visibility, you must download the JavaPasswordSDK.jar file from the CyberArk website. Then, you must copy the JAR file to the lib directory of the database agent zip file.
HashiCorp Vault See Configure the HashiCorp Vault.
Advanced Options SSL Connection

Click to enable SSL Connection:

  • Truststore Location: Location of the certificate on the DB Agent host.
  • Truststore Type: Type of SSL Connection. There are three truststore types:
    • PKCS12 (default)
    • JKS
    • SSO: Enables auto-login. If you use SSO, you only need to provide the truststore location and truststore type
  • Truststore Password: Password for SSL Connection.

If you also use client certificate authentication, then click the Enable SSL Client Authentication box.

  • Keystore Location: location of the certificate on the DB Agent host.
  • Keystore Type: type of SSL Connection.
  • Keystore Password: password for SSL Connection.

You can set the context protocol for the SSL environment by using the following system variable:

CODE 
dbagent.mongodb.ssl.context.protocol

If you do not set the context protocol through the system variable, TLSv1.3 is used by default.

These platforms support TLSv1.3:

  • Oracle JDK >= 8u261-b12
  • AdoptOpenJDK >= 8u262-b10
  • Azul Platform Prime >= 20.07.0.0
Note: If a JDK version does not support TLSv1.3 or the specified context protocol, Splunk AppDynamics switches to TLSv1.2.
Exclude Databases The databases that you want to exclude, separated by commas.
Monitor Operating System See Configure the Database Agent to Monitor Server Hardware.
Note: When configuring the collector, ensure that you encode the username and password that uses special characters.