Downloads

Download the twc-scripts-<version>-linux-monitoring-stack.zip script package here.


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, Telegraf for pulling metrics from Teamwork Cloud, and the Cassandra database, with a web interface based on Grafana for real-time data visualization. The installation script installs Telegraf to stream 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 are enough system resources for all components.

wget is not part of the installation script. Install it using the following command:

sudo dnf install wget -y
TEXT

Installing Monitoring Stack

Single-node deployment (Cassandra, Teamwork Cloud, and Monitoring Stack installed all on the same server)

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

  1. Download and extract monitoring-stack_<version>.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. Navigate to the Telemetry-Node-Install folder.
  6. Execute install_telemetry_node.sh. Provide either the fully qualified domain name, or the IP address of the server.
  7. Stop twcloud service.
  8. Restart cassandra service.
  9. Start twcloud service.
  10. Proceed to import and configure the Grafana dashboard below.

Multi-node deployment (Cassandra/Teamwork Cloud on one server, and Monitoring Stack installed on a separate server)

Installation of the Monitoring Stack involves downloading the monitoring stack scripts, extracting the scripts, and then using install_monitoring_node.sh to install the monitoring stack software on that node. Then the script install_telemetry_node.sh can be run to install the telemetry software on any node with Teamwork Cloud and/or Cassandra installed.

  1. On the monitoring node (node that is to host the Grafana interface), download and extract monitoring-stack_<version>.zip on the monitoring node (the node with the Grafana interface).
  2. Navigate to the Monitoring-Node-Install folder.
  3. Execute install_monitoring_node.sh inside this folder (the script will require JSON and configuration files in the folder).
  4. Transfer the Telemetry-Node-Install folder to each telemetry node.
  5. 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. Provide the IP address or fully qualified domain name for the monitoring server.
    4. Restart cassandra service.
    5. Start twcloud service.
  6. Proceed to import and configure the Grafana dashboard below.

Importing Grafana dashboard

To set up Grafana dashboard

  1. Go to the Grafana home page at http://<monitoring-node>:3000 (note the HTTP address) in a web browser.  
  2. Log in to the Grafana dashboard. Use default credentials of admin/admin for new installation; You will be prompted to change the admin password after initial login.
  3. From the home page, locate the Dashboards menu on the left menu and select Import:

  4. Click the Upload JSON File button. Locate and select the Grafana dashboard file called Teamwork Cloud Dashboard.json from the monitoring stack package.  
  5. Map the telegraf data source to Telegraf as show below. Click Import.
  6. To set this dashboard as the default Home Dashboard, go to Configuration and select Preferences. Select the Teamwork Cloud dashboard under Home Dashboard and save.
The monitoring node installation script creates a guest user, with credentials guest/guest, who can view the dashboard but cannot make any changes to it.