ビルドログを保存、管理する

ビルドを実行すると、Cloud Build がビルドログを収集して保存します。このページでは、ビルドログを保存、表示、削除する方法について説明します。

ビルドログの保存場所を選択する

ビルドログを Cloud Logging または Cloud Storage に保存するように Cloud Build を構成するには、Cloud Build 構成ファイルに logging フィールドを追加します。ビルド構成ファイルで logging フィールドを指定しない場合、Cloud Build はビルドログを Logging と Cloud Storage の両方に保存します。

次の手順では、ビルドログを Logging にのみ保存します。

ビルド構成ファイルで、logging の値を CLOUD_LOGGING_ONLY に設定します。

YAML

steps:
- name: 'gcr.io/cloud-builders/docker'
  args: ['build', '-t', 'us-east1-docker.pkg.dev/myproject/myimage', '.']
options:
  logging: CLOUD_LOGGING_ONLY

JSON

{
  "steps": [
  {
    "name": "gcr.io/cloud-builders/docker",
    "args": [
      "build",
      "-t",
      "us-east1-docker.pkg.dev/myproject/myimage",
      "."
    ]
  }
  ],
  "options": {
    "logging": "CLOUD_LOGGING_ONLY"
  }
}

ビルド構成ファイルを使用して、コマンドライン、API、またはトリガーでビルドを開始します。

ビルドログフィールドをログエントリフィールドにマッピングする

ビルドログが Logging に送信されるときに、指定されたビルドログフィールドが LogEntry フィールドにマッピングされるように、ビルドログの JSON を構成できます。たとえば、ビルドログに message が含まれている場合、生成されたログエントリの textPayload または jsonPayload.message にメッセージが表示されます。マッピングできないビルドログフィールドは、ログエントリ jsonPayload に表示されます。

ビルドログでフィールドマッピングを有効にするには、BuildOptions フィールドの enableStructuredLogging を TRUE に設定します。

次の表に、ログエントリフィールドにマッピングされるビルドログフィールドを示します。

BuildLog フィールド（JSON） LogEntry フィールド説明メモ

BuildLog フィールド（JSON）	LogEntry フィールド	説明	メモ
`message`	`textPayload` または `jsonPayload.message`	ユーザーがログメッセージを設定できるようにする	文字列にする必要があります。マッピング可能なフィールドのみがビルドログに含まれている場合、`textPayload` にメッセージが表示されます。それ以外の場合は、`jsonPayload.message` にメッセージが表示されます。ビルドログに複数のステップが含まれている場合、ステップ ID がメッセージの先頭に表示されます。
`severity`	`severity`	ユーザーがログの重大度を設定できるようにします。	`LogSeverity` の列挙型にする必要があります。

message

textPayload または jsonPayload.message

ユーザーがログメッセージを設定できるようにする

文字列にする必要があります。

マッピング可能なフィールドのみがビルドログに含まれている場合、textPayload にメッセージが表示されます。それ以外の場合は、jsonPayload.message にメッセージが表示されます。

ビルドログに複数のステップが含まれている場合、ステップ ID がメッセージの先頭に表示されます。

severity severity ユーザーがログの重大度を設定できるようにします。 LogSeverity の列挙型にする必要があります。

次のビルドログフィールドはマッピングできないため、ビルドログに表示されている場合はログエントリから削除されます。

httpRequest
logging.googleapis.com/insertId
logging.googleapis.com/labels
logging.googleapis.com/operation
logging.googleapis.com/sourceLocation
logging.googleapis.com/spanId
logging.googleapis.com/trace
logging.googleapis.com/trace_sampled
time
timestamp
timestampSeconds
timestampNanos

他のビルドログフィールドはすべて、ログエントリの jsonPayload の一部として表示されます。

Google が作成したデフォルトバケットへのビルドログの保存

デフォルトでは、Cloud Build は Google が作成した Cloud Storage バケットにビルドログを保存します。Google が作成した Cloud Storage バケットでビルドログストアを表示できますが、それ以外の変更はできません。ログバケットを完全に制御する必要がある場合は、ユーザー作成の Cloud Storage バケットにログを保存します。

ユーザーが作成したバケットへのビルドログの保存

IAM の権限:

独自の Cloud Storage バケットにビルドログを保存するには、まずビルドに使用しているサービスアカウントに必要な IAM 権限を付与する必要があります。

Cloud Storage バケットと Cloud Build が同じ Google Cloud プロジェクト内にあり、Cloud Build の従来のサービスアカウントを使用している場合、Cloud Build の従来のサービスアカウントには必要な IAM 権限がデフォルトで付与されています。別途権限を付与する必要はありません。
それ以外の場合は、ビルドに使用しているサービスアカウントにストレージ管理者のロールを付与します。
1. Cloud Storage バケットが配置されているプロジェクトの [IAM] ページを開きます。
  
  [IAM] ページを開く
2. [アクセス権を付与] をクリックします。
3. サービスアカウントのメールアドレスを入力します。
4. [Cloud Storage] > [Storage Admin] を選択します。
5. [保存] をクリックします。

ビルドログを保存する Cloud Storage バケットを指定するには:

