New Relic と Terraform を使い始める

Terraform は、HashiCorp によって構築された、人気のインフラストラクチャ・アズ・コードソフトウェアツールです。これを使用して、New Relic やアラートを含むあらゆる種類のインフラストラクチャとサービスをプロビジョニングします。

このガイドでは、Terraform を使用して New Relic を設定する方法を学習します。具体的には、アラートポリシー、4 つのアラート条件、および通知チャネルをプロビジョニングします。 4 つのアラート条件は、Google のサイト信頼性エンジニアリングブックで紹介されている 4 つのゴールデンシグナルに基づいています。

Latency:
アプリケーションがリクエストを処理するのにかかる時間。
Traffic:
システムが受信するリクエストの量。
Errors:
失敗したリクエストの割合。
Saturation:
アプリケーションの要求を満たすためのリソースへのストレス。

あなたが始める前に

このガイドを使用するには、New Relic と Terraform の両方に関する基本的な知識が必要です。 New Relic オープンソースエージェントをまだデプロイしていない場合は、アプリケーションにNew Relic をインストールしてください。また、 Terraform CLI をインストールします。

Bootstrap Terraform と New Relic プロバイダー

まず、作業ディレクトリを初期化し、Terraform 構成ファイルを作成します。

bash

$mkdir terraform-project && cd terraform-project
$touch main.tf

次に、 main.tfのterraformブロックとrequired_providersブロックを設定して、Terraform に New Relic プロバイダーをインストールして使用するように指示します。

terraform {
  # Require Terraform version 1.0 (recommended)
  required_version = "~> 1.0"

  # Require the latest 2.x version of the New Relic provider
  required_providers {
    newrelic = {
      source  = "newrelic/newrelic"
    }
  }
}

このコードブロックでは、必要な Terraform のバージョンを 1.0 に設定し、New Relic プロバイダーを最新の 2.x バージョンに設定しています。セットアップに適切なバージョン制約を使用すると、Terraform 実行の安定性が向上します。

Terraform と New Relic プロバイダーのバージョンを設定したので、New Relic プロバイダーを構成する必要があります。

New Relic プロバイダーを構成する

terraformがすべて設定されたら、次の項目で New Relic providerを構成します。

New Relic アカウント ID 。
あなたのNew Relic
。ほとんどのユーザーキーはプレフィックスNRAK-で始まります。
あなたのNew Relic リージョン。 New Relic URL がone.newrelic.comの場合、リージョンはUSです。URL がone.eu.newrelic.comの場合、リージョンはEUです。
main.tfで、プロバイダーに次の値を設定します。
```
provider "newrelic" {
  account_id = 12345   # Your New Relic account ID
  api_key = "NRAK-***" # Your New Relic user key
  region = "US"        # US or EU (defaults to US)
}
```
New Relic プロバイダーでこれらの値を設定することにより、New Relic API を介してアカウントに代わって変更を行うようにそのプロバイダーを構成します。
ヒント
環境変数を使用して New Relic プロバイダーを設定することもできます。これは、プロバイダー構成のデフォルト値を設定する便利な方法です。
New Relic プロバイダーの構成の詳細については、公式のプロバイダードキュメントを参照してください。
New Relic プロバイダーを構成したら、Terraform を初期化します。
bash
```
$terraform init
```
Terraform が New Relic プロバイダーのインストールと登録を完了すると、成功メッセージと、 terraform planの実行などの次のアクション可能なステップが表示されます。ただし、 terraform planを実行する前に、リソースを作成する必要があります。

ゴールデンシグナルアラートを使用して New Relic アラートポリシーを作成する

New Relic プロバイダーを構成して初期化したら、アプリケーションのアラート戦略を定義できます。

特定のアプリケーションをターゲットにしているため、newrelic_entityを使用して New Relic からアプリケーション情報をフェッチし、構成内の別の場所でそのデータを参照できるようにします。

data "newrelic_entity" "example_app" {
  name = "Your App Name" # Must be an exact match to your application name in New Relic
  domain = "APM" # or BROWSER, INFRA, MOBILE, SYNTH, depending on your entity's domain
  type = "APPLICATION"
}

次に、 newrelic_alert_policyを作成します。アプリケーションの名前に基づいて、ポリシーに動的な名前を付けます。これは、ポリシーの範囲を指定するのに役立ちます。

