Speculare
Search…
⌃K
Links

Getting started

Speculare Server is the core of the infrastructure. It is where all clients will send their metrics and where the dashboard will ask for historical data.
Note that the repository linked above host both Speculare Server and Speculare Alerts, the latter is cover in another section. We'll only cover Speculare Server on this page.

Setup

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

Install dependencies

Speculare Server is a Rust project that rely on some dependencies to be able to be built correctly. Much of them are default deps in most servers.
# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Install APT dependencies
sudo apt-get install libssl-dev libpq-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/server.

Configuration files

The server binary depends on a Server.toml file whose path will be passed as arguments to the binary.
You can create your Server.toml from the Server.example.toml given in the source code or using the following template:
BINDING = "0.0.0.0:8080"
DATABASE_URL = "postgres://postgres:[email protected]/speculare?sslmode=disable"
DATABASE_MAX_CONNECTION = 10 # (optional [default = 10])
KEY_PRIV = "key.pem" # (optional, depends on HTTPS)
KEY_CERT = "cert.pem" # (optional, depends on HTTPS)
HTTPS = true # (optional [default = false])
# Will be used in Speculare-client
# > need to be generated by you.
API_TOKEN = "secret_password"
RUST_LOG = "info,server=info,actix_server=info,actix_web=info" # (optional)
speculare-server "path/to/Server.toml"

Apply setup migration to construct database

For this step you will have to methods:
Doing nothing...
Using Diesel_cli
This is the easiest solution... Just do nothing and the migrations will be applied automatically. Once you launch the binary, it will check if all the lastest migrations has been applied, and will applied them if not.
You might, however need to create the DATABASE inside TimescaleDB.
CREATE DATABASE database_name;
This method is recommended if you want to work on the development of Speculare.
# Install the diesel_cli tool
cargo install diesel_cli --no-default-features --features postgres
# For diesel setup to works you need to be at the root of the project
diesel setup --database-url="postgres://xxx"
# If you've installed the diesel_cli you can also use it's migration commands
diesel migration run/add/revert/redo --database-url="postgres://xxx"

Install as a service

Here is a sample speculare-server.service for systemd:
[Unit]
Description=Speculare Server Process
After=network.target postgresql.service
StartLimitIntervalSec=600
StartLimitBurst=10
[Service]
Restart=on-failure
RestartSec=60s
Group=www-data
WorkingDirectory=/root/speculare-server
ExecStart=/root/speculare-server/target/release/speculare-server "path/to/Server.toml"
[Install]
WantedBy=multi-user.target
The above service will start after postgres, this is important. The server cannot start before postgresql.