lightstep / terraform-provider-lightstep Goto Github PK

Terraform Lightstep provider

License: Apache License 2.0

Go 99.09% HCL 0.17% Makefile 0.62% Shell 0.12%

terraform-provider-lightstep's Introduction

Lightstep Terraform Provider

In August 2023, Lightstep became ServiceNow Cloud Observability. To ease the transition, all code artifacts will continue to use the Lightstep name. You don't need to do anything to keep using this provider.

Hashicorp Terraform Registry

Requirements

Terraform v1.x+

Using the provider

Install Terraform
Write some code to initialize the provider with your Lightstep organization and API Key with member permissions:

terraform {
  required_providers {
    lightstep = {
      source = "lightstep/lightstep"
      version = "1.77.2"
    }
  }
}

provider "lightstep" {
  api_key         = "your-lightstep-org-api-key"
  organization    = "your-lightstep-organization"
}

# Example: Create AWS EC2 Dashboard
module "aws-dashboards" {
  source            = "lightstep/aws-dashboards/lightstep//modules/ec2-dashboard"
  lightstep_project = "your-lightstep-project"
}

Run terraform init
Add some code to define dashboards, streams, alerts, and more. See documentation for examples or use pre-built Lightstep Terraform modules.
After setting an environment variable with your API Key that matches the name in the provider configuration above, run terraform plan to preview changes.

⚠️ If you're creating many Lightstep resources at once, we recommend running the apply with the parallelism flag set to a low value to avoid API 500 errors:

   # Avoids 500 errors when creating many resources.
   terraform apply -parallelism=1

Development

See DEVELOPMENT.md.

Exporter

It's possible to export an existing Lightstep dashboard to HCL code using the provider. This allows you to generate terrform code for a dashboard you created in the Lightstep UI ("reverse terraform").

The exporter utility is built-in to the provider binary and requires certain environment variables to be set:

$ export LIGHTSTEP_API_KEY=....
$ export LIGHTSTEP_ORG=your-org
$ export LIGHTSTEP_API_BASE_URL='https://api.lightstep.com'

# exports to console dashboard id = rZbPJ33q from project terraform-shop
$ go run github.com/lightstep/terraform-provider-lightstep exporter lightstep_dashboard terraform-shop rZbPJ33q

terraform-provider-lightstep's People

Contributors

Stargazers

Watchers

Forkers

adcharre

terraform-provider-lightstep's Issues

bad version in README

when trying to initialize the module with terraform init, I got error:
│ Error: Failed to install provider
│
│ Error while installing lightstep/lightstep v1.61.1: checksum list has unexpected SHA-256 hash 75e765cc04c11a77a46af8d9df1672814c7676e9d69ff04d96de2b3fa5701ca0 (expected
│ 70279d592510f4800049d6e5223100822ca21826eb7e744460ed6129e47bed11)

In order to workaround the issue I had to change the version in my main.tf:

from version = "1.61.1" (generating error above) to version = "~> 1.61.0", working and installing version 1.61.2

Provider failed after apply

what is the expression for latency and operation rate in lightstep_stream_condition ?

while creating the alert stream we have few signals latency, error percentage and operation rate. For error percentage we do have expression available i.e err for lightstep_stream_condition. What is the expression for latency and operation rate in lightstep_stream_condition tf resource.

Query streams

Any plans to support charts of type stream?

Invalid resource type "lightstep_dashboard"

I exported a dashboard from one project in order to import it back in another one, but when importing my dashboard, I got error:
│ Error: Invalid resource type
│
│ on dashboard-mainframe-red-metrics.tf line 2, in resource "lightstep_dashboard" "mainframe_red":
│ 2: resource "lightstep_dashboard" "mainframe_red" {
│
│ The provider lightstep/lightstep does not support resource type "lightstep_dashboard".

Instructions to set project missing

Instructions to set the project are missing from the readme.
So, if you use a file you exported before and try to import it back, it won't work