resource "newrelic_alert_policy" "golden_signal_policy" {
  name = "Golden Signals - ${data.newrelic_entity.example_app.name}"
}

この時点で、ドライランで構成をテストできるはずです。

bash

$terraform plan

Terraform の実行計画を示す出力が表示されます。プランには、 terraform applyの実行時に Terraform が実行するアクションが含まれています。

bash

# Example output
------------------------------------------------------------------------
An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
  + create
Terraform will perform the following actions:
  # newrelic_alert_policy.golden_signal_policy will be created
  + resource "newrelic_alert_policy" "golden_signal_policy" {
      + account_id          = (known after apply)
      + id                  = (known after apply)
      + incident_preference = "PER_POLICY"
      + name                = "Golden Signals - Your App Name"
    }
Plan: 1 to add, 0 to change, 0 to destroy.
------------------------------------------------------------------------

この場合、プランは、 terraform applyを実行すると Terraform が新しいアラートポリシーを作成することを示しています。詳細を確認したら、プランを実行して、New Relic アカウントにアラートポリシーリソースをプロビジョニングします。

bash

$terraform apply

applyを変更するたびに、Terraform は、実行するように指示したアクションを確認するよう求めます。「はい」と入力します。

実行中、Terraform はログをコンソールに送信します。

bash

# Example output of `terraform apply`
newrelic_alert_policy.golden_signal_policy: Creating...
newrelic_alert_policy.golden_signal_policy: Creation complete after 1s [id=111222333]
Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

New Relic にログインし、 Alert Policiesに移動して、Terraform によって新しいポリシーが作成されたことを確認します。

アラート条件を作成する次のステップに進む際に、各リソースを構成した後にterraform applyを実行できます。アラートポリシーの Web ページを更新して、新しいリソースを表示します。

4 つのゴールデンシグナルに基づいてアラート条件をプロビジョニングする

次に、レイテンシ、トラフィック、エラー、飽和の 4 つのゴールデンシグナルに基づいて、アプリケーションのアラート条件を追加します。これらのアラート条件を、前の手順で作成したアラートポリシーに適用します。

Latency

ほとんどの人は、応答時間が遅くなることは避けたいと考えています。アプリケーションの全体的な応答時間が 5 分間で 5 秒を超えた場合にトリガーするnewrelic_alert_conditionを作成できます。

# Response time
resource "newrelic_alert_condition" "response_time_web" {
  policy_id       = newrelic_alert_policy.golden_signal_policy.id
  name            = "High Response Time (Web) - ${data.newrelic_entity.example_app.name}"
  type            = "apm_app_metric"
  entities        = [data.newrelic_entity.example_app.application_id]
  metric          = "response_time_web"
  runbook_url     = "https://www.example.com"
  condition_scope = "application"

  term {
    duration      = 5
    operator      = "above"
    priority      = "critical"
    threshold     = "5"
    time_function = "all"
  }
}

policy_idを使用して、このアラート条件を以前に構成したアラートポリシーにリンクしていることに注意してください。

newrelic_alert_condition廃止される予定であり、今後は NRQL アラートを使用することになります。次の設定を使用して、上記と同じ機能を実行するNRQL集計を作成できます。

# Response time - Create Alert Condition
resource "newrelic_nrql_alert_condition" "response_time_alert" {
  policy_id                    = newrelic_alert_policy.golden_signal_policy.id
  type                         = "static"
  name                         = "Response Time - ${data.newrelic_entity.example_app.name}"
  description                  = "High Transaction Response Time"
  runbook_url                  = "https://www.example.com"
  enabled                      = true
  violation_time_limit_seconds = 3600

  nrql {
    query             = "SELECT filter(average(newrelic.timeslice.value), WHERE metricTimesliceName = 'HttpDispatcher') OR 0 FROM Metric WHERE appId IN (${data.newrelic_entity.example_app.application_id}) AND metricTimesliceName IN ('HttpDispatcher', 'Agent/MetricsReported/count')"
  }

  critical {
    operator              = "above"
    threshold             = 5
    threshold_duration    = 300
    threshold_occurrences = "ALL"
  }
}

Traffic

トラフィックは、特定の瞬間にシステムにどれだけの需要があるかを表します。スループットは、アプリケーションへのトラフィック量を測定する指標です。アプリケーションの全体的な応答率が 1 分あたり 5 リクエストを 5 分間下回った場合にトリガーするnewrelic_alert_conditionを作成します。

