Deploy a BI Connector
On this page
The MongoDB Connector for Business Intelligence allows you to query a MongoDB database using SQL commands to aid in data analysis. It translates SQL queries from data analysis tools to MongoDB aggregation pipelines on MongoDB database. To learn more about the BI Connector, see the BI Connector manual.
Use the following procedure to deploy a new MongoDB BI Connector for Ops Manager to manage.
Limitations
The BI Connector allows only read-only operations on data served in MongoDB databases. To create, update, or delete data you must use
mongoshor any appropriate driver.MongoDB BI Connector for Ops Manager is not compatible with the following authentication methods:
The BI Connector cannot be deployed using Ops Manager if the automation agent authentication mechanism is Kerberos (
GSSAPI) authentication.
Prerequisites
To deploy MongoDB clusters, you must provision hosts to serve those clusters. Ops Manager requires access to these hosts.
Important
If you run MongoDB Enterprise and provision your own Linux hosts, then you must manually install a set of dependencies to each server before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies.
To learn more about the specifics for an operating system, see the following:
Procedure
Navigate to the Processes tab for your deployment.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Processes in the sidebar.
Configure the BI Connector instance.
In the New BI Connector modal, configure the following settings:
Choose Server | Select the host where this new BI Connector is installed. |
Deployment Item | Select the deployment item (standalone, replica set,
or sharded cluster) to which this new BI connector
connects. |
Port to Listen On | Type the IANA port number you want to use when connecting
to this new BI Connector. The recommended port number is
3306. |
Read Preference | Select how the BI connector routes read operations to the members of a replica set. Available values include: |
Included Namespace(s) (Optional) | Type the name of a database and/or collection to limit what data the BI Connector can access. Leave this box blank to allow the BI Connector to use all namespaces on the host. Click the + add another namespace link to add another namespace to your list of included namespaces. |
Note
Ops Manager manages the BI Connector version. You cannot select a different version of the BI Connector.
Set any Additional settings for the BI Connector instance.
TLS (Optional)
If you need to use TLS to connect with the Deployment Item, configure these settings:
TLs Mode | Select Disabled, Allow TLS, or
Require TLS. |
TLS PEM Key File Path | Type the path on the MongoDB host where the TLS PEM key
file is stored. |
TLS PEM Key Password (Optional) | If you encrypted the PEM file, type its password. |
Minimum TLS Version | Select the minimum TLS version to connect to the
BI Connector. Default value is TLS1_0. Accepted values
are TLS1_0, TLS1_1, and TLS1_2. |
MongoDB Minimum TLS Version | Select the minimum TLS version to connect to MongoDB.
Default value is TLS1_0. Accepted values are
TLS1_0, TLS1_1, and TLS1_2. |
Logs (Required)
Linux Log File Path | (Conditional: BI Connector is installed on a Linux
platform) Type the path to the BI Connector log on that
host. |
Windows Log File Path | (Conditional: BI Connector is installed on a Windows
platform) Type the path to the BI Connector log
on that host. |
Log Verbosity | Select logging level for the BI Connector. Accepted
values are These values correspond to
log verbosity levels
of |
Log Rotation | Toggle to If toggled to The next four settings require Log Rotation
to be set to |
Size Threshold (MB) | (Conditional: Log Rotation = ON )
Type the size the log file must reach in
MB before the BI Connector rotates it
automatically. The default value is
1000.0 (about 1 GB). |
Time Threshold (Hours) | (Conditional: Log Rotation = ON )
Type the duration the log file must cover in hours before
the BI Connector rotates it automatically. The default
value is 24 hours. |
Max Uncompressed Files | (Conditional: Log Rotation = ON )
Type how many rotated log files may stay uncompressed in
the log directory before they are archived and compressed.
(The suggested number is 2.) |
Max Percent of Disk | (Conditional: Log Rotation = ON )
Type the percentage of disk space on the host the log
files may consume before older files are deleted. (The
suggested number is 5.) |
Schema (Optional)
Max Length for varChar Fields | Type the maximum number of characters that can exist in a
VARCHAR field. |
Refresh Interval (Seconds) | Type how much time must elapse in seconds before the BI Connector refreshes the schema. |
Sample Size (# of Documents in Collection) | Type how many MongoDB documents are included in each sample the schema examines. To learn more on how the BI Connector performs sampling, see Cached Sampling. |
Allow Schema Alterations from SQL Client | Toggle if the user can alter the schema using an
SQL client. |