Manual Installation

WhaTap database monitoring collects metrics by having the DBX agent connect to the SingleStore cluster. You only need to install the agent on one aggregator node; leaf nodes are auto-detected through MV_NODES and collected together with the rest of the cluster. There is no need to install the agent on every node. This document guides the basic method of installing the agent manually and configuring the whatap.conf file. It targets SingleStore 9.0 or later environments.

Create a monitoring account

Create a dedicated monitoring account for the DBX agent and grant the following privileges.

grant select, process, cluster on *.* to '{monitoring_account}'@'%';

Privilege	Description
select	Query the system views and tables required for monitoring
process	Query information about running sessions and queries
cluster	Query cluster node configuration and distribution state

Some of the dedicated privileges included in the MySQL or MariaDB guides are not required in SingleStore.

SingleStore installation uses the Manual method.

Downloading the DBX agent

Download the DBX agent file. Use the following two methods.

• You can download it by using the 'wget' command.

  BASH

  wget -O whatap.agent.database.tar.gz "https://service.whatap.io/download/dbx_agent?type=singlestore&format=tar.gz"

• If you cannot download it with the command, select Download on the WhaTap monitoring service screen.

Download the DBX agent file and then unzip it.

BASH

tar -zxvf whatap.agent.database.tar.gz

Note

For users who cannot download tar files due to security settings, ZIP files are also provided. On the installation screen, select the .zip Download button.

Basic whatap.conf configuration

Set the following items in the whatap.conf file in the directory where the agent is installed.

whatap.conf

license={AccessKey}
whatap.server.host={WhaTap_Server_Address}
dbms=singlestore
db_ip={DB_Server_IP}
db_port={DB_Server_Port}

Option	Description
license	Project Access Key
whatap.server.host	WhaTap Server address to send data to
dbms	Fixed to singlestore
db_ip	IP of the SingleStore aggregator node to connect to
db_port	Connection port

Set dbms to singlestore. Leaving it as mysql, as you would for MySQL, keeps the SingleStore-specific screens from appearing.

For detailed descriptions of the configuration options, see the DBX Agent Configuration document.

Firewall configuration

The DB server must allow Inbound access so that the DBX agent can reach the DB port, and the DBX agent must be allowed Outbound traffic on port 6600 to send data to the WhaTap Server. For the list of collection server addresses, see the Supported environments document.

Type	Direction	Port
DBX agent → DB server	Inbound	DB connection port
DBX agent → WhaTap Server	Outbound	6600

Start monitoring

Once you finish the configuration and run the agent, it starts collecting metrics.