terraform-newrelic-monitoring

This Terraform module creates New Relic alerts and a dashboard to monitor an application. It also allows for sending notifications to PagerDuty.

Example Usage

provider "newrelic" {
  account_id    = Your New Relic account id
  api_key       = "Your New Relic API key"
  admin_api_key = "Your New Relic admin API key"
  region        = "Your New Relic account region (US or EU)"
}

module "newrelic_monitoring" {
  source  = "vistaprint/monitoring/newrelic"
  version = ">= 3.0.0, < 4.0.0"

  newrelic_account_id = Your New Relic account id

  newrelic_app_name                 = "Your app name"
  newrelic_fully_qualified_app_name = "Team/PRD/App"
  service_healthcheck_url           = "https://your-service-url.com"
}

See variables.tf for more information on the input variables that the module accepts. For instance, the default values for an alert's duration and threshold can be overridden. The following example shows how to do so:

module "newrelic_monitoring" {
  source  = "vistaprint/monitoring/newrelic"
  version = ">= 3.0.0, < 4.0.0"

  # some fields ommitted (see previous example)
  
  alert_high_latency_urgent_duration  = 350  # seconds
  alert_high_latency_urgent_threshold = 1500 # milliseconds
}

Defining alerts on status codes

To enable alerts for status codes, you need to use the status_code_alerts variable. For instance, if you want to enable them for 4xx errors, you can do:

module "newrelic_monitoring" {
  source  = "vistaprint/monitoring/newrelic"
  version = ">= 3.0.0, < 4.0.0"

  # some fields ommitted (see first example)

  status_code_alerts = [
    {
      name                = "Your app name: too many sustained 4xx errors"
      status_code_pattern = "4%"
      urgent              = false
      duration            = 300
      threshold           = 30
    }
  ]  
}

Enabling Integration with PagerDuty

To integrate your New Relic alerts with PagerDuty add the following lines to the module configuration:

enable_pagerduty_notifications = true
pagerduty_service_key          = "The New Relic integration key for your service in PagerDuty"

You can obtain the integration key for your service with Terraform using a resource named pagerduty_service_integration.

Creating Default SLOs

New Relic supports the creation of service levels for applications. This terraform module allows for creating two SLOs – one measuring request latency and the other measuring application availability. The SLOs use a default rolling time window spanning seven days. To create the SLOs, set the following variable:

create_default_slos = true

Some parameters for the SLOs can be fine-tuned (see variables.tf for more details). For instance, you can use the following snippet to specify that the latency duration should not exceed 100 ms with a target value of 99.99%.

latency_slo_target = 99.99
latency_slo_duration_threshold = 0.1

For more details about these parameters, please check the official documentation.