Skip to main content

デバッグ ログを有効にする

ワークフロージョブあるいはステップが期待どおりに動作しない理由を診断する上で、十分な詳細がワークフローのログになかった場合、追加のデバッグロギングを有効化できます。

これらの追加ログは、ワークフローを含むリポジトリにシークレットを設定することで有効になるため、同じ権限要件が適用されます。

  • 個人アカウントのリポジトリにシークレットを作成するには、そのリポジトリのオーナーでなければなりません。 組織リポジトリのシークレットを作成するには、admin アクセス権が必要です。
  • 個人アカウントのリポジトリの環境でシークレットを作成するには、リポジトリの所有者である必要があります。 組織リポジトリに環境のシークレットを作成するには、admin アクセス権が必要です。
  • 組織レベルでシークレットを作成するには、admin アクセス権が必要です。
  • REST APIを使ってシークレットを作成するには、リポジトリへの書き込みアクセス権もしくはOrganizationへの管理アクセス権を持っていなければなりません。 詳細については、「GitHub Actions のシークレット API」を参照してください。

シークレットの設定について詳しくは、「暗号化されたシークレットの作成と利用」をご覧ください。

さらに、ワークフローを実行するアクセス権を持つすべてのユーザーが、ランナー診断ログとステップ デバッグ ログを有効にして、ワークフローを再実行できます。 詳しくは、「ワークフローとジョブの再実行」をご覧ください。

ランナーの診断ロギングの有効化

ランナーの診断ログは、ランナーによるジョブの実行の様子に関する情報を含む追加のログファイルを提供します。 ログアーカイブには、2つのログファイルが追加されます。

  • ランナープロセスログにはジョブの実行のためのランナーの調整とセットアップに関する情報が含まれます。
  • ワーカープロセスログには、ジョブの実行が記録されます。
  1. ランナー診断ログを有効にするには、ワークフローを含むリポジトリでシークレット ACTIONS_RUNNER_DEBUGtrue に設定します。

  2. ランナーの診断ログをダウンロードするには、ワークフローの実行のログアーカイブをダウンロードしてください。 ランナーの診断ログは runner-diagnostic-logs フォルダーにあります。 ログのダウンロードについて詳しくは、「ログのダウンロード」をご覧ください。

ステップのデバッグロギングの有効化

ステップデバッグロギングは、ジョブの実行の間と実行後のジョブのログの詳細度を高めます。

  1. ステップ デバッグ ログを有効化するには、ワークフローを含むリポジトリでシークレット ACTIONS_STEP_DEBUGtrue に設定する必要があります。

  2. このシークレットを設定すると、ステップログにより多くのデバッグイベントが示されるようになります。 詳しくは、「ログを表示してエラーを診断する」をご覧ください。