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

chore(cmd): Add Kinesis Tap Development Application #199

Closed jshlbrd closed 2 months ago

jshlbrd commented 2 months ago

Description

Motivation and Context

This is useful for testing configurations against live data and has some other uses, too (like previewing data in a Kinesis Data Stream). Note that apps in cmd/development/ do not follow SemVer, so this PR is a chore (prevents release-please from incrementing the version number).

See the app's README for more information.

Run this command to preview data in the stream:

./cmd/development/kinesis-tap/substation -stream-name my-stream

Run this command to use a custom configuration:

./cmd/development/kinesis-tap/substation -stream-name my-stream -config path/to/my/config.json

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

./cmd/development/kinesis-tap/substation -stream-name my-stream -stream-offset latest

How Has This Been Tested?

This was tested against several live Kinesis Data Streams.

Types of changes

Checklist: