GitHub Actions で変更を追跡する

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

入力

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

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

使用例

GitHub シークレット

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

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

New Relicアプリケーションデプロイメントマーカーページを確認し、Use latest version ボタンをクリックして、利用可能な最新バージョンを使用していることを確認してください。

これらの例でも使用されているデフォルトの GitHub 環境変数が多数あります。

最低限必要なフィールド

name: Change Tracking Marker
on:
  release:
    types: [published]

jobs:
  newrelic:
    runs-on: ubuntu-latest
    name: New Relic
    steps:
      # This step builds a var with the release tag value to use later
      - name: Set Release Version from Tag
        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
      # This step creates a new Change Tracking Marker
      - name: New Relic Application Deployment Marker
        uses: newrelic/deployment-marker-action@v2.3.0
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID }}
          version: "${{ env.RELEASE_VERSION }}"
          user: "${{ github.actor }}"

すべての入力フィールド

NEW_RELIC_API_KEYに加えて、この例では、「 NEW_RELIC_DEPLOYMENT_ENTITY_GUID_<ID> 」のような複数のシークレットを格納することで、複数のアイテムをターゲットにする方法を示しています。ここで、 <ID>はターゲットアイテムの一意の識別子です。

NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App123
NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App456
NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App789

name: Change Tracking Marker
on:
  workflow_dispatch:
  release:
    types: [published]

jobs:
  newrelic:
    runs-on: ubuntu-latest
    name: New Relic
    steps:
      # This step builds a var with the release tag value to use later
      - name: Set Release Version from Tag
        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
      # This step creates a new Change Tracking Marker for App123
      - name: App123 Marker
        uses: newrelic/deployment-marker-action@v2.3.0
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App123 }}
          version: "${{ env.RELEASE_VERSION }}"
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          description: "Automated Release via Github Actions"
          deploymentType: "ROLLING"
          groupId: "Workshop App Release: ${{ github.ref_name }}"
          user: "${{ github.actor }}"
      # This step creates a new Change Tracking Marker for App456
      - name: App456 Marker
        uses: newrelic/deployment-marker-action@v2.3.0
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App456 }}
          version: "${{ env.RELEASE_VERSION }}"
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          description: "Automated Release via Github Actions"
          deploymentType: "ROLLING"
          groupId: "Workshop App Release: ${{ github.ref_name }}"
          user: "${{ github.actor }}"
      # This step creates a new Change Tracking Marker for App789
      - name: App789 Marker
        uses: newrelic/deployment-marker-action@v2.3.0
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App789 }}
          version: "${{ env.RELEASE_VERSION }}"
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          description: "Automated Release via Github Actions"
          deploymentType: "ROLLING"
          groupId: "Workshop App Release: ${{ github.ref_name }}"
          user: "${{ github.actor }}"

次のステップ

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

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

GitHub Actions で変更を追跡する

入力 .css-21sua1{background:none;border:none;width:0;padding:0;}

使用例

GitHub シークレット

最低限必要なフィールド

すべての入力フィールド

次のステップ

入力