Honeycomb CloudFormation Integrations

This repository contains a collection of CloudFormation templates for resources in AWS to send observability data to Honeycomb.

Note: Terraform modules are also available that support AWS to Honeycomb Integrations.

How does this work?

Usage

A quick start template offers a streamlined path to integrating your AWS environments with Honeycomb. The quick start template uses all of the per-integration templates below to offer the configuration of many integrations in a single CloudFormation stack.

The quick start template may be suitable for many production purposes, but we encourage you to use per-integration templates in a way that suits your AWS environment.

Supported Integrations

Caveats & Troubleshooting

If the stack creation fails during its initial set up, we recommend a complete deletion and re-creation to ensure the proper creation of all dependencies.

Quick Start

This 'Quick Start' template allows the configuration of multiple integrations from a single CloudFormation Template.

Required Inputs

Enter a value for the required input in the UI, or if using the CLI or API, ensure the inclusion of the required input and its value.

HoneycombAPIKey: Your Honeycomb Team's API Key.

Note: All other Parameters are optional, but if no additional parameters are provided, only a S3 Bucket will be created.

Cloudwatch Logs

This template supports integrating with up to six Cloudwatch Log Groups and shipping them to a Honeycomb dataset.

Required Inputs

Enter a value for each required input in the UI, or if using the CLI or API, ensure the inclusion of each required input and its value.

HoneycombAPIKey: Your Honeycomb Team's API Key.
HoneycombDataset: The target Honeycomb dataset for the Stream to publish to.
LogGroupName: A CloudWatch Log Group name. Additional Log Groups can be added with the LogGroupNameX parameters.
S3FailureBucketArn: The ARN of the S3 Bucket that will store any logs that failed to be sent to Honeycomb.

Cloudwatch Metrics

This template supports integrating with all metrics flowing to Cloudwatch Metrics and shipping them to a Honeycomb.

Required Inputs

Enter a value for each required input in the UI, or if using the CLI or API, ensure the inclusion of each required input and its value.

HoneycombAPIKey: Your Honeycomb Team's API Key.
S3FailureBucketArn: The ARN of the S3 Bucket that will store any logs that failed to be sent to Honeycomb.

Kinesis Firehose Stream to Honeycomb

This template creates a Kinesis Firehose Stream that streams data received to Honeycomb.

Required Inputs

Enter a value for each required input in the UI, or if using the CLI or API, ensure the inclusion of each required input and its value.

Name: A Name for this Kinesis Firehose. Must be unique in this Region.
HoneycombAPIKey: Your Honeycomb Team's API Key.
HoneycombDataset: The target Honeycomb dataset for the Stream to publish to.
S3FailureBucketArn: The ARN of the S3 Bucket that will store any logs that failed to be sent to Honeycomb.

RDS Cloudwatch Logs

This template streams RDS logs from Cloudwatch to a Kinesis Firehose that includes a data transform to structure the logs before sending them to Honeycomb.

Required Inputs

Enter a value for each required input in the UI, or if using the CLI or API, ensure the inclusion of each required input and its value.

HoneycombAPIKey: Your Honeycomb Team's API Key.
HoneycombDataset: The target Honeycomb dataset for the Stream to publish to.
DBEngineType: The Engine type of your RDS database. One of aurora-mysql, aurora-postgresql mariadb, sqlserver,mysql, oracle, or postgresql.
LogGroupName: A CloudWatch Log Group name for RDS logs. Additional Log Groups can be added with the LogGroupNameX parameters.
S3FailureBucketArn: The ARN of the S3 Bucket that will store any logs that failed to be sent to Honeycomb.

Logs from a S3 bucket

This template supports sending logs flowing to a S3 bucket to Honeycomb.

Required Inputs

Enter a value for each required input in the UI, or if using the CLI or API, ensure the inclusion of each required input and its value.

HoneycombAPIKey: Your Honeycomb Team's API Key.
HoneycombDataset: The target Honeycomb dataset for to publish to.
ParserType: The type of log file to parse. Choose one of alb, elb, cloudfront, keyval, json, s3-access, or vpc-flow.
S3BucketArn: The ARN of the S3 Bucket storing the logs.