変更追跡機能を使用すると、監視する変更を指定して、顧客やシステムにどのように影響するかを確認できます。
GraphQL または CLI を使用して監視する変更を指定できますが、Jenkins のパイプラインを使用して変更を記録することもできます。
パイプラインは、指定したビルドを呼び出し、追加の環境変数をビルド プロセスに渡します。これにより、デプロイに必要なデータが入力され、New Relic 全体のチャートに表示されます。変更追跡 UI に結果が表示され、この情報を使用してエンティティの正常性に対する変更の影響を理解できます。
開始する前に、Jenkins バージョン 2.222.4 以降を使用していることを確認してください。
プラグインを管理する
変更追跡のデプロイを記録するには、Jenkins インスタンスに簡単に追加または削除できる特別なプラグインが必要です。
Jenkins 管理者として次の手順を実行します。
プラグインを追加する
重要
以下のプラグインのインストール手順では、Jenkins の再起動が必要です。
プラグインを追加するには:
ここからプラグインをダウンロードします。ダウンロード中にファイル名が変更された場合は、ファイルの名前を
newrelic-deployment-notifier.hpiに変更します。ヒント
これはプラグインの一時的なダウンロード場所であることに注意してください。これを Jenkins で直接ダウンロードできるようになったらお知らせします。Jenkins を開き、 [Manage Jenkins]をクリックします。
プラグインの管理 をクリックします。
[詳細]をクリックします。
Deploy Pluginで、 Choose File をクリックし、ファイル
newrelic-deployment-notifier.hpiをアップロードします。インストールを完了するには、ジョブが実行されていないことを確認してから、Jenkins を再起動します。Restart Jenkins when installation is complete and no jobs are running[インストールが完了し、ジョブが実行されていないときに Jenkins を再起動する]ボックスをオンにすることもできます。
プラグインを削除する
プラグイン マネージャーを使用してプラグインを削除するには:
[インストール済み]をクリックします。
検索ボックスに deploy と入力し、 New Relic Deployment Notifier Pluginを選択してから、ロールバック記号をクリックして、以前のバージョンにロールバックします。
Xアイコンをクリックしてアンインストールすることもできます。
パイプラインを作成して実行する
次の手順に従って、ビルドの実行時にデプロイの詳細を Jenkins に渡すパイプライン スクリプトを作成します。Jenkins パイプラインは、チェーンされたステップのリストです。Jenkins パイプラインは、次の 2 つの方法のいずれかで作成できます。
Jenkinsfileを作成し、ソース コード リポジトリのルートに配置します- Jenkins のパイプライン スクリプト機能を使用する
各ステージはステップのリストで構成されています。このパートのステップの 1 つ (おそらく最後のステップ) では、 NewRelicDeploymentNotifierを呼び出して、ビルドが成功したことを示すマーカーを配置します。
作成したプラグインは GUID をパラメーターとして受け取ります。Environmentセクションで GUID を変数として識別し、後続の手順で変数として使用できます。ビルドは、ステージとステップのリストに入れて呼び出されます。
パイプライン タブに移動し、下部にあるPipeline Syntaxをクリックします。
[ Sample Step ] ドロップダウンをクリックし、[ step: General Build Step ] を選択します。
Build Stepの下で、 New Relic Deployment Notificationsを選択します。
次のフィールドに入力します (GraphQL API を使用していない人のために REST API フィールドを含めました)。
フィールド
GraphQL API
REST API
説明
API キー
必須
必須
New Relic でデプロイ アクションを実行するための API 資格情報。ユーザー名とパスワードを使用して Jenkins で新しい資格情報を作成することにより、資格情報を作成できます。ユーザー名には任意の識別子を指定し、パスワードには API キーを指定します。
アプリケーションID
該当なし
必須
これは、REST API への呼び出しにのみ使用されます。GraphQL エンドポイントへの呼び出しを作成している場合は、これを含めないでください。
説明
オプション
オプション
追跡対象の説明を挿入します。
リビジョン
該当なし
必須
展開のリビジョン。
変更ログ
オプション
オプション
展開で発生した変更のリストへの参照。
専念
オプション
該当なし
コミット ID を参照するハッシュ。
ディープリンク
オプション
該当なし
Jenkins ジョブまたはデプロイメントへのその他の参照へのディープ リンク。
EntityGuid
必須
該当なし
展開に関するアプリケーション エンティティ (詳細については、アプリケーション GUIDを参照してください)。
展開タイプ
オプション
該当なし
実施されているデプロイメントのタイプ。
グループ ID
オプション
該当なし
デプロイのクラスターを参照する識別子。
タイムスタンプ
オプション
該当なし
オプションの Unix エポック ロング フォーマットのタイムスタンプ。指定されていない場合は、リクエストを受信した時間に設定します。これは、Unix エポックからのミリ秒数になります。
バージョン
必須
該当なし
デプロイされているバージョンの必須フィールド。
ユーザー
オプション
オプション
展開を行っているユーザー。これは自由形式のフィールドです。Jenkins では、コミットで名前を指定するか、「Jenkins auto deploy」などを指定することをお勧めします。
[パイプライン スクリプトの生成] をクリックします。
スクリプトをコピーし、パイプラインのメイン ページに戻り、パイプライン スクリプトに貼り付けます。
パイプライン スクリプトを実行して、New Relic でデプロイ マーカーを作成します。
ヒント
引き続き New Relic REST API にリクエストを送信する場合は、 EntityGuidを削除して applicationID を追加できます。
このパイプライン スクリプトを GitHub に移動します
パイプライン スクリプトを GitHub に保存できます。パイプライン スクリプトを取得するには、Jenkins でアプリケーションを作成するときに GitHub リポジトリの場所を指定できます。
アプリケーション GUID の詳細
現在、GUID をパイプラインに動的に割り当てることはできません。New Relic でエンティティ GUID を見つける必要があります (「 New Relic エンティティについて学ぶ」を参照し、パイプライン スクリプトでこの値をハードコーディングして、そのエンティティのデプロイ通知を報告します。この情報は機密ではなく、公開して保存できます。
アプリケーションの更新に使用される資格情報は、不適切な展開マーカーの送信を軽減する必要があります。さらに、資格情報は Jenkins の ID によって参照されるため、ソース コード リポジトリに格納する必要はありません。
障害が発生したかどうかを検出する方法
パイプラインの構文エラーにより、パイプラインが停止します。パイプライン解析エラー (ビルド ステップの欠落など) は、パイプラインを停止します。Jenkins ツールを使用してこれらをトラブルシューティングし、適切なパイプライン スクリプトを作成する必要があります。Jenkins で WYSIWYG パイプライン シンタックス ツールを使用すると、New Relic のデプロイ通知を適切に作成するのに役立ちます。
プラグインがエラーを検出した場合、パイプラインを停止すべきではありません。例外とスタック トレースをログに記録し、続行します。これにより、アプリケーションの構築およびデプロイ時の中断を防ぐことができます。
次のステップ
追跡したい変更を指定したら、New Relic UI でそれらの変更の影響を分析できます。詳細については、 New Relic で変更を表示および分析する方法 を参照してください。