search

honeycombio / terraform-honeycombio-opentelemetry-starter-pack

A terraform starter pack for creating honeycomb nouns for standard opentelemetry data
Other
5 stars 2 forks source link

readme

TERRAFORM HONEYCOMBIO OPENTELEMETRY-STARTER-PACK

OSS Lifecycle CI

This module creates resources like Derived Columns, Saved Queries, and Boards in Honeycomb to kick off exploration of OpenTelemetry data in your environment

Use

The minimal config necessary for this module to run requires nothing other than the source for calling the module. All other options are optional, so the minimum config for this module is the below code, and setting the HONEYCOMB_API_KEY environment variable:

module "explore-honeycombio-opentelemetry-starter-pack" {
  source = "honeycombio/opentelemetry-starter-pack/honeycombio"
}

Set the API key used by Terraform setting the HONEYCOMB_API_KEY environment variable.

export HONEYCOMB_API_KEY=$HONEYCOMB_API_KEY

Now you can run terraform init/plan/apply in sequence.

For more config options, see USAGE.md .

Examples

Examples of use of this module can be found in examples/ . We've provided an example using some of the possible options that the module has with non-default values.

Development

Tests

Test cases that run against local code are in tests/ . To set up:

  1. Set the API key used by Terraform setting the HONEYCOMB_API_KEY environment variable.
  2. terraform plan and terraform apply will now work as expected, as will terraform destroy.
  3. Test cases also run as part of the pipeline. See test-terraform-module.yml

Docs

Docs are autogenerated via ./docs.sh, and put in USAGE.md . Please regenerate and commit before merging.

Lints

We use tflint and terraform fmt, and enforce this with a github action.

Contributions

Features, bug fixes and other changes to this module are gladly accepted. Please open issues or a pull request with your change.

All contributions will be released under the Apache License 2.0.