Skip to main content
Tungsten Clustering

Managing and Testing Exporters Using the tmonitor Command

tmonitor is a simple tool for the management and testing of Prometheus exporters.

Exporters that require an external binary to function (i.e. node_exporter and mysqld_exporter) are considered to have an External Scope.

Exporters that do not require an external binary to function (i.e. manager, replicator and connector) are considered to have an Internal Scope.

  • By default, tmonitor {action} will act upon all available exporters.
  • If any exporter is specified on the CLI, then only those listed on the CLI will be acted upon.
  • The curl command must be available in the PATH for the status and test actions to function.
  • tmonitor status will use curl to test the exporter on localhost.
  • tmonitor test will use curl to fetch and print the metrics from one or more exporters on localhost.
  • tmonitor install will configure the specified exporter (or all external exporters if none is specified) to start at boot.
  • tmonitor remove will stop the specified exporter (or all external exporters if none is specified) from starting at boot.
  • Both the install and remove actions will attempt to auto-detect the boot sub-system. Currently, initd and systemd are supported.
shell> tmonitor help
...
>>> Usage:

 tmonitor [args] {action}

 = Actions available for all exporter scopes:

    status - validate the service via curl (short output)
    test - validate the service via curl (full output)

 = Actions available for External-scope exporters only:

    start - launch the exporter process
    stop - kill the exporter process

    install - configure the exporter to start at boot
    remove - stop the exporter from starting at boot


>>> Arguments:

 [-h|--help]
 [-v|--verbose]
 [--force] Required for certain MySQL-specific operations

 [-f|--filter {string}] Limit the `tmonitor test` output based on this string match
 [-t|--tungsten] Set the `tmonitor test` filter to 'tungsten_'

 [-i|--internal] Only act upon exporters with an internal scope 
 [-e|-x|--external] Only act upon exporters with an external scope 

 --internal and --external may not be specified together.

 = Internal Scope Exporters:

   [-C|--connector] Specify the Tungsten Connector exporter
   [-M|--manager] Specify the Tungsten Manager exporter
   [-R|--replicator] Specify the Tungsten Replicator exporter

 = External Scope Exporters:

   [-m|--mysql|--mysqld] Specify the MySQL exporter
   [-n|--node] Specify the Node exporter

Example: View the status of all exporters:

shell> tmonitor status
Tungsten Connector exporter running ok on port 8093
Tungsten Manager exporter running ok on port 8092
MySQL exporter running ok on port 9104
Node exporter running ok on port 9100
Tungsten Replicator exporter running ok on port 8091
All 5 exporters are running ok (Up: Tungsten Connector, Tungsten Manager, MySQL, Node, Tungsten Replicator)

Example: Start all exporters:

shell> tmonitor start
tungsten@db1-demo:/home/tungsten # tmonitor start
Node exporter started successfully on port 9100.
MySQL exporter started successfully on port 9104.

shell> tmonitor start
The Node exporter is already running
The MySQL exporter is already running

Example: Test all exporters:

shell> tmonitor test | wc -l
3097

shell> tmonitor test | grep '== '
== Metrics for the connector exporter:
== Metrics for the manager exporter:
== Metrics for the mysql exporter:
== Metrics for the node exporter:
== Metrics for the replicator exporter:

Example: Stop all exporters:

shell> tmonitor stop
All exporters stopped

Example: View the status of all exporters filtered by scope:

shell> tmonitor status -i
Tungsten Connector exporter running ok on port 8093
Tungsten Manager exporter running ok on port 8092
Tungsten Replicator exporter running ok on port 8091
All 3 internal exporters are running ok (Up: Tungsten Connector, Tungsten Manager, Tungsten Replicator)

shell> tmonitor status -x
MySQL exporter running ok on port 9104
Node exporter running ok on port 9100
All 2 external exporters are running ok (Up: MySQL, Node)

Example: Install init.d boot scripts for all external exporters:

shell> sudo /opt/continuent/tungsten/cluster-home/bin/tmonitor install
node_exporter init.d boot script installed and activated

Use either `sudo service node_exporter start` or `tmonitor --node start` now to start the Node exporter.

mysqld_exporter init.d boot script installed and activated

Use either `sudo service mysqld_exporter start` or `tmonitor --mysql start` now to start the MySQL exporter.

Example: Install systemd boot scripts for all external exporters:

shell> sudo /opt/continuent/tungsten/cluster-home/bin/tmonitor install
Created symlink from /etc/systemd/system/multi-user.target.wants/node_exporter.service to /etc/systemd/system/node_exporter.service.
node_exporter systemd boot script installed and enabled

Use either `sudo systemctl start node_exporter` or `tmonitor --node start` now to start the Node exporter.

Created symlink from /etc/systemd/system/multi-user.target.wants/mysqld_exporter.service to /etc/systemd/system/mysqld_exporter.service.
mysqld_exporter systemd boot script installed and enabled

Use either `sudo systemctl start mysqld_exporter` or `tmonitor --mysql start` now to start the MySQL exporter.

Example: Remove init.d boot scripts for all external exporters:

shell> tmonitor stop
Node exporter stopped
MySQL exporter stopped

shell> sudo /opt/continuent/tungsten/cluster-home/bin/tmonitor remove
node_exporter init.d boot script de-activated and removed
mysqld_exporter init.d boot script de-activated and removed

Example: Remove systemd boot scripts for all external exporters:

shell> tmonitor stop
Node exporter stopped
MySQL exporter stopped

shell> sudo /opt/continuent/tungsten/cluster-home/bin/tmonitor remove
node_exporter systemd unit boot script disabled and removed
mysqld_exporter systemd unit boot script disabled and removed

The tmonitor command is located in the $CONTINUENT_ROOT/tungsten/cluster-home/bin directory.

note

The tmonitor command will only be available in the PATH if the Tungsten software has been installed with the configuration option profile-script included.