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.
The resulting binary will be located in ./target/release/server.
Setup an env file
The server config depends on a Server.toml file located at the root of the working dir.
This does not mean you will have to keep the source code after compilation, this just mean the Server.toml must be present at in the workdir from where you will execute the binary.
You can create your Server.toml from the ExampleServer.toml given in the source code or using the following template:
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.
1
CREATE DATABASE database_name;
Copied!
This method is recommended if you want to work on the development of Speculare.