ktail

package module

v0.4.0 Latest Latest Go to latest Published: Sep 12, 2023 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fujiwara/kinesis-tailf

Links

Open Source Insights

README ¶

kinesis-tailf

tail -f command for Amazon Kinesis Data Streams.

Install

Homebrew

$ brew install fujiwara/tap/kinesis-tailf

Binary packages

Releases.

Usage

Required flags are below.

-stream
-region or AWS_REGION environment variable

Usage of kinesis-tailf:
  -end string
    	end timestamp
  -lf
    	append LF(\n) to each record
  -region string
    	region (default AWS_REGION environment variable)
  -shard-key string
    	shard key
  -start string
    	start timestamp
  -stream string
    	stream name

kinesis-tailf supports decoding packed records by Kinesis Producer Library (KPL).

kinesis-cat

cat command for putting data to Amazon Kinesis Data Streams or Kinesis Data Firehose.

Usage of kinesis-cat:
  -firehose
    	put to Firehose delivery stream
  -lf
    	append LF(\n) to each record
  -partition-key string
    	partition key
  -region string
    	region (default "ap-northeast-1")
  -stream string
    	stream name

When -partition-key is not specified, partition key will be generated from sha256 digest of data.

Licence

MIT

Documentation ¶

Index ¶

Variables
type App
- func New(cfg aws.Config, name string) *App
type IterateParams

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	LF = []byte{'\n'}
)

Functions ¶

This section is empty.

Types ¶

type App ¶ added in v0.1.0

type App struct {
	StreamName string
	AppendLF   bool
	// contains filtered or unexported fields
}

func New ¶ added in v0.1.0

func New(cfg aws.Config, name string) *App

func (*App) Cat ¶ added in v0.3.0

func (app *App) Cat(ctx context.Context, partitionKey string, src io.Reader) error

func (*App) CatFirehose ¶ added in v0.3.1

func (app *App) CatFirehose(ctx context.Context, _ string, src io.Reader) error

func (*App) Run ¶ added in v0.1.0

func (app *App) Run(ctx context.Context, shardKey string, startTs, endTs time.Time) error

type IterateParams ¶

type IterateParams struct {
	StreamName     string
	ShardID        string
	StartTimestamp time.Time
	EndTimestamp   time.Time
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
kinesis-cat
kinesis-tailf
kpl Package kpl is a generated protocol buffer package.	Package kpl is a generated protocol buffer package.
lambda
functions/grep

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL