Git Product home page Git Product logo

logzio_terraform_provider's Introduction

Logz.io Terraform provider

The Terraform Logz.io provider offers a great way to build integrations using Logz.io APIs.

Terraform is an infrastructure orchestrator written in Hashicorp Language (HCL). It is a popular Infrastructure-as-Code (IaC) tool that does away with manual configuration processes. You can take advantage of the Terraform Logz.io provider to really streamline the process of integrating observability into your dev workflows.

This guide assumes working knowledge of HashiCorp Terraform. If you're new to Terraform, we've got a great introduction if you're in for one. We also recommend the official Terraform guides and tutorials.

Capabilities

You can use the Terraform Logz.io Provider to manage users and log accounts in Logz.io, create and update log-based alerts and notification channels, and more.

The following Logz.io API endpoints are supported by this provider:

Working with Terraform

Before you begin, you'll need:

Get the Terraform Logz.io Provider

To install this provider, copy and paste this code into your Terraform configuration:

terraform {
  required_providers {
    logzio = {
      source = "logzio/logzio"
    }
  }
}

This will install the latest Logz.io provider. If you wish to use a specific version of the provider, add under source the field version and specify your preferred version.

Configuring the provider

The provider accepts the following arguments:

  • api_token - (Required) The API token is used for authentication. Learn more.

  • region - (Defaults to null) The 2-letter region code identifies where your Logz.io account is hosted. Defaults to null for accounts hosted in the US East - Northern Virginia region. Learn more

Example

You can pass the variables in a bash command for the arguments:

provider "logzio" {
  api_token = var.api_token
  region= var.your_api_region
}

Example - Create a new alert and a new Slack notification endpoint

Here's a great example demonstrating how easy it is to get up and running quickly with the Terraform Logz.io Provider.

This example adds a new Slack notification channel and creates a new alert in Kibana that will send notifications to the newly-created Slack channel.

The alert in this example will trigger whenever Logz.io records 10 loglevel:ERROR messages in 10 minutes.

terraform {
  required_providers {
    logzio = {
      source = "logzio/logzio"
    }
  }
}

provider "logzio" {
  api_token = "8387abb8-4831-53af-91de-5cd3784d9774"
  region= "au"
}

resource "logzio_endpoint" "my_endpoint" {
  title = "my_endpoint"
  description = "my slack endpoint"
  endpoint_type = "slack"
  slack {
    url = "${var.slack_url}"
  }
}

resource "logzio_alert_v2" "my_alert" {
  title = "hello_there"
  search_timeframe_minutes = 5
  is_enabled = false
  tags = ["some", "words"]
  suppress_notifications_minutes = 5
  alert_notification_endpoints = ["${logzio_endpoint.my_endpoint.id}"]
  output_type = "JSON"
  sub_components {
    query_string = "loglevel:ERROR"
    should_query_on_all_accounts = true
    operation = "GREATER_THAN"
    value_aggregation_type = "COUNT"
    severity_threshold_tiers {
      severity = "HIGH"
      threshold = 10
    }
    severity_threshold_tiers {
      severity = "INFO"
      threshold = 5
    }
  }
}

Example - Create user

This example will create a user in your Logz.io account.

terraform {
  required_providers {
    logzio = {
      source = "logzio/logzio"
    }
  }
}

variable "api_token" {
  type = "string"
  description = "Your logzio API token"
}

variable "account_id" {
  description = "The account ID where the new user will be created"
}

provider "logzio" {
  api_token = var.api_token
  region = var.region
}

resource "logzio_user" "my_user" {
  username = "[email protected]"
  fullname = "John Doe"
  roles = [ 2 ]
  account_id = var.account_id
}

Run the above plan using the following bash script:

export TF_LOG=DEBUG
terraform init
TF_VAR_api_token=${LOGZIO_API_TOKEN} TF_VAR_region=${LOGZIO_REGION} terraform plan -out terraform.plan
terraform apply terraform.plan

Before you run the script, update the arguments to match your details. See our examples for some complete working examples.

Contribute

Found a bug or want to suggest a feature? Open an issue about it. Want to do it yourself? We are more than happy to accept external contributions from the community. Simply fork the repo, add your changes and open a PR.

Import sub-accounts as resources

You can import multiple sub-accounts as follows:

terraform import logzio_subaccount.logzio_sa_<ACCOUNT-NAME> <ACCOUNT-ID>

Changelog

  • v1.9.1
    • Bug fix: plugin won't crash when import for archive_logs fails.
  • v1.9.0
