Configure Monitoring with Toolbox
On this page
Using Toolbox to configure cluster monitoring is the preferred and default method.
metrics database and pipeline DDLs and predefined values.
memsql-exporter process (or simply
the exporter) collects data about a running cluster.
root user) must have the following permissions at a minimum:
GRANT CLUSTER on *.* to <user>GRANT SHOW METADATA on *.* to <user>GRANT SELECT on *.* to <user>GRANT PROCESS on *.* to <user>
Perform the following steps on the Source cluster Master Aggregator.
Note that the exporter process is restarted when the
exporter_ variable is set to any non-zero value, including the current value.
exporter_ variable can be set by running
sdb-admin configure-monitoring --exporter-port <port>.
Run either of the following to start the exporter.
root user and default port (
sdb-admin configure-monitoring \--exporter-user root \--exporter-password <secure-password>
Copy the server certificate and key to the Master Aggregator host of the Source cluster.
This certificate will be used by the exporter process and must be readable by the user under which the nodes are running on the host (typically the
On the Source cluster, run the following command to start the exporter.sdb-admin configure-monitoring \--exporter-user root \--exporter-password <secure-password> \--exporter-use-https \--exporter-ssl-cert=/path/to/server-cert.pem \--exporter-ssl-key=/path/to/server-key.pem \--exporter-ssl-passphrase=<passphrase>
--exporter-ssl-passphraseoption should only be included if the server key has a passphrase.
Refer to configure-monitoring for additional options, including
You may stop the exporter at any time by running the following command on the Source cluster Master Aggregator.
sdb-admin configure-monitoring --stop-exporter
metrics database can either reside in the Source cluster, in a dedicated Metrics cluster, or in a remote SingleStoreDB cluster that the Metrics cluster can access.
Note that the user that creates the
metrics database may differ from the one that started the exporter.
The following command creates a database named metrics with a 10-day retention period for the data, and will also create the associated
exporter-host value must be the Master Aggregator host in the Source cluster.
password are the credentials for the Metrics cluster.
retention-period defines the number of days that data is retained before being deleted.
Please note the following:
The database that is created to store monitoring data is named
You may change the database name by updating the value of the
The database user is
When creating the
metricsdatabase with a database user other than
SUPERprivilege must be granted to this user.
For example, for a
GRANT SUPER ON *.
* TO 'dbmon'@'%';
The IP address provided in the
exporter-hostargument must be resolvable by all hosts in the cluster.
If the cluster you are monitoring has hosts that contain leaf nodes (as is common in a multi-host vs. single-host deployment), do not use
Instead, provide the explicit IP address or hostname that the other hosts in the cluster can resolve.
This command must be run on the Metrics cluster.
For Metrics clusters running SingleStoreDB 7.
--retention-period will apply to all existing Source clusters.
For Metrics clusters running SingleStoreDB 7.
--retention-period can be specified for each Source cluster.
--retention-period will only apply to that Source cluster.
Run the following command to start monitoring.
sdb-admin start-monitoring \--database-name metrics \--exporter-host <exporter-hostname-or-IP-address> \--user root \--password <secure-password> \--retention-period 10
Copy the CA certificate to the same file path on each host of the Metrics cluster.
Alternatively, a directory containing multiple CA certificates can be provided, and this path must be the same on all hosts.
This directory will be used by the monitoring pipelines and must be readable by the user under which the nodes are running on the host (typically the
Run the following command to start monitoring.sdb-admin start-monitoring \--database-name metrics \--exporter-host=<exporter-hostname-or-IP-address> \--user root \--password=<secure-password> \--retention-period 10 \--ssl-ca=/path/to/ca-cert.pem --or----ssl-capath=/ca-directory/including/path
Refer to start-monitoring for additional options.
You may stop the monitoring process at any time by performing the following command.
Note: Be sure to substitute the database name and/or the associated database user if you've changed them from the defaults of the
metrics database and the
sdb-admin stop-monitoring \--exporter-host <exporter-hostname-or-IP-address> \--user root \--password <secure-password>
Last modified: April 3, 2023