デプロイメントの記録と表示

アプリのデプロイは危険なイベントになる可能性があります。アプリが破損および不適切なデプロイメントが原因である場合がよくあります。New Relicを使用すると、デプロイメントを追跡できるため、デプロイメントをアプリのパフォーマンスの変化に関連付けできます。デプロイメントを追跡すると、APMチャートとダッシュボードに表示されるデプロイメントマーカーが作成されます。

この短いビデオ（4分30秒）で、デプロイメントマーカーがどのように機能するかをご覧ください。

デプロイメント追跡のオプション

New Relic REST API v2を使用すると、新しいデプロイメントを記録し、過去のデプロイメントリストを取得できます。さらに、一部のAPMエージェントには、デプロイメントを自動的に記録するエージェント固有の方法があります。

New Relicでスラックインテグレーション、または単純なwebhookを使用して、APMがモニターしているアプリケーションのデプロイメントをチームにリアルタイムで通知できます。スラックは、選択されたスラックチャネルにフォーマットされて表示される汎用JSONを投稿できるwebhook URLを提供します。

記録された後に、New Relic UIでデプロイメントを表示できる場所がいくつかあります。

• APM概要、サービス概要、エンティティの概要ページのアクティビティフィード。
• APMパフォーマンスチャートでは、チャートマーカー（ピンヘッド付きの縦線）として表示されます。
• ダッシュボードチャートでは、チャートマーカーとして表示されます。
• パフォーマンスの概要については、デプロイメントページに表示されます。

REST APIによるデプロイメントの記録

New Relic REST API v2を使用して、デプロイメントを記録、過去のデプロイメントのリストを取得できます。

• このドキュメントの例では、コマンドラインツールとしてcurlを使用しています。ただし、RESTリクエストには任意の方法を使用できます。デプロイメントの作成および表示は、APIエクスプローラーでもできます。

• JSONは、要素名とコンテンツにダブルクォート"を使用します。シングルクォート'の使用は、エラーの原因となります。

• この例は、

  ユーザーキー

  または

  REST APIキー

  のいずれかに使用できるX-Api-Keyを使用しています。ユーザーキーは、REST APIへのアクセス方法として推奨されており、使用時にApi-Keyヘッダーを使用できます。

$
curl -X POST "https://api.newrelic.com/v2/applications/$APP_ID/deployments.json" \
>
     -H "X-Api-Key:$API_KEY" \
>
     -i \
>
     -H "Content-Type: application/json" \
>
     -d \
>
'{
$
    "deployment": {
$
        "revision": "REVISION",
$
        "changelog": "Added: /v2/deployments.rb, Removed: None",
$
        "description": "Added a deployments resource to the v2 API",
$
        "user": "datanerd@example.com",
$
        "timestamp": "2019-10-08T00:15:36Z"
$
    }
$
}'

Invoke-WebRequest -Uri https://api.newrelic.com/v2/applications/YOUR_APP_ID/deployments.json -Method POST -Headers @{'X-Api-Key'='$API_KEY'} -ContentType 'application/json' -Body '{
    "deployment": {
        "revision": "REVISION",
        "changelog": "Added: /v2/deployments.rb, Removed: None",
        "description": "Added a deployments resource to the v2 API",
        "user": "datanerd@example.com",
        "timestamp": "2019-10-08T00:15:36Z"
    }
}'

$encoding = [System.Text.Encoding]::GetEncoding("ASCII")
$data ='{
    "deployment": {
        "revision": "REVISION",
        "changelog": "Added: /v2/deployments.rb, Removed: None",
        "description": "Added a deployments resource to the v2 API",
        "user": "datanerd@example.com",
        "timestamp": "2019-10-08T00:15:36Z"
    }
}'
$postData = $encoding.GetBytes($data)
$request = [System.Net.WebRequest]::Create('https://api.newrelic.com/v2/applications/$APP_ID/deployments.json')
$request.Method = 'POST'
$request.Headers.add('X-Api-Key','$API_KEY')
$request.ContentType='application/json'
$stream = $request.GetRequestStream()
$stream.Write($postData,0,$postData.Length)
$request.GetResponse()

$
curl -X GET "https://api.newrelic.com/v2/applications/$APP_ID/deployments.json" \
>
     -H "X-Api-Key:$API_KEY" \
>
     -i

$
curl -X GET "https://api.newrelic.com/v2/applications/9999999/deployments.json" \
>
     -H "X-Api-Key:ABCDEFGHIJKLMNOPQRSTUVWXabcdefghijklmnopqrstuvwx" \
>
     -i

HTTP/1.1 200 OK
ETag: "ABCDEFGHIJKabcdefghijk0123456789"
Cache-Control: max-age=0, private, must-revalidate
Content-Type: application/json
{
  "deployments": [
    {
      "id": 1234567,
      "revision": "1234123412341234123412341234123412341234",
      "changelog": "Fixed the bugs for real this time",
      "description": "Example description two",
      "user": "Data Nerd",
      "timestamp": "2016-02-24T10:09:27-08:00",
      "links": {
        "application": 9999999
      }
    },
    {
      "id": 2345678,
      "revision": "7890789078907890789078907890789078907890",
      "changelog": "Think I fixed all the bugs",
      "description": null,
      "user": "Dren Atad",
      "timestamp": "2014-10-22T12:23:47-07:00",
      "links": {
        "application": 9999999
      }
    }
  ],
  "links": {
    "deployment.agent": "/v2/applications/{application_id}"
  }
}

New Relicエージェントを使用したデプロイメントの記録

一部のエージェントには、デプロイメントを記録する追加メソッドがあります。

• 全セグメント: New Relic REST API v2を使用します。
• C: SDK固有のメソッドではありません。REST APIを使用します。
• Go: エージェント固有のメソッドではありません。REST APIを使用します。
• Java：Javaエージェントjarを呼び出します。
• .NET: PowerShellとREST APIを使用します。
• Node.js：エージェント固有のメソッドではありません。REST APIを使用します。
• PHP: PHPスクリプトを使用します。
• Python：newrelic-adminスクリプトのrecord-deployサブコマンドを使用します。
• Ruby: Capistranoレシピを使用します。

デプロイメント詳細の表示

デプロイメント情報を設定すると、UIで詳細を表示してドリルダウンできます。ヒントについては、変更追跡ドキュメントNew Relicでの変更を表示および分析する方法を参照してください。

チームへのデプロイメントの通知

REST API、または新しいGraphQL APIを使用してデプロイメントを追跡している場合、Webhookを使用してチームメンバーに通知できます。詳細については、変更追跡Webhookの手順を参照してください。