Overview Documentation

Getting started with Galago

Getting started with Galago is simple. You'll need 1) an agent and 2) a host id. If you run into questions at any point, feel free to ping us at support@galagomonitoring.com.

2 Minute Overview

Solution overview from Sign Up to live data...

Agent Download

Download the Galago agent here or from within the Galago dashboard.

For 64-bit Linux OS: x64

For ARM processors: ARM (includes most Raspberry Pis)

Host ID

Each agent requires a unique host id to operate. This id authenticates the host with Galago servers and allows for communication and visualization on the Galago dashboard. Host ids can be requested on a user’s Account page.

Agent Setup

To configure the agent, place the downloaded agent in a directory of choice. From within that directory:

  1. Rename the agent from the downloaded name [galago_arm , galago_x64] to galago
      mv galago_x64 galago
  2. Make the agent executable
      chmod +x galago
  3. Generate config file:
      ./galago conf will generate galago.conf.gen
  4. Edit galago.conf.gen with additional configuration options
  5. Rename generated config to galago.conf
      mv galago.conf.gen galago.conf
  6. Run agent

Running the Agent

There are three options to run the agent.

  1. To run the agent as a Service
      Setup a service for the Agent (starts on boot):
        sudo ./galago boot -> Generates galago.service in /etc/systemd/system
      To start the Agent once it’s configured as a service:
        sudo service galago start
  2. To run the configured agent manually
      [sudo] ./galago [&]
  3. To run the unconfigured agent with default parameters (skipping agent setup above)
      [sudo] ./galago id <host_id> [&]

Recommended Setup: We recommend the user generates and edits the configuration file, and then runs the agent as a service (option 1).

The show-me-data-now setup: To immediately see basic host resources on the Galago dashboard, run option 3.

Recommended File Structure

  • 📁 my_galago_directory
    • 📄 galago - agent
    • 📄 galago.conf - Config file
    • 📄 galago.log - automatically generated log file

Agent Operation

Metrics

The galago agent can monitor the following metrics:

  • Host Connectivity - checked every 10 minutes
  • Resources (x7)
    • CPU Load Averages (% over 1, 5, 15 min)
    • CPU Temperature (highest core ºC)
    • RAM Usage (%)
    • Network Usage (TX & RX MB/min)
  • Partitions (x10) - Monitor the % usage of up to 10 user-defined partitions
  • Processes (x10) - Monitor the boolean status of up to 10 user-defined processes
  • RabbitMQ (x10) - Monitor the queue size in messages of up to 10 user-defined queues
  • Custom Metrics (x10) - In Beta - Monitor up to 10 custom metrics. Please contact support to demo this functionality with your existing agent.

Alerts

Alerts can be triggered for all metrics as follows:

  • Host Connectivity - produced automatically
  • Resources - triggered when a user-defined threshold is exceeded (x>y)
  • Partitions - triggered when a user-defined threshold is exceeded (x>y)
  • Processes - automatically triggered when process is not running (x=0)
  • RabbitMQ - triggered when a user-defined threshold is exceeded (x>y)
  • Custom Metrics - triggered when a user-defined condition is met (x !<=> y)

Recovery messages are automatically generated in all cases. User-defined thresholds are specified in galago.conf.

Message Frequency

Real-time Data

Real-time messages contain data from all metrics. Each real-time message is generated every x minute(s) and sent every y minute(s). For instance:

  • X=1, Y=1 Stockholm-icons / Navigation / Arrow-right Created with Sketch. 1 message sent every minute
  • X=1, Y=10 Stockholm-icons / Navigation / Arrow-right Created with Sketch. Collect a real-time message every 1 minute and send collected messages in 10 minute intervals (10 messages sent every 10 minutes)
  • X=10, Y=1 Stockholm-icons / Navigation / Arrow-right Created with Sketch. Collect a real-time message every 10 minutes and send collected messages in 1 minute intervals (1 message in 10 minute intervals)
  • X=1, Y=90 Stockholm-icons / Navigation / Arrow-right Created with Sketch. Collect a real-time message every 1 minute and send collected messages in 90 minute intervals (90 messages in 90 minute intervals)

Keep-Alives

Keep-alive messages are sent automatically from the host to ensure continued connectivity. If a host is configured to send real-time data in 10 minute or less intervals, then keep-alives are not necessary. However, if the messaging frequency exceeds 10 minutes, keep-alives will be sent as necessary to ensure continued interaction with Galago servers. Connectivity is checked on the server side every 10 minutes.

Logging

In galago.conf, specify a directory path for the galago.log. This location must be writable for the log file to appear.

    E.g. /home/user/galago/

If the log becomes un-writable or the directory path is not specified, log output will appear in the syslog.

Alert Preferences

Users can select their preference for real-time email alerts from the host management page on the dashboard.

3 options are available:

  • No Alerts
  • Only Keep-Alives - Alerts are only sent if the host/agent connects or disconnects from Galago servers. Host connectivity is checked every 10 minutes.
  • All Alerts - Keep-alives and user-defined alerts, including recovery alerts in all cases.

Text message alerts are available on request, and are configured for All Alerts.

Jump to