# Low throughput
resource "newrelic_alert_condition" "throughput_web" {
  policy_id       = newrelic_alert_policy.golden_signal_policy.id
  name            = "Low Throughput (Web)"
  type            = "apm_app_metric"
  entities        = [data.newrelic_entity.example_app.application_id]
  metric          = "throughput_web"
  condition_scope = "application"

  # Define a critical alert threshold that will
  # trigger after 5 minutes below 5 requests per minute.
  term {
    priority      = "critical"
    duration      = 5
    operator      = "below"
    threshold     = "5"
    time_function = "all"
  }
}

このタイプのアラートは、1 日を通して一定のベースライントラフィックが予想される場合に役立ちます。トラフィックの低下は問題を示している可能性があります。

Errors

アプリケーションのエラー率が急上昇した場合は、それについて知る必要があります。アプリケーションのエラー率が 5 分間 5% を超えた場合にトリガーするnewrelic_alert_conditionを作成します。

# Error percentage
resource "newrelic_alert_condition" "error_percentage" {
  policy_id       = newrelic_alert_policy.golden_signal_policy.id
  name            = "High Error Percentage"
  type            = "apm_app_metric"
  entities        = [data.newrelic_entity.example_app.application_id]
  metric          = "error_percentage"
  runbook_url     = "https://www.example.com"
  condition_scope = "application"

  # Define a critical alert threshold that will trigger after 5 minutes above a 5% error rate.
  term {
    duration      = 5
    operator      = "above"
    threshold     = "5"
    time_function = "all"
  }
}

Saturation

飽和度は、サービスがどの程度「満杯」であるかを表し、CPU 時間、メモリ割り当て、キューの深さなど、さまざまな形式を取ることができます。この例では、アプリケーションを提供するホストにNew Relic Infrastructureがすでにインストールされており、CPU 使用率が特定の閾値を超えて急上昇した場合の集計を構成すると想定します。

# High CPU usage
resource "newrelic_infra_alert_condition" "high_cpu" {
  policy_id   = newrelic_alert_policy.golden_signal_policy.id
  name        = "High CPU usage"
  type        = "infra_metric"
  event       = "SystemSample"
  select      = "cpuPercent"
  comparison  = "above"
  runbook_url = "https://www.example.com"
  where       = "(`applicationId` = '${data.newrelic_entity.example_app.application_id}')"

  # Define a critical alert threshold that will trigger after 5 minutes above 90% CPU utilization.
  critical {
    duration      = 5
    value         = 90
    time_function = "all"
  }
}

インフラストラクチャ集計では、これらのホストの合計 CPU 使用率が 5 分間 90% を超えた場合にトリガーされるnewrelic_infra_alert_conditionを作成しました。

アラートがトリガーされたときに通知を受け取る

いくつかの重要なアラート条件を構成したので、通知先と通知チャネルをアラートポリシーに追加して、アラートがトリガーされたときに適切な人に通知されるようにします。これを行うには、 newrelic_notification_destinationとnewrelic_notification_channelを使用します。

まず、メール通知先を作成して受信者リストを構成します。受信者リストは、特定の人またはチームにすることができます。これは、通知チャネルを作成するときに使用されます。

resource "newrelic_notification_destination" "team_email_destination" {
  name = "email-example"
  type = "EMAIL"

  property {
    key = "email"
    value = "team.member1@email.com,team.member2@email.com,team.member3@email.com"
  }
}

複数の電子メールを指定する場合は、カンマ区切りの電子メールリストを使用します。

次に、電子メール通知チャネルテンプレートを作成して、アラート通知を電子メールに送信します。チャネルを宛先 ID に関連付けます。

resource "newrelic_notification_channel" "team_email_channel" {
  name = "email-example"
  type = "EMAIL"
  destination_id = newrelic_notification_destination.team_email_destination.id
  product = "IINT"

  property {
    key = "subject"
    value = "New Subject"
  }
}

最後になりましたが、通知チャネルをアラートポリシーに適用するために、 newrelic_workflowを作成します。

resource "newrelic_workflow" "team_workflow" {
  name = "workflow-example"
  enrichments_enabled = true
  destinations_enabled = true
  workflow_enabled = true
  muting_rules_handling = "NOTIFY_ALL_ISSUES"

  enrichments {
    nrql {
      name = "Log"
      configurations {
       query = "SELECT count(*) FROM Metric"
      }
    }
  }

  issues_filter {
    name = "filter-example"
    type = "FILTER"

    predicate {
      attribute = "accumulations.sources"
      operator = "EXACTLY_MATCHES"
      values = [ "newrelic" ]
    }
  }

  destination {
    channel_id = newrelic_notification_channel.team_email_channel.id
  }
}

