DetectMate Service Framework
Welcome to the DetectMate Service Framework documentation. DetectMate is a flexible, component-based framework for building distributed detection and processing services.
The Detectmate Framework consists of the Detectmate Service and the Detectmate Library. The DetectMate Service is a very generic Microservice that handles the input, forwards it to the DetectMate Library, which processes the data, and finally sends the results back to the output interfaces.
It uses NNG's messaging architecture to process data in real-time.
Key features
- Modular design: easily extensible with custom processors and components.
- Resilient networking: built on top of
pynng(NNG) for high-performance messaging. - Configurable: fully configurable via YAML files or environment variables.
- Service management: built-in CLI for starting, stopping, and monitoring the service.
- Scalable: run multiple independent service instances.
Getting started
Check out the Installation guide to set up the service, and then proceed to Configuration and Usage to learn how to run it.
For a list of imports from the DetectMateLinbrary in the Service and their usage Library Imports. For library developers implementing custom components, see the Library Interface Contract.
Please have a look to the Getting Started Tutorial to see how it works.
Docker
Docker Compose can be used to set up a full log data analysis pipeline. A complete configuration reference can be found in the Docker Compose reference.
Contribution
We're happily taking patches and other contributions. Please see the following links for how to get started:
License
DetectMateService is Free Open Source Software and uses the EUPL-1.2 License