Configuring MySQL Connectors

Connectors allow Stellar Cyber to collect data from external sources and add it to the data lake.

You can install a connector to the OpenDental MySQL database or another data source. There can be any number of MySQL connectors.

Connector Overview: MySQL

Capabilities

  • Collect: Yes

  • Respond: No

  • Native Alerts Mapped: No

  • Runs on: DP

  • Interval: Configurable

Collected Data

Content Type

Index

Locating Records

SQL Result

Syslog

 

msg_class:

OpenDental

or, <data_source> for a provided Data Source

msg_origin.source:

opendental

or, <data_source> for a provided Data Source

msg_origin.vendor

OpenDental

or, for a provided Data Source:

  • <data_source> for root tenant

  • <data_source>_<tenant_id> for any non-root tenant

msg_origin.category:

crm

Domain

N/A

Response Actions

N/A

Third Party Native Alert Integration Details

N/A

Required Credentials

  • Server Hostname or IP, Username, Password, and Database Name

               Let us know if you find the above overview useful.

Adding a MySQL Connector

To add a MySQL connector:

  1. Add the connector in Stellar Cyber
  2. Test the connector
  3. Verify ingestion

Adding the Connector in Stellar Cyber

To add a MySQL connector in Stellar Cyber:

  1. Log in to Stellar Cyber.

  2. Click System | Integration | Connectors. The Connector Overview appears.

  3. Click Create. The General tab of the Add Connector screen appears. The information on this tab cannot be changed after you add the connector.

  4. Choose Database from the Category drop-down.

  5. Choose MySQL from the Type drop-down.

  6. For this connector, the supported Function is Collect, which is enabled already.

  7. Enter a Name.

    This field does not accept multibyte characters.

  8. Choose a Tenant Name. The Interflow records created by this connector include this tenant name.

  9. Choose the device on which to run the connector.

    • Certain connectors can be run on either a Sensor or a Data Processor. The available devices are displayed in the Run On menu. If you want to associate your collector with a sensor, you must have configured that sensor prior to configuring the connector or you will not be able to select it during initial configuration. If you select Data Processor, you will need to associate the connector with a Data Analyzer profile as a separate step. That step is not required for a sensor, which is configured with only one possible profile.

    • If the device you're connecting to is on premises, we recommend you run on the local sensor. If you're connecting to a cloud service, we recommend you run on the DP.

  10. (Optional) When the Function is Collect, you can create Log Filters. For information, see Managing Log Filters.

  11. Click Next. The Configuration tab appears.

  12. Enter the Server Hostname or IP. This is the hostname or IP address of the MySQL server. If entering a hostname, do not include https.

  13. Enter the Username of a user with read access to the database.

  14. Enter the Password for that user.

  15. Enter the Database Name. This is the name of the database on the MySQL server.

  16. Enter the Select Columns that you want to ingest. Separate column names with commas, or enter * for all columns.

  17. Enter the From Table. This is the table name in the database.

  18. Enter the Where Condition. This is an optional query condition in MySQL syntax. If you do not want to use a condition, leave it blank.

  19. Enter the Datetime Column. This is the column in the database containing the date and time information for the logs. The Datetime Column accepts epoch, mysql data type datetime, and timestamp.

  20. Enter the Data Source. You can select OpenDental from the dropdown or enter another value, for example, a vendor.

  21. Choose the Interval (min). This is how often the logs are collected.

  22. Enter the Data Timezone. This is the timezone for the data stored in the MySQL database.

  23. Choose the Content Type you would like to collect. The logs for SQL Result are supported.

  24. Click Next. The final confirmation tab appears.

  25. Click Submit.

    To pull data, a connector must be added to a Data Analyzer profile if it is running on the Data Processor.

  26. If you are adding rather than editing a connector with the Collect function enabled and you specified for it to run on a Data Processor, a dialog box now prompts you to add the connector to the default Data Analyzer profile. Click Cancel to leave it out of the default profile or click OK to add it to the default profile.

    • This prompt only occurs during the initial create connector process when Collect is enabled.

    • Certain connectors can be run on either a Sensor or a Data Processor, and some are best run on one versus the other. In any case, when the connector is run on a Data Processor, that connector must be included in a Data Analyzer profile. If you leave it out of the default profile, you must add it to another profile. You need the Administrator Root scope to add the connector to the Data Analyzer profile. If you do not have privileges to configure Data Analyzer profiles, a dialog displays recommending you ask your administrator to add it for you.

    • The first time you add a Collect connector to a profile, it pulls data immediately and then not again until the scheduled interval has elapsed. If the connector configuration dialog did not offer an option to set a specific interval, it is run every five minutes. Exceptions to this default interval are the Proofpoint on Demand (pulls data every 1 hour) and Azure Event Hub (continuously pulls data) connectors. The intervals for each connector are listed in the Connector Types & Functions topic.

    The Connector Overview appears.

The new connector is immediately active.

Testing the Connector

When you add (or edit) a connector, we recommend that you run a test to validate the connectivity parameters you entered. (The test validates only the authentication / connectivity; it does not validate data flow).

  1. Click System | Integrations | Connectors. The Connector Overview appears.

  2. Locate the connector that you added, or modified, or that you want to test.

  3. Click Test at the right side of that row. The test runs immediately.

    Note that you may run only one test at a time.

Stellar Cyber conducts a basic connectivity test for the connector and reports a success or failure result. A successful test indicates that you entered all of the connector information correctly.

To aid troubleshooting your connector, the dialog remains open until you explicitly close it by using the X button. If the test fails, you can select the  button from the same row to review and correct issues.

The connector status is updated every five (5) minutes. A successful test clears the connector status, but if issues persist, the status reverts to failed after a minute.

Repeat the test as needed.

ClosedDisplay sample messages...

Success !

Failure with summary of issue:

Show More example detail:

 

Verifying Ingestion

To verify ingestion:

  1. Click Investigate | Threat Hunting. The Interflow Search tab appears.
  2. Change the Indices to Syslog. The table immediately updates to show ingested Interflow records.