stenographer
This module is for defining logging and tracking events which can be used to
capture activity on the system and send them to logging storage destinations.
The module is extendable and different triggers, data adapter and storage types
can all be added by providing the relevant plugins or strategy implementations.
See the README.md section about extending the module.
The module is named after the courtroom recorder who documents the court
proceedings and testimonies using a unique shortened writing style called
"steno" on a steno machine.
Features
Allows developers to define event triggers, data to record and target storage for system logging events. Module comes with a set of triggers (what causes an event to be evaluated and recorded), storage plugins (destinations to store the log data) and entity data adapters.
Configuration
The module uses `.stenographer.yml` files to define recorder instances. Recorders define triggers, the data to capture and where to send the event data.
This module includes an example stenographer definition file at
example.stenographer.yml. This file demonstrates some common `recorder` definitions that can be used to collect security activity and audit information
often used to detect suspicious user activity or provide breach notifications.
The included example file also provides comments that attempts to explain the variations parts of the definitions and some of the options.
Capture strategies, triggers, data adapters and storage plugins can all be added
to further add capabilities and options to the stenographer recorder. See the
section on extending the module.
Additional Requirements
This module requires the following modules: