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.
1
# Install Rust
2
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
3
4
# Install APT dependencies
5
sudo apt-get install libssl-dev pkg-config build-essential
Copied!

Build the binary

You can build the binary using:
1
cargo build --release
Copied!
The resulting binary will be located in ./target/release/speculare-client.

Configuration files

For Speculare Client to work correctly you need to create a configuration file based on Example.toml. This configuration file can be saved anywhere on the server, you just need to specify it's path as an arguments to speculare-client when launching it.
1
speculare-client "/path/to/Config.toml"
Copied!

Install as a service

Here is a sample speculare-client.service for systemd:
1
[Unit]
2
Description=Speculare Client Process
3
After=network.target
4
StartLimitIntervalSec=600
5
StartLimitBurst=10
6
7
[Service]
8
Restart=on-failure
9
RestartSec=60s
10
Group=www-data
11
ExecStart=/root/speculare-client "/path/to/Config.toml"
12
13
[Install]
14
WantedBy=multi-user.target
Copied!
Last modified 2mo ago
Copy link
Contents
Setup