Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.74 KB

metricstream.md

File metadata and controls

53 lines (36 loc) · 2.74 KB
Raw

Observe CloudWatch Metrics Stream

The Observe CloudWatch Metrics Stream application delivers CloudWatch Metrics to an Amazon S3 Bucket.

Template Configuration

Parameters

The application is configurable through several parameters that determine how data is buffered and delivered:

Parameter Type Description
BucketArn String S3 Bucket ARN to write log records to.
Prefix String Optional prefix to write metrics to.
FilterUri String A file hosted in S3 containing list of metrics to stream.
OutputFormat String The output format for CloudWatch Metrics.
NameOverride String Set Firehose Delivery Stream name. In the absence of a value, the stack name will be used.
BufferingInterval Number Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
BufferingSize Number Buffer incoming data to the specified size, in MiBs, before delivering it to the destination.

Outputs

Output Description
FirehoseArn Kinesis Firehose Delivery Stream ARN. CloudWatch Metric Streams subscribed to this Firehose will have their metrics batched and written to S3.
LogGroupName Firehose Log Group Name. This log group will contain debugging information if Firehose fails to deliver data to S3.

Resources Created

The CloudWatch Metrics Stream application provisions the following AWS resources:

  • IAM Role: Grants the Firehose service permission to access source and destination services.
  • CloudWatch Log Group: Captures logging information from the Firehose delivery stream.
  • CloudWatch Log Stream: A specific log stream for storing Firehose delivery logs.
  • Kinesis Firehose Delivery Stream: The core component that manages the delivery of data to the S3 bucket.
  • CloudWatch Metrics Stream: the component responsible for writing metrics to Kinesis Firehose.

Filtering metrics

This module requires a URI to a pubicly readable S3 object containing a YAML or JSON definition for what metrics to collect. Observe hosts some boilerplate filters you can use:

  • s3://observeinc/cloudwatchmetrics/filters/full.yaml collects all metrics.
  • s3://observeinc/cloudwatchmetrics/filters/recommended.yaml collects a set of KPIs for each metric namespace.

You can use curl to inspect the content of these files, e.g.:

curl https://observeinc.s3.us-west-2.amazonaws.com/cloudwatchmetrics/filters/recommended.yaml

You can host your own definition, so long as it conforms with the schema for AWS::CloudWatch::MetricStream.