GitHub アクションで変更を追跡する

New Relic の変更追跡機能を GitHub アクションと組み合わせて使用して、顧客やシステムに対する変更の影響を監視できます。GitHub アクションを使用すると、監視する変更を指定して、New Relic UI で結果を確認できます。これにより、リリースパイプライン中に環境で行った変更を追跡できます。

入力

入力要素は次のとおりです。

鍵	必須	デフォルト	説明
`guid`	そう	該当なし	展開マーカーを適用するエンティティ GUID。
`apiKey`	そう	該当なし	New Relic の個人用 API キー
`changelog`	ノー	該当なし	この展開で変更された内容の概要。[展開] ページに表示されます
`description`	ノー	該当なし	このデプロイメントの概要説明。個々のデプロイメントを選択すると、[概要] ページと [デプロイメント] ページに表示されます。
`deeplink`	ノー	該当なし	デプロイをトリガーしたソースへのディープリンク
`deploymentType`	ノー	`BASIC`	デプロイメントのタイプ。デフォルトの`BASIC`の他に、 `BLUE_GREEN` 、 `CANARY` 、 `OTHER` 、 `ROLLING` 、または `SHADOW`
`groupId`	ノー	該当なし	他のデプロイメントにリンクするためのデプロイメントのグループ ID
`region`	ノー	`US`	New Relic アカウントのリージョン。デフォルト： `US`
`version`	そう	該当なし	デプロイマーカーに適用するメタデータ - 例: 最新のリリースタグ
`user`	そう	`github.actor`	デプロイメントに関連付けるユーザー名で、[概要] ページと [デプロイメント] ページに表示されます

使用例

GitHub アクションの使用例をいくつか示します。

リビジョンにはリリースタグを使用

次の例をジョブとして既存のワークフローに追加できます。これは、リビジョンがリリースタグである New Relic デプロイメントマーカーを作成します。

次の Github シークレットが設定されていることを確認します。

NEW_RELIC_API_KEY - パーソナル API キー
NEW_RELIC_DEPLOYMENT_ENTITY_GUID - マーカーを作成するための New Relic Entity GUID

name: Release

on:
  - release

jobs:
  newrelic:
    runs-on: ubuntu-latest
    name: New Relic
    steps:
      - name: Set Release Version from Tag
        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV

      - name: Create New Relic deployment marker
        uses: newrelic/deployment-marker-action@v2-beta
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID }}
          version: "${{ env.RELEASE_VERSION }}"

すべての入力オプション

すべてのオプションを設定して、リリース時に New Relic アプリケーション展開マーカーを追加します。

次の Github シークレットが設定されていることを確認します。

NEW_RELIC_API_KEY (個人APIキー)
NEW_RELIC_DEPLOYMENT_ENTITY_GUID (マーカーを作成する New Relic Entity GUID)

name: Release
on:
  - release

jobs:
  newrelic:
    runs-on: ubuntu-latest
    steps:
      - name: Create New Relic deployment marker
        uses: newrelic/deployment-marker-action@v2-beta
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID }}
          version: "${{ github.ref }}-${{ github.sha }}"

          # Optional
          changelog: "See https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md for details"
          description: "Automated Deployment via Github Actions"
          region: ${{ secrets.NEW_RELIC_REGION }}
          user: "${{ github.actor }}"

次のステップ

追跡したい変更を指定したら、New Relic UI でそれらの変更の影響を分析できます。詳細については、 New Relic で変更を表示および分析する方法を参照してください。

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

GitHub アクションで変更を追跡する

入力

使用例

リビジョンにはリリースタグを使用

すべての入力オプション

次のステップ