Amazon OpenSearch Ingestion

aws Stream processoraws-opensearch-ingestion

Serverless Data Prepper pipeline that filters and streams data into OpenSearch.

Provider: aws
Kind: Stream processor
Category: Messaging
Official docs: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html

Properties · 4 set by this component

property	type	values	required	kind default	this component
checkpointIntervalSeconds	integer	—	no	—	inherited
deadLetterQueue · component property	boolean	—	no	false	inherited
exactlyOnce	boolean	—	no	false	▸ false
instances	integer	—	no	—	inherited
lateDataPolicy	enum	drop \| shift \| sideline	no	—	inherited
logPublishing · component property	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
persistentBuffering · component property	boolean	—	no	false	inherited
stateBackend	enum	memory \| rocksdb \| external	no	memory	▸ memory
watermarkSeconds	integer	—	no	—	inherited
windowing	enum	none \| event-time \| processing-time	no	none	▸ none

Rules that apply · 1

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Event-time windows without watermarkwarning

windowed-aggregation-without-watermark

Event-time windows need a watermark to know when a window is complete. Without one the processor either waits forever or closes windows early and silently drops late events.

— all of these hold:
— the node's `windowing` is "event-time"
— the node's `watermarkSeconds` has no value

Use it in a design

nodes:
  - { id: "opensearch-ingestion", component: "aws-opensearch-ingestion" }

Other Stream processor products · 33

Realtime Compute for Apache Flinkalibaba-flinkalibabacloudstream-processor Amazon EventBridge Pipesaws-eventbridge-pipesawsstream-processor Amazon Data Firehoseaws-firehoseawsstream-processor Amazon Managed Service for Apache Flinkaws-managed-flinkawsstream-processor Azure Stream Analyticsazure-stream-analyticsazurestream-processor Cloudflare Logpushcloudflare-logpushcloudflarestream-processor Cloudflare Pipelinescloudflare-pipelinescloudflarestream-processor Arroyoarroyostream-processor Apache Beambeamstream-processor Bytewaxbytewaxstream-processor Drasidrasistream-processor Apache Flinkflinkstream-processor Kafka Streamskafka-streamsstream-processor ksqlDBksqldbstream-processor Logstashlogstashstream-processor Materializematerializestream-processor Apache NiFinifistream-processor Norikranorikrastream-processor Redpanda Connectredpanda-connectstream-processor RisingWaverisingwavestream-processor Apache Samzasamzastream-processor Snowplowsnowplowstream-processor Spark Structured Streamingspark-streamingstream-processor Apache Stormstormstream-processor Generic stream processorstream-processorstream-processor Tremortremorstream-processor Google Cloud Dataflowgoogle-dataflowgcpstream-processor Manufacturing Data Enginegoogle-manufacturing-data-enginegcpstream-processor Activity Tracker Event Routingibm-activity-tracker-event-routingibmstream-processor IBM Cloud Logs Routingibm-logs-routingibmstream-processor IBM Cloud Metrics Routingibm-metrics-routingibmstream-processor OCI Connector Huboci-connector-hubocistream-processor OCI GoldenGate Stream Analyticsoci-goldengate-stream-analyticsocistream-processor

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Amazon OpenSearch Ingestion pipeline: "a fully managed, serverless data collector" running Data Prepper that
3# streams logs, metrics and traces into an OpenSearch Service sink and "automatically scales your pipelines based
4# on capacity limits that you define" ("Overview of Amazon OpenSearch Ingestion"). A pipeline buffers in memory
5# unless persistent buffering is enabled, and the dead-letter queue and CloudWatch log publishing are configured
6# explicitly ("Creating Amazon OpenSearch Ingestion pipelines").
7schemaVersion: "1"
8type: "component"
9id: "aws-opensearch-ingestion"
10kind: "stream-processor"
11provider: "aws"
12docs: "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html"
13defaults:
14  managed: true
15  windowing: "none"
16  stateBackend: "memory"
17  exactlyOnce: false
18properties:
19  persistentBuffering:
20    type: "boolean"
21    default: false
22  deadLetterQueue:
23    type: "boolean"
24    default: false
25  logPublishing:
26    type: "boolean"
27    default: false

The same page as markdown, for an agent: /catalogue/components/aws-opensearch-ingestion.md