Expand to check old versions - **v1.8.3** - Update client version(v1.10.3). - Bug fixes: - **alerts_v2**: - Fix noisy diff for tags. - Field `is_enabled` defaults to `true`. - **sub_accounts**: allow creating flexible account without `max_daily_gb`. - **v1.8.2** - Update client version(v1.10.2). - Bug fixes: - **alerts_v2**: fix bug for columns requiring sort field. - **sub_accounts**: add backoff for creating and updating sub accounts. - **v1.8.1** - Upgrade provider's Go version from 1.15 to 1.16 in code and in release workflow. - Improve tests - add sleep after each test. - **v1.8.0** - **Breaking change**: **custom endpoint** - refactor Headers - now a string of comma-seperated key-value pairs. - Update client version (v1.10.1) - bug fix for empty Header field. - Add to custom endpoint datasource Description field. - **v1.7.0** - Update client version (v1.10). - Support [authentication groups resource](https://docs.logz.io/api/#tag/Authentication-groups). - `alerts_v2`: fix noisy diff for `severity_threshold_tiers`.
  • v1.6.1
    • Update client version (v1.9.1) - bug fix for not found messages.
  • v1.6
  • v1.5
    • Update client version(v1.8).
    • sub_account:
      • Breaking changes:
        • Deprecated attribute utilization_settings. Use frequency_minutes and utilization_enabled instead.
      • Added attributes flexible and reserved_daily_gb.
      • Refactor tests.
      • Refactor code to use Terraform's retry.
    • endpoint:
      • Breaking changes:
        • Types naming.
      • New endpoints for OpsGenie, ServiceNow and Microsoft Teams.
      • Fix bug for body_template for custom type (#70).
      • Refactor tests.
      • Refactor code to use Terraform's retry.
    • alerts_v2:
      • Fix bug for filter_must,filter_must_not (#82)
      • Refactor tests.
      • Refactor code to use Terraform's retry.
    • drop_filter:
      • Improve tests.
  • v1.4
    • Update client version(v1.7).
    • Support Drop Filter resource.
  • v1.3
    • Update client version(v1.6).
    • Support Log Shipping Token resource.
  • v1.2.4
    • Update client version(v1.5.3).
    • Fix sub account to return attributes account_token & account_id.
  • v1.2.3
    • Fix bug for custom endpoint empty headers.
    • Allow empty sharing accounts array in sub account.
    • Add retry in resource sub account.
    • Replace module terraform with terraform-plugin-sdk. See further explanation here.
    • Upgrade to Go v1.15.
    • Update client version(v1.5.2).
  • v1.2.2
    • Update client version(v1.5.1).
    • Fix alerts_v2 sort bug.
  • v1.2.1
    • Fix alerts_v2 type "TABLE" bug.
  • v1.2
    • Update client version(v1.5.0).
    • Support Alerts v2 resource.
    • Fix 404 error for Alerts.
  • v1.1.8
    • Update client version
    • Fix custom endpoint headers bug
  • v1.1.7
    • Published to Terraform registry
  • v1.1.5
    • Fix boolean parameters not parsed bug
    • Support import command to state
  • v1.1.4
    • Support Sub Accounts resource
    • few bug fixes
    • removed circleCI
  • v1.1.3
    • examples now use TF12
    • will now generate the meta data needed for the IntelliJ type IDE HCL plugin
    • no more travis - just circle CI
    • version bump to use the latest TF library (0.12.6), now compatible with TF12
  • 1.1.2
    • Moved some of the source code around to comply with TF provider layout convention
    • Moved the examples into an examples directory

logzio_terraform_provider's People

Contributors

alexjurkiewicz avatar andypowell-form3 avatar doron-bargo avatar islomar avatar jonboydell avatar jonboydell-massive avatar mirii1994 avatar nico-shishkin avatar r1ckr avatar shalper avatar talhibner avatar veluu avatar yyyogev avatar

Watchers

 avatar  avatar

logzio_terraform_provider's Issues

Whitespace issues in alert provider

Plans that otherwise make no changes to state for alert resources yield whitespace changes:

      ~ filter                         = jsonencode(
          ~ {
              ~ bool = {
                  - filter   = [] -> null
                    must     = []
                    must_not = []
                  - should   = [] -> null
                }
            }
        )
~ filter                         = jsonencode(
          ~ {
              ~ bool = {
                    filter   = []
                  ~ must     = [
                      ~ {
                          ~ range = {
                              ~ foo = {
                                    gte = 60
                                  + lt  = null
                                }
                            }
                        },
                    ]
                    must_not = []
                    should   = []
                }
            }
        )

NB: variables swapped out to foo where applicable to protect real systems.

These changes are then not applied when the plan is applied, meaning that we see these whitespace changes as noise on each and every run. Ideally, the providers would not emit these changes meaning that, if nothing else had changed for a given plan, then the plan would be empty.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.