Monitoring AWS Kinesis

Note: Learn about the other supported AWS services with our AWS documentation.

Sensor (Data Collection)

Tracked Configuration

  • Kinesis Data Streams Instance Details

    • Stream name
    • Stream ARN
    • Stream status
    • Stream encryption type
    • Stream retention period (hours)
    • Stream creation time
    • AWS Grouping Zone

Required Permissions

  • cloudwatch:GetMetricData
  • kinesis:ListStreams
  • kinesis:DescribeStream
  • kinesis:ListTagsForStream

Configuration

Metrics for Kinesis are pulled every 5 minutes, this can be changed via agent configuration in <agent_install_dir>/etc/instana/configuration.yml:

com.instana.plugin.aws.kinesis:
  cloudwatch_period: 300

To disable monitoring of Kinesis streams use the following configuration:

com.instana.plugin.aws.kinesis:
  enabled: false

Monitoring multiple AWS accounts

Refer to the Monitoring multiple AWS accounts documentation to set up monitoring of multiple AWS accounts with one AWS agent in the same region.

To override which profiles should be used to monitor Kinesis, use the following configuration:

com.instana.plugin.aws.kinesis:
  profile_names:
    - 'profile2'
    - 'profile3'

Note: Defining profiles on service level will override global AWS configuration.

Filtering

Multiple tags can be defined, separated by a comma. Tags should be provided as a key-value pair separated by :. In order to make configuration easier, it is possible to define which tags you want to include in discovery or exclude from discovery. In case of defining tag in both lists (include and exclude), exclude list has higher priority. If there is no need for services filtering, the configuration should not be defined. It’s not mandatory to define all values in order to enable filtering.

Users are able to specify how often sensors will poll the AWS tagged resources using the tagged-services-poll-rate configuration property (default 300 seconds).

Note: Tags are only available in conjunction with the AWS Agent.

To define how often sensors will poll the tagged resources use following configuration:

com.instana.plugin.aws:
  tagged-services-poll-rate: 60 #default 300

To include services by tags into discovery use following configuration:

com.instana.plugin.aws.kinesis:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

To exclude services by tags from discovery use following configuration:

com.instana.plugin.aws.kinesis:
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

Instana Agent Tags

Please note that tags are only available in conjunction with the AWS Agent. More details on using tags are described here.