Activate the Database Collector
Activating a broker VM with a Database Collector applet enables you to collect data from a client relational database directly to your log repository.
Ingesting logs and data from external sources requires a
XDRPro per TB license.
The broker VM provides a Database Collector applet that enables you to collect data from a client relational database directly to your log repository for query and visualization purposes. After you activate the Database Collector applet on a broker VM in your network, you can collect records as datasets (
<Vendor>_<Product>_raw) by defining the following.
- Database connection details, where the connection type can be MySQL, PostgreSQL, MSSQL, and Oracle.CortexXDRuses Open Database Connectivity (ODBC) to access the databases.
- Settings related to the query details for collecting the data from the database to monitor and upload toCortexXDR.
Complete the following task before you begin setting up the FTP Collector applet.
Activate the Database Collector.
- InCortexXDR, selectand locate your broker VM.SettingsConfigurationsData BrokerBroker VMs
- Right-click the broker VM and select.Database CollectorActivate
- Configure your Database Connection.
- Configure theDatabase Connectionsettings.
- Connection—Select the type of database connection asMySQL,PostegreSQL,MSSQL, orOracle.
- Host—Specify the hostname or IP address of the database.
- Port—Specify the port number of the database.
- Database—Specify the database name for the type of database configured. This field is relevant when configuring aConnection TypeforMySQL,PostegreSQL, andMSSQL.When configuring anOracleconnection, this field is calledService Name, so you can specify the name of the service.
- Enable SSL—Select whether toEnable SSL(default) to encrypt the data while in transit between the database and the broker VM.
- Username—Specify the username to access the database.
- Password—Specify the password to access the database.
- Test Connection—Select to validate the database connection.
- Configure theDatabase Querysettings.
- Rising Column—Specify a column for the Database Collector applet to keep track of new rows from one input execution to the next. This column must be included in the query results.
- Retrieval Value—Specify aRetrieval Valuefor the Database Collector applet to determine which rows are new from one input execution to the next. The first time the input is run, the Database Collector applet only selects those rows that contain a value higher than the value you specified in this field. Each time the input finishes running, the Database Collector applet updates the input'sRetrieval Valuewith the value in the last row of theRising Column.
- Unique IDs—(optional) Specify the column name(s) to match against when multiple records have the same value in theRising Column. This column must be included in the query results. This is a comma separated field that supports multiple values. In addition, when specifying aUnique IDs, the query should use the greater than equal to sign (>=) in relation to theRetrieval Value. If theUnique IDsis left empty, the user should use the greater than sign (>).
- Collect Every—Specify the execution frequency of collection by designating a number and then selecting the unit as eitherSeconds,Minutes,Hours, orDays.
- VendorandProduct—Specify theVendorandProductfor the type of data being collected. The vendor and product are used to define the name of your XQL dataset (<Vendor>_<Product>_raw).
- SQL Query—Specify theSQL Queryto run and collect data from the database by replacing the example query provided in the editor box. The question mark (?) in the query is a checkpoint placeholder for theRetrieval Value. Every time the input is run, the Database Collector applet replaces the question mark with the latest checkpoint value (i.e. start value) for theRetrieval Value.
- Generate Preview—SelectGenerate Previewto display up to 10 rows from theSQL QueryandPreviewthe results. ThePreviewworks based on the Database Collector settings, which means that if after running the query no results are returned, then thePreviewreturns no records.
- Add Query—(optional) To define anotherQueryfor data collection on the configured database connection, selectAdd Query. AnotherQuerysection is displayed for you to configure.
- (optional)Add Connectionto define another database connection to collect data from another client relational database.
- (optional) Other available options.As needed, you can return to your Database Collector settings to manage your connections. Here are the actions available to you.
- Edit the connection name by hovering over the defaultCollectionname, and selecting the edit icon to edit the text.
- Edit the query name by hovering over the defaultQueryname, and selecting the edit icon to edit the text.
- Disable/Enablea query by hovering over the top area of the query section, on the opposite side of the query name, and selecting the applicable button.
- Delete a connection by hovering over the top area of the connection section, on the opposite side of the connection name, and selecting the delete icon. You can only delete a connection when you have more than one connection configured. Otherwise, this icon is not displayed.
- Delete a query by hovering over the top area of the query section, on the opposite side of the query name, and selecting the delete icon. You can only delete a query when you have more than one query configured. Otherwise, this icon is not displayed.
- Activatethe Database Collector applet.After a successful activation, theAppsfield displaysDatabase Collector - Active.
- (Optional) To view metrics about the Database Collector, hover over theDatabase Collectorlink in the Apps field.CortexXDRdisplaysResources, including the amount ofCPU,Memory, andDiskspace the applet is using.
- Manage the Database Collector.After you activate the Database Collector, you can make additional changes as needed. To modify a configuration, right-click your broker VM and select.
You can also Ingest Database Data as Datasets.
- to redefine the Database Collector configurations.Database CollectorConfigure
- to disable the Database Collector.Database CollectorDeactivate
Recommended For You
Recommended videos not found.