デプロイメントを記録する
デプロイメントを記録する

デプロイメントを記録する

デプロイメントを記録する

New Relicの《REST API v2》を利用し、新しいデプロイメントの記録や過去のデプロイメントの一覧の検索、過去のデプロイメントの消去が可能です。自動的にデプロイメントを記録する特定の方法を持つエージェントもあります。

デプロイメントの記録後は、《デプロイメント》ページや《概要》ページの最近のイベント一覧から確認することができます。

この機能へのアクセス可否は《サブスクリプションレベル》に依存します。

 

REST API手順

New Relic REST API v2を利用し、デプロイメントの記録や過去のデプロイメント一覧の入手、デプロイメントの消去が可能です:

以下の例は【cURL】をコマンド ライン ツールとして利用しています。しかし、RESTリクエストを作るために任意の方法を利用可能です。また、《API Explorer》でデプロイメントを作成、表示、消去することもできます。

 

POSTでデプロイメントを記録する
新しいデプロイメントを記録するには、《REST APIキー》を含む『POST』リクエストをデプロイメントのエンドポイントに送信してください。JSON形式で(《文字制限とJSONパラメーター》をご覧ください)ペイロードを添付します。『revision』以外の全てのペイロードパラメーターはオプショナルです。
例:

PowerShellでデプロイメントを記録する
PowerShellでデプロイメントを記録するには、《REST APIキー》を含む『POST』リクエストをデプロイメントのエンドポイントに送信してください。JSON形式で(《文字制限とJSONパラメーター》をご覧ください)ペイロードを添付します。『revision』以外の全てのペイロードパラメーターはオプショナルです。

この例はPowerShellのバージョン3もしくはそれ以降を利用しています:

この例はPowerShellのバージョン2(.NETフレームワークの3.5もしくはそれ以降が必要となります)を利用しています:

デプロイメントの一覧をGETで表示する
アプリの過去のデプロイメント全ての一覧を確認するには、《REST APIキー》を含む『GET』リクエストをデプロイメントのエンドポイントに送信します。GETリクエストはJSONペイロードを利用しません。

例:

GETからのSample output

この例ではアプリID『9999999』のデプロイメント一覧をリクエストしています:

APIがデプロイメント一覧を返します;

DELETEでデプロイメントを消去する
デプロイメントを消去するには、《管理者のAPIキー》を含む『DELETE』リクエストをデプロイメントのエンドポイントに送信します。DELETEリクエストはJSONペイロードを利用しませんが、消去したいデプロイメントのIDをしていする必要があります。デプロイメントのIDを入手するには、《GETリクエスト》を利用してください。

例:

文字制限とJSONパラメーター

JSONペイロードは下記のパラメーターに含まれます:

パラメーター データ タイプの説明
revision 文字列、最大127文字 必須。《一覧》ページと《デプロイメント》ページに表示されるこのデプロイメント独自のIDです。どのような文字列でもいいですが、大抵バージョンの番号もしくはGitチェックサムが利用されます。
changelog 文字列、最大65535文字 オプショナル。このデプロイメントで変更された箇所のサマリーで、【(選択したデプロイメント) > Change log】を選択した時《デプロイメント》ページに表示されます。
description 文字列、最大65535文字 オプショナル。このデプロイメントの高レベルな説明であり、個別のデプロイメントを選択した時《概要》ページと《デプロイメント》ページに表示されます。
user 文字列、最大31文字 オプショナル。デプロイメントに関連付けられたユーザー名で、《概要》ページと《デプロイメント》ページに表示されます。

 

エージェント手順

いくつかのエージェントでは、デプロイメントを記録するために追加の手順が必要となります:

  • 全てのエージェント:《New Relic REST API v2を利用します》
  • Java:《Java agent jarを呼び出します》
  • .NET:《PowerShellとREST APIを利用します》
  • Node.js:エージェントに特有の手順はありません、《REST APIを利用します》
  • PHP:《PHPスクリプトを利用します》
  • Python:『newrelic-admin』スクリプトの《『record-deploy』》サブコマンドを利用します
  • Ruby:《Capistranoレシピを利用します》。

 

パートナーアカウント手順

New Relicパートナーを通じてアカウントを所有している場合、追加の制限や手順が適用される場合があります。詳しくは、特定のパートナー手順についてご確認ください:

  • 《Engine Yard》
  • 《Heroku》

 

関連情報

追加のドキュメンテーションリソースは次のとおりです。

  • 《REST API v1とデプロイメント》(レガシーのAPI v1でデプロイメントを記録します)
  • 《デプロイメントページ》(過去のデプロイメントの詳細を表示します)

New Relic 《オンラインテクニカルコミュニティー 》での New Relic APMに関するディスカッションにぜひご参加ください ! テクニカルコミュニティーはNew Relicツールセットについて議論し、トラブルシューティングを行うための公開プラットフォームです。

PROプランのすべての機能を
14日間無料でお試し

新規無料登録いただくとPROプランのすべての機能を
14日間無料でお試しいただけます。
クレジットカードなど決済情報の登録は不要です。

各プランの詳細はこちらからご確認ください。