Skip to main content

Getting Started with SingleStore Monitoring

This document guides the entire flow for those setting up SingleStore monitoring for the first time. Once you create a monitoring account on the cluster and connect the DBX agent, metric collection begins within a few minutes. The intended readers are DBAs and infrastructure engineers who operate SingleStore.

Installation proceeds in the following order. The SingleStore installation screens are built on top of the MySQL installation screens, so the flow is similar.

  1. Check the Access Key
  2. Review the architecture diagram
  3. Create a DB account
  4. Download the DBX agent
  5. Configure the DBX agent
  6. Start monitoring

Check the Access Key​

When you create a WhaTap project, an Access Key is issued. This key identifies which project the agent sends data to. Enter it in the license field of the whatap.conf file.

Review the architecture diagram​

The installation screen shows the SingleStore cluster architecture diagram. You can see how the aggregator (MA, CA) and leaf (Leaf) nodes are connected and where the DBX agent connects. The DBX agent connects to an aggregator node, and leaf nodes are auto-detected through MV_NODES and collected together. For a description of node roles, see the SingleStore Monitoring document.

Create a DB account​

For the DBX agent to query cluster metrics, a dedicated monitoring account is required. Grant the following privileges.

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

The part that can be confusing here is the privilege setup. Some of the dedicated privileges mentioned in the MySQL or MariaDB installation guides are not used in SingleStore; the installation guide states that the three privileges above are sufficient.

Download and configure the DBX agent​

Download and install the DBX agent on an aggregator node, then configure the whatap.conf file. In db_ip, enter the address of the aggregator node to connect to. Leaf nodes are auto-detected through MV_NODES without being specified separately. SingleStore uses the following default settings.

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

For detailed descriptions of the configuration items, see the Manual Installation and DBX Agent Configuration documents.

For the firewall, allow Outbound traffic on port 6600 from the DBX agent to the WhaTap Server.

Start monitoring​

Once you finish the configuration and run the agent, metric collection begins. When collection works properly, you can check the data on each screen in SingleStore Monitoring.

Last updated on