This section explains each of the properties in the configuration blade.
This associates this Agent to a specific Collection and defaults to that of the current Data Stream.
Polling Interval (seconds)
This determines how often the data is read from the table, e.g. every ten seconds.
Use Connection Variables
Tick to select saved MongoDB variables; or enter the text manually.
The address of the MongoDB server.
The Server Port of the MongoDB server.
The authentication options for the connection are:
The user name to use for authenticating the connection (applies to SCRAM Authentication Type only).
The password to use for authenticating the connection (applies to SCRAM Authentication Type only).
Once the Server properties are entered, the Agent will attempt to open a connection with the server. If successful, the Database property is populated with a list of available databases.
The name of the database to connect to. Once selected, the Table property will be populated with the list of available tables in the database.
Specify MongoDB Query Command
Tick to return rows from a query; or leave unticked to return rows from a table (default).
MongoDB Query Command
The command to query data from MongoDB collection (applies when Specify MongoDB Query Command is ticked). Refer here for the Query Command Format.
The name of the table to connect to (applies when Specify MongoDB Query Command is unticked). Once selected, the Fields To Return dropdown will be populated with available fields of the collection.
Fields To Return
The columns which the Agent should return. If no columns are specified, the Agent will return all the columns from the table.
This section applies when Specify MongoDB Query Command is unticked.
Limit Rows By
The maximum rows that are returned in a single poll. The options are:
Number of Rows
The number of rows that are returned (applies to Number Limit Rows By only).
Day, Hour or Minute (applies to Duration Limit Rows By only).
The value of the duration (applies to Duration Limit Rows By only).
The column used when calculating the duration (applies to Duration Limit Rows By only).
Specify Filter Text
Rules for filtering the returned results (optional).
The column(s) and sort order applied to the results (optional).
The read events will be made available on this Endpoint with attributes as per Columns To Return.
Errors encountered during the execution of this Agent will be published on this endpoint.