Google Cloud プロジェクトで、保持ポリシーを設定せずに、ビルドログを保存する Cloud Storage バケットを作成します。

ビルド構成ファイルに、ビルドログを保存するために作成した Cloud Storage バケットを指す logsBucket フィールドを追加します。次のビルド構成ファイルの例では、コンテナイメージをビルドし、ビルドログを mylogsbucket という名前のバケットに保存します。

YAML

    steps:
    - name: 'gcr.io/cloud-builders/docker'
      args: [ 'build', '-t', 'us-east1-docker.pkg.dev/myproject/myimage', '.' ]
    logsBucket: 'gs://mylogsbucket'
    options:
      logging: GCS_ONLY

JSON

    {
      "steps": [
       {
         "name": "gcr.io/cloud-builders/docker",
         "args": [
           "build",
           "-t",
           "us-east1-docker.pkg.dev/myproject/myimage",
           "."
         ]
       }
       ],
       "logsBucket": "gs://mylogsbucket",
       "options": {
         "logging": "GCS_ONLY"
       }
    }

ビルド構成ファイルを使用して、コマンドライン、API、またはトリガーでビルドを開始します。

ビルドが完了すると、Cloud Build はビルド構成ファイルで指定した Cloud Storage バケットにログを保存します。

ユーザー所有のリージョン化されたバケットへのビルドログの保存

デフォルトでは、Cloud Build は Google 指定のリージョンにビルドログを保存します。このリージョンは、ビルドを実行するロケーションとは異なる場合があります。defaultLogsBucketBehavior オプションを使用すると、ビルドと同じリージョンに、独自のプロジェクト内でデフォルトのログバケットを使用するように Cloud Build を構成できます。この構成では、ログデータのロケーションをより細かく制御できるため、データ所在地に関する要件を遵守できます。

独自のプロジェクトにログを保存すると費用が発生します。価格設定の詳細については、Cloud Storage の料金体系をご覧ください。

リージョン化されたユーザー所有のログを使用するように Cloud Build を構成します。

必要な IAM 権限を付与します。
- Cloud Build の従来のサービスアカウントを使用している場合、Cloud Build の従来のサービスアカウントには必要な IAM 権限がデフォルトで付与されています。別途権限を付与する必要はありません。
- 他のサービスアカウントの場合は、ビルドに使用しているサービスアカウントにストレージ管理者のロールを付与します。サービスアカウントにロールを付与する手順については、プロジェクトでのロールの付与をご覧ください。

ビルド構成で、defaultLogsBucketBehavior オプションを追加し、その値を REGIONAL_USER_OWNED_BUCKET に設定します。

YAML

steps:
- name: 'gcr.io/cloud-builders/docker'
  args: [ 'build', '-t', 'us-central1-docker.pkg.dev/myproject/myrepo/myimage', '.' ]
options:
  defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET

JSON

{
  "steps": [
    {
      "name": "gcr.io/cloud-builders/docker",
      "args": [
        "build",
        "-t",
        "us-central1-docker.pkg.dev/myproject/myrepo/myimage",
        "."
      ]
    }
    ],
    "options": {
      "defaultLogsBucketBehavior": "REGIONAL_USER_OWNED_BUCKET"
    }
}

ビルド構成ファイルを使用して、コマンドライン、API、またはトリガーでビルドを開始します。

ビルドを実行すると、Cloud Build はビルドを実行しているリージョンに新しいログバケットを作成し、そのバケットにビルドログを保存します。同じプロジェクトとリージョンでの後続のビルドでは、デフォルトで既存のバケットが使用されます。

defaultLogsBucketBehavior オプションを設定して複数のリージョンでビルドを作成すると、Cloud Build はビルドログ用に複数のバケットを作成します。

独自のプロジェクトに保存されるリージョン化されたビルドログには保持ポリシーがありません。この設定は変更できません。

ログ設定間の優先度

既存のビルド構成ファイルに defaultLogsBucketBehavior オプションを追加する場合、以前に logging オプションまたは logsBucket オプションを構成している場合は、設定の競合を防ぐために、それらの設定を削除することをおすすめします。

具体的には、次の設定では、defaultLogsBucketBehavior は機能しません。

ビルドログを Cloud Logging に保存する logging: CLOUD_LOGGING_ONLY。
ロギングをオフにする logging: NONE。

ビルド構成でロギングオプションを設定せずにビルドを実行すると、Cloud Build は logging: LEGACY を設定し、Google が作成したデフォルトの Cloud Storage バケットにログを保存します。defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET を追加すると、このオプションは logging: LEGACY をオーバーライドします。

ビルドログを表示

IAM の権限:

ビルドログが Logging にある場合、ビルドログを表示したいプリンシパルにビルドが構成されているプロジェクトのログ閲覧者のロールを付与します。
1. [IAM] ページを開きます。
  
  [IAM] ページを開く
