alarm-server

This server is intended to read measurements from a RabbitMQ server and send alarms back to the same server. The alarm server also uses a QuestDB to keep the history of alarms and get the status of the last alarms

Server

The server is based on Tokio framework. This server is still under development and so far only support a very simple alarm type where it will set the alarm if the meas is equal to the set value. The reset works the same way.

Building

Here are a few instruction on how to build both server and client. For now their build is done separately but in the future I'll look for a simpler way to do it.

Pre requirements

For following the next steps is required to have working installation of rust toolchain. For installing a configuring rust you can follow the instruction on the official installation page

Server

To build the server we can simple got to the server folder and build it using cargo

cargo build

This will build a debugable version (without optimizations) in <repo_root>/target/debug. If you wan't to build a release version use the following command

cargo build --release

the output dir will be in this case <repo_root>/target/release

Running

Besides that it's also needed to have running a RabbitMQ server in order to get the everything working.

So far the expected address of the RabbitMQ is set only on the code itself and the default is localhost:5672.

The alarm configurations is expected to be like this and to be at ./alarm-server/examples/config.yaml. A more detailed documentation on how the alarm should be configured on this file will be made in the future.

The alarm-serve port is also only changeable on the code and the default is 8080.

All this configuration will, in the near future, be configurable using a file. However, for now they need to be changed on the main.rs.

To run the server we can run the build binary or we can let cargo build and run it for us using this:

cargo run

What's next?

More features are planned. To see the backlog or to add suggestion of features take a look here

So far the next steps are:

• Make unit test
• Create config file for the server
• Make alarms more flexible, with more types
• Add authentication and permissions
• Replace the server-client string based protocol by something smaller. Possible candidate is Prost

Warning

This is still a work in progress and is yet not production ready

Alarm flow

This is the flow for evaluating an alarm

flowchart TD
    A[New event] --> B{Ack?}
    B --> |yes| C[(latest with ack)]
    B --> |no| D{Is set?}
    D --> |yes| E[(Insert set)]
    D --> |no| F[(get latest state)]
    F --> G{Latest is set?}
    G --> |yes| H[(Insert reset
    Keep ack)]
    G --> |no| I[Ignore]