Move to pyproject.toml. Add processors, documentation updates. #26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was possible prior to this commit, but required a stub method for process to be implemented.
By default both a processed and raw output stream are configured to simplify configuration. However, this means that if no processors are used logs will be written twice. This pull-request prevents that, and instead only write out data if processors are configured.
cugu
previously approved these changes
Jul 14, 2023
Co-authored-by: Jonas Plum <[email protected]>
cugu
approved these changes
Jul 14, 2023
hcpadkins
added a commit
to hcpadkins/grove
that referenced
this pull request
Jul 24, 2023
…corp-forge#26) * Add processors. Move to pyproject.toml. * Cache calls to quote_aware_split. * Update processor base class to allow finalize only This was possible prior to this commit, but required a stub method for process to be implemented. * Add local file secret backend. * Remove caching to prevent unexpected mutation. * Documentation updates. * Version bump for new release. * Update build process for pyproject.toml * Only write processed data if processors are configured. By default both a processed and raw output stream are configured to simplify configuration. However, this means that if no processors are used logs will be written twice. This pull-request prevents that, and instead only write out data if processors are configured. * Fix up logger error. * Update grove/outputs/__init__.py Co-authored-by: Jonas Plum <[email protected]> * Address pull-request comments. --------- Co-authored-by: Jonas Plum <[email protected]>
hcpadkins
added a commit
to hcpadkins/grove
that referenced
this pull request
Jul 24, 2023
…corp-forge#26) * Add processors. Move to pyproject.toml. * Cache calls to quote_aware_split. * Update processor base class to allow finalize only This was possible prior to this commit, but required a stub method for process to be implemented. * Add local file secret backend. * Remove caching to prevent unexpected mutation. * Documentation updates. * Version bump for new release. * Update build process for pyproject.toml * Only write processed data if processors are configured. By default both a processed and raw output stream are configured to simplify configuration. However, this means that if no processors are used logs will be written twice. This pull-request prevents that, and instead only write out data if processors are configured. * Fix up logger error. * Update grove/outputs/__init__.py Co-authored-by: Jonas Plum <[email protected]> * Address pull-request comments. --------- Co-authored-by: Jonas Plum <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.