From d76dfaeb561b3b6d7136a6d13e85164590b478eb Mon Sep 17 00:00:00 2001 From: Ammaar Solkar Date: Fri, 15 Mar 2024 19:59:11 +0530 Subject: [PATCH] [docs] Add example for payload filtering Added an example using a callback for filtering to showcase how to use a filter to ignore some payloads completely. docs --- docs/api.asciidoc | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/api.asciidoc b/docs/api.asciidoc index 77d311124..a6be8c1c1 100644 --- a/docs/api.asciidoc +++ b/docs/api.asciidoc @@ -409,8 +409,9 @@ Return the altered payload. If `nil` is returned all subsequent filters will be skipped and the post request cancelled. -Example: +Examples: +Altering payload [source,ruby] ---- ElasticAPM.add_filter(:filter_pings) do |payload| @@ -421,6 +422,17 @@ ElasticAPM.add_filter(:filter_pings) do |payload| end ---- +Filtering payload +[source,ruby] +---- +ElasticAPM.add_filter( + :remove_redis_spans, + Proc.new do |payload| + payload.dig(:span, :type) == 'db.redis' ? nil : payload + end +) +---- + [float] [[api-transaction]] === Transaction