Self-contained services application framework
Go to file
Alejandro Cabeza Romero 3c32bc5167
Revert to previous namespacing to avoid test issues on CI.
2024-12-19 16:58:14 +01:00
.github/workflows Auto author GH action (#19) 2023-01-24 11:12:52 +02:00
ci ci: Add Jenkins configuration and related files 2022-12-13 16:25:41 +02:00
overwatch-derive Revert to previous namespacing to avoid test issues on CI. 2024-12-19 16:58:14 +01:00
overwatch-rs Formatting. 2024-12-19 16:38:33 +01:00
.gitignore Update Cargo with example removal. Formatting. 2024-12-19 16:32:07 +01:00
Cargo.toml Feature gate instrument macro. 2024-12-19 16:38:33 +01:00
LICENSE Public release 2022-10-20 11:47:50 +02:00
README.md ci: codecov and badges 2022-12-16 15:26:25 +02:00
shell.nix ci: Add Jenkins configuration and related files 2022-12-13 16:25:41 +02:00

README.md

Overwatch

MIT licensed Build Status Codecov Status

Overwatch is a framework to easily construct applications that requires of several independent parts that needs communication between them. Everything is self-contained, and it matches somewhat the advantages of microservices.

Design Goals

  • Modularity:

    • Components should be self-contained (as possible)
    • Communication relations between components should be specifically defined
    • Components should be mockable. This is rather important for measurements and testing.
  • Single responsibility:

    • It is easier to isolate problems
    • Minimal sharing when unavoidable
  • Debuggeability

    • Easy to track workflow
    • Easy to test
    • Easy to measure
    • Asynchronous Communication

Main components

  • Overwatch: the main messenger relay component (internal communications). It is also be responsible of managing other components lifecycle and handling configuration updates.
  • Services (handled by the overwatch)

Project Structure

  • overwatch: Services runner framework
  • overwatch-derive: Overwatch macros

Build & Test

Minimal Rust supported version: 1.63

When in development, please, use cargo clippy to build the project. Any warning is promoted to an error in our CI.

  • Use cargo test for executing tests, and cargo test -- --nocapture for seeing test outputs.
  • Use cargo run --exampel {example_name} to run an example.

Build Documentation

Simply run cargo doc --open --no-deps to build and access a copy of the generated documentation.