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.
-
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
- 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)
overwatch: Services runner frameworkoverwatch-derive: Overwatch macros
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 testfor executing tests, andcargo test -- --nocapturefor seeing test outputs. - Use
cargo run --exampel {example_name}to run an example.
Simply run cargo doc --open --no-deps to build and access a copy of the generated documentation.