Skip to main content
Version: NG-2.15

SQL Data Collector

Introduction​

SQL Data Collector O11ySource in vuSmartMaps allows you to collect data from various SQL databases using SQL queries. It supports MySQL, PostgreSQL, MSSQL, and Oracle DB and enables structured data collection for observability use cases.

Getting Started​

Compatibility​

vuSmartMaps enables collection of data from SQL Databases by use of SQL Queries thorugh SQL Data Collector O11ySource. This O11ySource officially supports MySQL Version 8.0+, Postgres Version 14.0+, MSSQL Version 2019+ and Oracle DB Version 23.0+.

Data Collection Method​

vuSmartMaps collects data from SQL Databases by using an internal data collector.

Prerequisites​

Setting up DB Credentials

  • DB Credentials must be saved under the User Credentials Section of the Definitions Page.

Inputs for Configuring Data Source​

  • Instance Name: Please enter the name of the SQL instance. This should be a unique identifier for the specific set of SQL queries queries polling the same databases
  • Database Driver: Please select the Database type
  • Database IP Address: Please enter the IP Address of the Destination Database
  • Database Port: Please enter the Port of the Destination Database
  • Database Credentials: Please select the User Credentials for Database from the dropdown
  • Query Name: Please enter a unique Query Name for each query in source
  • Query: SQL Query in string format with or without placeholders
  • Query Topic: Kafka Topic to send the query data to
  • Query Schedule Details: Please select appropriate scheduling type(Interval/ Cron)
  • Query Tracking Details: Please fill the appropriate query tracking information(if required)

Firewall Requirement​

To collect data from this O11ySource, ensure the following ports are opened:

Source IPDestination IPDestination PortProtocolDirection
vuSmartMaps IPIP address of the DB serverport*TCPOutbound

*Before providing the firewall requirements, please update the port based on the customer environment.

Configuring the Target​

SQL Data Collector, through VuNet's Internal Agent executes SQL Queries on the destination database & collects the data. The DB Credentials that is used to login must have the relevant permission to access the database & its component tables.

Configuration Steps​

  • Enable the O11ySource.
  • Select the sources tab and press the + button to add a new instance that has to be monitored.
  • Provide the required configurations:
  • Provide DB Details & Credentials
  • Provide Query String with or without Placeholders
  • Set Query Scheduling Information - Cron/Interval
  • Provide Query Tracking Type(optional)
  • Provide Query Tracking Information based on Type(optional)
  • Click Save to close the data source window.

Metrics Collected​

The metrics are based on the input data collected.