Getting started

Speculare Client is the collector daemon that run on your VMs/servers/... It run constantly on any servers you want to monitor and send the data collected (cpu, ram, disk/net io, ...) to Speculare Server.

Setup

As of now Speculare Client does not provide easy setup solution such as a one-line installer (but it's planned). The current recommanded way to install Speculare Client is to build it from source. But don't be afraid, it's easy and straightforwards.

You can also build it once for your platform (ie: Linux-x86) and then send the binary to each of your servers.

Install dependencies

Speculare Client is a Rust project that rely on very few dependencies. But some of them are still required for https communication.

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install APT dependencies
sudo apt-get install libssl-dev pkg-config build-essential

Build the binary

You can build the binary using:

cargo build --release

The resulting binary will be located in ./target/release/speculare-client.

Configuration files

The client binary depends on a Config.toml file whose path will be passed as arguments to the binary.

You can create your Config.toml from the Config.example.toml given in the source code.

speculare-client "/path/to/Config.toml"

Install as a service

Here is a sample speculare-client.service for systemd:

[Unit]
Description=Speculare Client Process
After=network.target
StartLimitIntervalSec=600
StartLimitBurst=10

[Service]
Restart=on-failure
RestartSec=60s
Group=www-data
ExecStart=/root/speculare-client "/path/to/Config.toml"

[Install]
WantedBy=multi-user.target