newrelic_workflowは、作成したばかりの通知チャネルをアラートにリンクします。

通知構成を完了するには、最後にもう一度terraform applyを実行して、構成済みのすべてのリソースが最新であることを確認してください。

アラートがトリガーされたときに通知を受け取る (非推奨)

重要

アラートチャネルは非推奨であり、将来のバージョンではサポートされません。

いくつかの重要なアラート条件を構成したので、通知チャネルをアラートポリシーに追加して、アラートがトリガーされたときに適切な人が確実に通知されるようにします。そのためには、 newrelic_alert_channelを使用します。

まず、メール通知チャネルを作成して、アラート通知をメールに送信します。アラートがトリガーされたときに特定の人またはチームに通知する場合は、これを使用します。

resource "newrelic_alert_channel" "team_email" {
  name = "example"
  type = "email"

  config {
    recipients              = "yourawesometeam@example.com"
    include_json_attachment = "1"
  }
}

複数のrecipientsを指定する場合は、電子メールのカンマ区切りリストを使用してください。

最後になりましたが、通知チャネルをアラートポリシーに適用するために、 newrelic_alert_policy_channelを作成します。

resource "newrelic_alert_policy_channel" "golden_signals" {
  policy_id   = newrelic_alert_policy.golden_signal_policy.id
  channel_ids = [newrelic_alert_channel.team_email.id]
}

newrelic_alert_policy_channelは、作成したばかりの通知チャネルをアラートポリシーにリンクします。

ゴールデンシグナルアラートの構成を完了するには、最後にもう一度terraform applyを実行して、構成済みのすべてのリソースが最新であることを確認してください。

エクストラクレジット

new_relic_alert_channel 電子メール、Slack、PagerDuty など、いくつかのタイプの通知チャネルをサポートしています。したがって、これをさらに詳しく調べたい場合は、Slack などの 2 番目のチャネルタイプのアラートチャネルを作成してみてください。

# Slack notification channel
resource "newrelic_alert_channel" "slack_notification" {
  name = "slack-example"
  type = "slack"

  config {
    # Use the URL provided in your New Relic Slack integration
    url     = "https://hooks.slack.com/services/XXXXXXX/XXXXXXX/XXXXXXXXXX"
    channel = "your-slack-channel-for-alerts"
  }
}

この変更をapplyする前に、 New Relic Slack アプリを Slack アカウントに追加し、通知を送信する Slack チャネルを選択する必要があります。この新しいアラートチャネルでは、トリガーされたアラートが選択した Slack チャネルに通知を送信します。

結論

配置したアラートシステムをチームが評価すると、アラートのしきい値や期間などの構成値を微調整する必要がある場合があることがわかります。リモートリポジトリで Terraform プロジェクトを管理している場合は、プルリクエストを送信して、チームが残りのコードコントリビューションとともにこれらの変更をレビューできるようにすることができます。

ヒント

CI/CD パイプラインでこのプロセスを自動化することも検討してください。Terraform の推奨プラクティスガイドを使用して、推奨されるワークフローと、プロビジョニングプラクティスを発展させる方法について学習してください。

おめでとう！コードとしてのオブザーバビリティを公式に実践しています。New Relic Terraform プロバイダーのドキュメントを確認して、構成を次のレベルに引き上げる方法を確認してください。

この機械翻訳は、参考として提供されています。

New Relic と Terraform を使い始める

あなたが始める前に.css-21sua1{background:none;border:none;width:0;padding:0;}

Bootstrap Terraform と New Relic プロバイダー

New Relic プロバイダーを構成する

ヒント

ゴールデン シグナル アラートを使用して New Relic アラート ポリシーを作成する

4 つのゴールデン シグナルに基づいてアラート条件をプロビジョニングする

アラートがトリガーされたときに通知を受け取る

アラートがトリガーされたときに通知を受け取る (非推奨)

重要

エクストラクレジット

結論

ヒント

あなたが始める前に

ゴールデンシグナルアラートを使用して New Relic アラートポリシーを作成する

4 つのゴールデンシグナルに基づいてアラート条件をプロビジョニングする