brexhq / substation

Substation is a toolkit for routing, normalizing, and enriching security event and audit logs.
https://substation.readme.io
MIT License
322 stars 16 forks source link

docs: Add Example Dev App for Reading from a Kinesis Data Stream #198

Closed jshlbrd closed 2 months ago

jshlbrd commented 2 months ago

Description

Motivation and Context

This is useful for testing configurations against live data, but not an app that I think we should commit to maintaining (i.e. tracking with SemVer). It's also an easy way to preview data in a Kinesis Data Stream.

Run this command to preview data in the stream:

./examples/cmd/development/tap_kinesis/substation -stream-name my-stream

Run this command to use a custom configuration:

./examples/cmd/development/tap_kinesis/substation -stream-name my-stream -config path/to/my/config.json

Run this command to choose the stream's offset (defaults to earliest):

./examples/cmd/development/tap_kinesis/substation -stream-name my-stream -stream-offset latest

How Has This Been Tested?

This was tested against several production Kinesis Data Streams.

Types of changes

Checklist: