hashicorp-forge / grove

A Software as a Service (SaaS) log collection framework.
https://hashicorp-forge.github.io/grove/
Mozilla Public License 2.0
130 stars 11 forks source link

Move to pyproject.toml. Add processors, documentation updates. #26

Closed hcpadkins closed 1 year ago

hcpadkins commented 1 year ago

Overview

Please note: This makes a minor change to the structure of arguments passed to output plugins. If using a custom output plugin, this may constitute a breaking change. A subsequent version increment has not been performed as the stable v1.0.0 release has not yet been cut.

This pull-request moves Grove to use pyproject.toml, and adds processors into the public Grove release.

These optional and chainable processors allow processing of collected log entries before output. Out of the box this feature can be used to transform logs into a consistent schema, split, or filter events. Similar to other backends, plugins can be developed to introduce new processors.

These processors may be used for filtering, transformation, or even performing enrichment during collection.

In line with this, a new output configuration option has been introduced which allows controlling which "stream" of log data to output. This allows for both raw log entries and processed data to be output, or some combination thereof. This has been configured to adhere to the existing defaults, allowing backwards compatibility with existing configuration.

Finally, this pull-request also adds a local secret handler for completeness, and updates the documentation ready for the official v1.0.0 release.