Follow up with cached proc adjustments

wmarmot · Jun 12, 2022 · 9b3df70 · 9b3df70
1 parent 3672be9
commit 9b3df70
Show file tree

Hide file tree

Showing 10 changed files with 575 additions and 248 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ All notable changes to this project will be documented in this file.
 - The `elasticsearch` output field `type` now supports interpolation functions.
 - The `redis` processor has been reworked to be more generally useful, the old `operator` and `key` fields are now deprecated in favour of new `command` and `args_mapping` fields.
 - Go API: Added component bundle `./public/components/aws` for all AWS components, including a `RunLambda` function.
+- New `cached` processor.
 
 ### Fixed
 

diff --git a/go.mod b/go.mod
@@ -125,11 +125,9 @@ require (
  go.uber.org/atomic v1.9.0 // indirect
  go.uber.org/multierr v1.8.0
  golang.org/x/crypto v0.0.0-20220213190939-1e6e3497d506
- golang.org/x/exp v0.0.0-20200331195152-e8c3332aa8e5 // indirect
  golang.org/x/net v0.0.0-20220325170049-de3da57026de
  golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a
  golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
- golang.org/x/sys v0.0.0-20220209214540-3681064d5158 // indirect
  golang.org/x/text v0.3.7
  golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 // indirect
  google.golang.org/api v0.74.0

diff --git a/internal/impl/generic/cached.go b/internal/impl/generic/cached.go
diff --git a/internal/impl/pure/processor_cache.go b/internal/impl/pure/processor_cache.go
@@ -31,6 +31,8 @@ func init() {
  Summary: `
 Performs operations against a [cache resource](/docs/components/caches/about) for each message, allowing you to store or retrieve data within message payloads.`,
  Description: `
+For use cases where you wish to cache the result of processors consider using the ` + "[`cached` processor](/docs/components/processors/cached)" + ` instead.
+
 This processor will interpolate functions within the ` + "`key` and `value`" + ` fields individually for each message. This allows you to specify dynamic keys and values based on the contents of the message payloads and metadata. You can find a list of functions [here](/docs/configuration/interpolation#bloblang-queries).`,
  Config: docs.FieldComponent().WithChildren(
  docs.FieldString("resource", "The [`cache` resource](/docs/components/caches/about) to target with this processor."),