summaryrefslogtreecommitdiff
path: root/docs/processor/projection-processor.md
diff options
context:
space:
mode:
authordoufenghu <[email protected]>2024-02-05 11:46:20 +0800
committerdoufenghu <[email protected]>2024-02-05 11:46:20 +0800
commitd4fe431ca1104b44bc620c7cb69a08a2c52842e1 (patch)
treef324c6d46ec63792819e55825cf6156bd23b1554 /docs/processor/projection-processor.md
parentef5d5bb503a7db64be92cdf6078e5edb27ba9023 (diff)
Update docs
Diffstat (limited to 'docs/processor/projection-processor.md')
-rw-r--r--docs/processor/projection-processor.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/processor/projection-processor.md b/docs/processor/projection-processor.md
index 0d4f4c9..65c7545 100644
--- a/docs/processor/projection-processor.md
+++ b/docs/processor/projection-processor.md
@@ -1,17 +1,17 @@
# Projection Processor
> Processing pipelines for projection processor
## Description
-Projection processor is used to project the data from source to sink. It can be used to filter the fields, rename the fields, and add the fields.
-The projection processor is a part of the processing pipeline. It can be used in the pre-processing pipeline, processing pipeline, and post-processing pipeline.
-Each processor can assemble UDFs(User-defined functions) into a pipeline. More UDF detail can be found in [UDF](udf.md).
+Projection processor is used to project the data from source to sink. It can be used to filter, remove, and transform fields.
+It is a part of the processing pipeline. It can be used in the pre-processing, processing, and post-processing pipeline. Each processor can assemble UDFs(User-defined functions) into a pipeline.
+Within the pipeline, events are processed by each Function in order, top‑>down. The UDF usage detail can be found in [UDF](udf.md).
## Options
-| name | type | required | default value |
-|----------------|---------|----------|---------------------------------------------------------------------------------------------------------------|
+| name | type | required | default value |
+|----------------|---------|----------|----------------------------------------------------------------------------------------------------------------|
| type | String | Yes | The type of the processor, now only support `com.geedgenetworks.core.processor.projection.ProjectionProcessor` |
-| output_fields | Array | No | Array of String. The list of fields that need to be kept. Fields not in the list will be removed |
-| remove_fields | Array | No | Array of String. The list of fields that need to be removed. |
-| functions | Array | No | Array of Object. The list of functions that need to be applied to the data. |
+| output_fields | Array | No | Array of String. The list of fields that need to be kept. Fields not in the list will be removed. |
+| remove_fields | Array | No | Array of String. The list of fields that need to be removed. |
+| functions | Array | No | Array of Object. The list of functions that need to be applied to the data. |
## Usage Example
This example use projection processor to remove the fields `http_request_line`, `http_response_line`, `http_response_content_type` and using DROP function filter all event that `server_ip` is `4.4.4.4`.