On this page


Installation of the Monitoring Stack involves setting up a monitoring node and at least one telemetry node. The monitoring node consists of a database for storing metrics, JMX interface for communication with Teamwork Cloud services, and web interface for realtime data visualization. The telemetry node installs server agents for streaming metrics to the monitoring node. We recommend deploying the monitoring node on a dedicated server. Single-node deployment of the Monitoring Stack and Teamwork Cloud is possible, provided there is enough system resources for all components.

Installing Monitoring Stack

Single-node deployment

Installation of the Monitoring Stack involves downloading the package, running the installation scripts on all nodes, and configuring visualization.

  1. Download and extract monitoring-stack_2024xRefresh2.zip.
  2. Add execute permission to all .sh files extracted, if they are not set.
  3. Navigate to the Monitoring-Node-Install folder.
  4. Execute install_monitoring_node.sh inside this folder (the script will require JSON and configuration files in the folder).
  5. Stop twcloud service.
  6. Navigate to the Telemetry-Node-Install folder.
  7. Execute install_telemetry_node.sh.
  8. Restart cassandra service.
  9. Start twcloud service.

Multi-node deployment

Use install_monitoring_node.sh to install the monitoring components and configure one telemetry node.

Then, use add_twc_monitor.sh to add each additional telemetry node. These telemetry nodes can be a Teamwork Cloud node or dedicated Cassandra node.

Finally, run install_telemetry.sh on each telemetry node.

  1. Download and extract monitoring-stack_2024xRefresh2.zip.
  2. Transfer the Monitoring-Node-Install folder to the monitoring node.
  3. Navigate to the Monitoring-Node-Install folder.
  4. Execute install_monitoring_node.sh inside this folder (the script will require JSON and configuration files in the folder).
    • Provide the address for one of the telemetry nodes during installation.
  5. After installation script finishes, execute add_twc_monitor.sh to add additional telemetry nodes.
    • One additional telemetry node will be added with each execution of add_twc_monitor.sh.
  6. Transfer the Telemetry-Node-Install folder to each telemetry node.
  7. On each telemetry node:
    1. Navigate to the Telemetry-Node-Install folder.
    2. Stop twcloud service.
    3. Execute install_telemetry_node.sh inside this folder.
    4. Restart cassandra service.
    5. Start twcloud service.