2. プロジェクトを選択し、[開く] をクリックします。
3. 権限の表でプリンシパルのメール ID を探し、鉛筆アイコンをクリックします。
4. [Logging] > [ログ閲覧者] ロールを選択します。
5. [保存] をクリックします。
ビルドログが Google 作成のデフォルトの Cloud Storage バケットに存在する場合、ビルドログを表示したいプリンシパルに、ビルドが構成されているプロジェクトのプロジェクト閲覧者ロールを付与します。
1. [IAM] ページを開きます。
  
  [IAM] ページを開く
2. プロジェクトを選択し、[開く] をクリックします。
3. 権限の表でプリンシパルのメール ID を探し、鉛筆アイコンをクリックします。
4. [プロジェクト] > [閲覧者] のロールを選択します。
5. [保存] をクリックします。
注: プロジェクトオーナーとプロジェクト編集者のロールでは、デフォルトの Cloud Storage バケットからビルドログを表示することもできます。これは、オーナーのロールには編集者のロールの権限が含まれ、編集者のロールには閲覧者のロールの権限が含まれるためです。デフォルトの Cloud Storage バケットでビルドログを表示するには、最小権限のセキュリティ原則に準拠するためにプロジェクト閲覧者ロールを付与することをおすすめします。
注: 基本のプロジェクト閲覧者ロールを付与しないようにするには、ユーザー指定のバケットにビルドログを保存します。特に、トリガーによってビルドが起動し、付与するアクセスがビルドの起動とビルドの進捗状況の表示のみである場合は、この方法をおすすめします。
ビルドログがユーザー作成またはユーザー所有の Cloud Storage バケットに存在する場合、ビルドログを表示させたいプリンシパルにストレージオブジェクト閲覧者のロールを付与します。
1. [IAM] ページを開きます。
  
  [IAM] ページを開く
2. プロジェクトを選択し、[開く] をクリックします。
3. 権限の表でプリンシパルのメール ID を探し、鉛筆アイコンをクリックします。
4. [Cloud Storage] > [Storage Object Viewer] のロールを選択します。
5. [保存] をクリックします。

Cloud Build でビルドログを表示するには:

コンソール

Google Cloud Console で Cloud Build ページを開きます。

Cloud Build ページを開く
プロジェクトを選択し、[開く] をクリックします。
[リージョン] プルダウンメニューで、ビルドのリージョンを選択します。
[ビルド履歴] ページで、特定のビルドをクリックします。
[ビルドの詳細] ページの [ステップ] で、[ビルドの概要] をクリックしてビルド全体のビルドログを表示するか、ビルドステップをクリックして対象のステップのビルドログを表示します。
ログが Logging に保存されている場合は、[ビルドログ] パネルでアイコンをクリックしてログエクスプローラでログを表示します。

gcloud

gcloud builds log コマンドを実行します。ここで、build-id はビルドログを取得するビルドの ID です。ビルド ID は、gcloud builds submit の実行時にビルド送信プロセスの最後に表示されるか、gcloud builds list の実行時に ID 列に表示されます。

gcloud builds log build-id

GitHub と GitHub Enterprise でビルドログを表示するには:

GitHub トリガーまたは GitHub Enterprise トリガーを作成し、オプションとして --include-logs-with-status を指定した場合、GitHub と GitHub Enterprise でビルドログを表示できます。

GitHub と GitHub Enterprise でビルドログを表示するには:

トリガーに関連付けられているリポジトリに移動します。
commit のリストに移動します。
ビルドログを表示する commit の行を見つけます。
commit の行にある結果アイコンをクリックします。

commit に関連付けられているチェックのリストが表示されます。
ビルドログを表示する行の [詳細] をクリックします。

commit に関連付けられている [概要] ページが表示されます。--include-logs-with-status フラグを使用してトリガーを作成した場合、ページの [詳細] セクションにビルドログが表示されます。

ビルドログを削除する

Google が作成したログバケットからビルドログを削除することはできません。

ユーザー作成のログバケットからビルドログを削除する場合は、以下の手順に従います。

ログを削除するユーザーまたはサービスアカウントにストレージオブジェクト管理者のロールを付与します。
オブジェクトの削除に記載の Cloud Storage オブジェクトを削除する手順に従って、ビルドログを削除します。

ユーザー作成のログバケットを削除するには、以下の手順に従います。

ログバケットを削除するユーザーまたはサービスアカウントにストレージ管理者のロールを付与します。
バケットの削除に記載のバケットを削除するための手順に従い、ログバケットを削除します。

次のステップ

Cloud Build によって作成される監査ログについて学習する。
ビルド結果を表示する方法を学習する。
Build Cloud IAM 権限の詳細を確認する。

ビルドログを保存、管理する

ビルドログの保存場所を選択する

YAML

JSON

ビルドログ フィールドをログエントリ フィールドにマッピングする

Google が作成したデフォルト バケットへのビルドログの保存

ユーザーが作成したバケットへのビルドログの保存

YAML

JSON

ユーザー所有のリージョン化されたバケットへのビルドログの保存

YAML

JSON

ログ設定間の優先度

ビルドログを表示

コンソール

gcloud

ビルドログを削除する

次のステップ

ビルドログフィールドをログエントリフィールドにマッピングする

Google が作成したデフォルトバケットへのビルドログの保存