Kinesis input plugin

  • Plugin version: v2.1.1
  • Released on: 2019-02-16
  • Changelog

For other versions, see theVersioned plugin docs.

Installation

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-input-kinesis. See Working with plugins for more details.

Getting Help

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

You can use this plugin to receive events throughAWS Kinesis.This plugin uses the Java Kinesis ClientLibrary. The documentation athttps://github.com/awslabs/amazon-kinesis-client will be useful.

AWS credentials can be specified either through environment variables, or anIAM instance role. The library uses a DynamoDB table for worker coordination,so you’ll need to grant access to that as well as to the Kinesis stream. TheDynamoDB table has the same name as the application_name configurationoption, which defaults to "logstash".

The library can optionally also send worker statistics to CloudWatch.

Usage

input {  kinesis {    kinesis_stream_name => "my-logging-stream"    codec => json { }  }}

Using with CloudWatch Logs

If you want to read a CloudWatch Logs subscription stream, you’ll alsoneed to install and configure theCloudWatch LogsCodec.

Authentication

This plugin uses the default AWS SDK auth chain,DefaultAWSCredentialsProviderChain,to determine which credentials the client will use, unless profile is set, inwhich caseProfileCredentialsProvideris used.

The default chain reads the credentials in this order:

  • AWS_ACCESS_KEY_ID / AWS_SECRET_KEY environment variables
  • ~/.aws/credentials credentials file
  • EC2 instance profile

The credentials need access to the following services:

  • AWS Kinesis
  • AWS DynamoDB. The client library stores information for worker coordination in DynamoDB (offsets and active worker per partition)
  • AWS CloudWatch. If the metrics are enabled the credentials need CloudWatch update permissions granted.

See theAWS documentationfor more information on the default chain.

Kinesis Input Configuration Options

This plugin supports the following configuration options plus the Common Options described later.

Also see Common Options for a list of options supported by allinput plugins.

 

application_name

  • Value type is string
  • Default value is "logstash"

The application name used for the dynamodb coordination table. Must beunique for this kinesis stream.

checkpoint_interval_seconds

  • Value type is number
  • Default value is 60

How many seconds between worker checkpoints to dynamodb.

initial_position_in_stream

  • Value type is string
  • Default value is "TRIM_HORIZON"

The value for initialPositionInStream. Accepts "TRIM_HORIZON" or "LATEST".

kinesis_stream_name

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The kinesis stream name.

metrics

  • Value can be any of: ``, cloudwatch
  • Default value is nil

Worker metric tracking. By default this is disabled, set it to "cloudwatch"to enable the cloudwatch integration in the Kinesis Client Library.

profile

  • Value type is string
  • There is no default value for this setting.

The AWS profile name for authentication.This ensures that the ~/.aws/credentials AWS auth provider is used.By default this is empty and the default chain will be used.

region

  • Value type is string
  • Default value is "us-east-1"

The AWS region for Kinesis, DynamoDB, and CloudWatch (if enabled)

role_arn

  • Value type is string
  • There is no default value for this setting.

The AWS role to assume. This can be used, for example, to access a Kinesis stream in a different AWSaccount. This role will be assumed after the default credentials or profile credentials are created. By defaultthis is empty and a role will not be assumed.

role_session_name

  • Value type is string
  • Default value is logstash

Session name to use when assuming an IAM role. This is recorded in CloudTrail logs for example.

additional_settings

  • Value type is string
  • There is no default value for this setting

The KCL provides several configuration options which can be set inKinesisClientLibConfiguration.These options are configured via various function calls that all begin withwith. Some of these functions take complex types, which are not supported.However, you may invoke any one of the withX() functions that take a primitiveby providing key-value pairs in snake_case.

Example:

To set the dynamodb read and write capacity values, use these functions:withInitialLeaseTableReadCapacity and withInitialLeaseTableWriteCapacity.

additional_settings => {"initial_lease_table_read_capacity" => 25, "initial_lease_table_write_capacity" => 100}

Common Options

The following configuration options are supported by all input plugins:

Setting Input type Required

add_field

hash

No

codec

codec

No

enable_metric

boolean

No

id

string

No

tags

array

No

type

string

No

Details

 

add_field

  • Value type is hash
  • Default value is {}

Add a field to an event

codec

  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

enable_metric

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.

id

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type, for example, if you have 2 kinesis inputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {  kinesis {    id => "my_plugin_id"  }}

tags

  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

type

  • Value type is string
  • There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you canalso use the type to search for it in Kibana.

If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.