Browse Source

ingest: documentation for the drop processor (#34570)

Jake Landis 7 years ago
parent
commit
c447fc258a
1 changed files with 15 additions and 0 deletions
  1. 15 0
      docs/reference/ingest/ingest-node.asciidoc

+ 15 - 0
docs/reference/ingest/ingest-node.asciidoc

@@ -1260,6 +1260,21 @@ Reference key modifier example
 * error = REFUSED
 |====== 
 
+[[drop-processor]]
+=== Drop Processor
+Drops the document without raising any errors. This is useful to prevent the document from
+getting indexed based on some condition.
+
+[source,js]
+--------------------------------------------------
+{
+  "drop": {
+    "if" : "ctx.network_name == 'Guest'"
+  }
+}
+--------------------------------------------------
+// NOTCONSOLE
+
 [[dot-expand-processor]]
 === Dot Expander Processor