DetectMate Library

Welcome to the documentation for the DetectMate Library . DetectMate is a flexible, component-based library for parsing and log anomaly detection. It can be used flexibly in research applications, and when used with the DetectMate Service, it can be easily deployed in microservice architectures.

Getting started

List of steps to follow for new users of the library:

• Installation: steps to install all the components need it.
• Basic usage: create a basic script with the different components.
• Create new component: guide to use the mate commands.
• Implement new component: guide to implement your own component.

Components

Documentation of the different components:

• Overall architecture: overall architecture of the library.
• Schemas: documentation of the different schemas in the library.
• Parsers: documentation of the different parsers.
• Detectors: documentation of the different detectors.

Utils

Tools that are used in the different components:

• Data Buffer: it takes the stream data and formated to the specifications given.
• Persistency: provides event-based state management for detectors.

Helper

Tools that their main objective is to help the developer:

• From_to: set of methods to save and load inputs and outputs from files.