docs: Add example for payload filtering using callback #1445
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.
What does this pull request do?
This PR adds an example using a callback for filtering to showcase how to use a filter to ignore some payloads completely. Currently, there is no example on how to do this in the docs.
Also I haven't been able to check on 4.x but on 3.x If you try to return
nil
in the block it spams the logs withFailed converting event to JSON:
logs.Why is it important?
This provides an example for users like me looking to filter out some payloads completely. Also uses an example that would be popular with Rails users since the redis spans are a nuisance.
Checklist
.rubocop.yml
)- [ ] I have added tests that prove my fix is effective or that my feature works- [ ] New and existing unit tests pass locally with my changes- [ ] I have updated CHANGELOG.asciidoc- [ ] I have updated supported-technologies.asciidoc- [ ] Added an API method or config option? Document in which version this will be introduced