Build-Logs speichern und verwalten

Wenn Sie Builds ausführen, erfasst und speichert Cloud Build Ihre Build-Logs. Auf dieser Seite wird erläutert, wie Sie Build-Logs speichern, aufrufen und löschen.

Speicherort für Build-Logs auswählen

Sie können Cloud Build so konfigurieren, dass Build-Logs in Cloud Logging oder in Cloud Storage gespeichert werden. Fügen Sie dazu das Feld logging in Ihre Cloud Build-Konfigurationsdatei ein. Wenn Sie in der Build-Konfigurationsdatei kein logging-Feld angeben, speichert Cloud Build sowohl Build-Logs als auch Cloud Storage.

Mit den folgenden Schritten werden Build-Logs nur in Logging gespeichert:

  1. Legen Sie in der Build-Konfigurationsdatei den Wert von logging auf CLOUD_LOGGING_ONLY fest:

    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"
      }
    }
    
  2. Verwenden Sie die Build-Konfigurationsdatei, um einen Build über die Befehlszeile, die API oder über Trigger zu starten.

Build-Logs im von Google erstellten Standard-Bucket speichern

Cloud Build speichert Ihre Build-Logs standardmäßig in einem von Google erstellten Cloud Storage-Bucket. Sie können die in dem von Google erstellten Cloud Storage-Bucket gespeicherten Build-Logs anzeigen, aber keine weiteren Änderungen daran vornehmen. Wenn Sie die volle Kontrolle über Ihren Log-Bucket benötigen, speichern Sie die Logs in einem vom Nutzer erstellten Cloud Storage-Bucket.

Build-Logs in einem vom Nutzer erstellten Bucket speichern

IAM-Berechtigungen:

Zum Speichern von Build-Logs in Ihrem eigenen Cloud Storage-Bucket müssen Sie zuerst die erforderlichen IAM-Berechtigungen für das Dienstkonto, für den Build verwenden:

  • Wenn sich der Cloud Storage-Bucket und Cloud Build im selben Google Cloud-Projekt befinden und Sie das alte Cloud Build-Dienstkonto verwenden, hat Ihr altes Cloud Build-Dienstkonto standardmäßig die erforderlichen IAM-Berechtigungen. Sie müssen keine zusätzlichen Berechtigungen erteilen.

  • In jedem anderen Fall müssen Sie dem Dienstkonto, das Sie die für den Build verwendet werden:

    1. Öffnen Sie die IAM-Seite in dem Projekt, in dem sich Ihr Cloud Storage-Bucket befindet:

      IAM-Seite öffnen

    2. Klicken Sie auf Zugriff erlauben.

    3. Geben Sie die E-Mail-Adresse des Dienstkontos ein.

    4. Wählen Sie Cloud Storage und dann Storage-Administrator aus.

    5. Klicken Sie auf Speichern.

So geben Sie einen Cloud Storage-Bucket zum Speichern von Build-Logs an:

  1. In Ihrem Google Cloud-Projekt Cloud Storage-Bucket erstellen ohne Aufbewahrungsrichtlinie zum Speichern Ihrer Build-Logs.

  2. Fügen Sie der Build-Konfigurationsdatei das Feld logsBucket hinzu, das auf den Cloud Storage-Bucket verweist, den Sie zum Speichern von Build-Logs erstellt haben. Die folgende Build-Konfigurationsdatei enthält eine Anleitung zum Erstellen eines Container-Images und zum Speichern der Build-Logs in einem Bucket namens 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"
           }
        }
    
  3. Verwenden Sie die Build-Konfigurationsdatei, um einen Build über die Befehlszeile, die API oder über Trigger zu starten.

Wenn der Build abgeschlossen ist, speichert Cloud Build die Logs in dem Cloud Storage-Bucket, den Sie in der Build-Konfigurationsdatei angegeben haben.

Build-Logs in einem vom Nutzer verwalteten und regionalisierten Bucket speichern

Standardmäßig speichert Cloud Build Build-Logs in einer von Google angegebenen Region, die sich von dem Standort unterscheiden kann, an dem Sie einen Build ausführen. Mit der Option defaultLogsBucketBehavior können Sie Cloud Build so konfigurieren, dass ein Standard-Log-Bucket in Ihrem eigenen Projekt und in derselben Region wie der Build verwendet wird. Mit dieser Konfiguration haben Sie mehr Kontrolle über den Speicherort Ihrer Protokolldaten. So können Sie die Anforderungen an den Datenstandort besser erfüllen.

Für das Speichern von Protokollen in Ihrem eigenen Projekt fallen Kosten an. Weitere Informationen zu den Preisen finden Sie unter Cloud Storage – Preise.

Cloud Build für die Verwendung regionalisierter, nutzereigener Protokolle konfigurieren:

  1. Gewähren Sie die erforderlichen IAM-Berechtigungen.

    • Wenn Sie das Cloud Build-Legacy-Dienstkonto verwenden, hat es standardmäßig die erforderlichen IAM-Berechtigungen. Sie müssen keine zusätzlichen Berechtigungen erteilen.

    • Gewähren Sie dem Nutzer für andere Dienstkonten die Rolle Storage Admin. Dienstkonto, das Sie für den Build verwenden. Anweisungen zum Gewähren eines Rolle zu einem Dienstkonto zugewiesen sind, siehe Rollen für den Projekt.

  2. Fügen Sie in der Build-Konfiguration die Option defaultLogsBucketBehavior hinzu und legen Sie den Wert auf REGIONAL_USER_OWNED_BUCKET fest:

    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"
        }
    }
    
  3. Verwenden Sie die Build-Konfigurationsdatei, um einen Build über die Befehlszeile, die API oder über Trigger zu starten.

    Wenn Sie den Build ausführen, erstellt Cloud Build den neuen Log-Bucket in der Region, in der Sie den Build ausführen, und speichert dann die Build-Logs für diesen Bucket. Für nachfolgende Builds im selben Projekt und in derselben Region wird standardmäßig der vorhandene Bucket verwendet.

Wenn Sie die Option defaultLogsBucketBehavior festlegen und dann Builds in mehreren Regionen erstellen, erstellt Cloud Build mehrere Buckets für Ihre Build-Logs.

Regionalisierte Build-Logs, die in Ihrem eigenen Projekt gespeichert sind, haben keine Aufbewahrungsrichtlinie. Diese Einstellung kann nicht geändert werden.

Vorrang zwischen den Protokolleinstellungen

Wenn Sie die Option defaultLogsBucketBehavior einer vorhandenen Build-Konfigurationsdatei hinzufügen und zuvor die Optionen logging oder logsBucket konfiguriert haben, empfehlen wir, diese Einstellungen zu löschen, um Konflikte zwischen den Einstellungen zu vermeiden.

Die defaultLogsBucketBehavior funktioniert insbesondere nicht, wenn Sie Folgendes konfiguriert haben:

  • logging: CLOUD_LOGGING_ONLY, um Ihre Build-Logs in Cloud Logging zu speichern.
  • logging: NONE, um das Logging zu deaktivieren.

Wenn Sie einen Build ohne Logging-Optionen in der Build-Konfiguration ausführen, legt Cloud Build logging: LEGACY fest und speichert Logs im von Google erstellten Cloud Storage-Standard-Bucket. Wenn Sie defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET hinzufügen, überschreibt diese Option logging: LEGACY.

Build-Logs anzeigen

IAM-Berechtigungen:

  • Wenn sich Ihre Build-Logs in Logging befinden, gewähren Sie den Hauptkonten, die die Build-Logs einsehen möchten, die Rolle Log-Betrachter für das Projekt, in dem der Build konfiguriert ist:

    1. Zur Seite "IAM":

      Seite "IAM" öffnen

    2. Wählen Sie Ihr Projekt aus und klicken Sie auf Öffnen.

    3. Suchen Sie in der Berechtigungstabelle nach der E-Mail-ID des Hauptkontos und klicken Sie auf das Stiftsymbol.

    4. Wählen Sie die Rolle Logging > Log-Betrachter aus.

    5. Klicken Sie auf Speichern.

  • Wenn sich Ihre Build-Logs im von Google erstellten Cloud Storage-Standard-Bucket befinden, weisen Sie Hauptkonten, die Build-Logs ansehen möchten, die Rolle Projektbetrachter für das Projekt zu, in dem der Build konfiguriert ist:

    1. Zur Seite "IAM":

      Seite "IAM" öffnen

    2. Wählen Sie Ihr Projekt aus und klicken Sie auf Öffnen.

    3. Suchen Sie in der Berechtigungstabelle nach der E-Mail-ID des Hauptkontos und klicken Sie auf das Stiftsymbol.

    4. Wählen Sie Projekt und dann Betrachter aus.

    5. Klicken Sie auf Speichern.

    Wenn sich Ihre Build-Logs in einem vom Nutzer erstellten oder vom Nutzer verwalteten Cloud Storage-Bucket befinden, weisen Sie Hauptkonten, die Build-Logs ansehen möchten, die Rolle Storage-Objekt-Betrachter zu:

    1. Zur Seite "IAM":

      Seite "IAM" öffnen

    2. Wählen Sie Ihr Projekt aus und klicken Sie auf Öffnen.

    3. Suchen Sie in der Berechtigungstabelle nach der E-Mail-ID des Hauptkontos und klicken Sie auf das Stiftsymbol.

    4. Wählen Sie die Rolle Cloud Storage und dann Storage-Objekt-Betrachter aus.

    5. Klicken Sie auf Speichern.

So rufen Sie Build-Logs in Cloud Build auf:

Console

  1. Öffnen Sie in der Google Cloud Console die Seite „Cloud Build“.

    Zur Seite "Cloud Build"

  2. Wählen Sie Ihr Projekt aus und klicken Sie auf Öffnen.

  3. Wählen Sie im Drop-down-Menü Region die Region für Ihren Build aus.

  4. Klicken Sie auf der Seite Build-Verlauf auf einen bestimmten Build.

  5. Klicken Sie auf der Seite Build-Details unter Schritte auf Build-Zusammenfassung, um Build-Logs für den gesamten Build aufzurufen, oder klicken Sie auf einen Build-Schritt, um Build-Logs für diesen Schritt aufzurufen.

    Grafik: Screenshot der Build-Logs auf der Seite "Build-Details"

  6. Wenn Ihre Logs in Logging gespeichert sind, klicken Sie im Bereich Build-Log auf das Symbol , um die Logs im Log-Explorer aufzurufen.

    Screenshot von Build-Logs im Log-Explorer

gcloud

Führen Sie den Befehl gcloud builds log aus, wobei build-id die ID des Builds ist, für den Sie Build-Logs abrufen möchten. Die Build-ID wird am Ende des Übermittlungsprozesses für den Build angezeigt, wenn Sie gcloud builds submit ausführen, oder in der ID-Spalte, wenn Sie gcloud builds list ausführen.

gcloud builds log build-id

So rufen Sie Build-Logs in GitHub und GitHub Enterprise auf:

Wenn Sie einen GitHub- oder GitHub Enterprise-Trigger erstellen und --include-logs-with-status als Option angeben, können Sie Ihre Build-Protokolle in GitHub und GitHub Enterprise aufrufen.

So rufen Sie Build-Logs in GitHub und GitHub Enterprise auf:

  1. Rufen Sie das Repository auf, das mit Ihrem Trigger verknüpft ist.

  2. Rufen Sie die Liste der Commits auf.

  3. Suchen Sie die Zeile des Commits, für den Sie die Build-Logs aufrufen möchten.

  4. Klicken Sie in der Zeile Ihres Commits auf das Ergebnissymbol.

    Es wird eine Liste der Prüfungen angezeigt, die mit Ihrem Commit verknüpft sind.

  5. Klicken Sie in der Zeile, für die Sie Build-Logs aufrufen möchten, auf Details.

    Die Seite Zusammenfassung für den Commit wird angezeigt. Wenn Sie einen Trigger mit dem Flag --include-logs-with-status erstellt haben, werden Ihre Build-Protokolle im Bereich Details angezeigt.

Build-Logs löschen

Sie können keine Build-Logs im von Google erstellten Log-Bucket löschen.

So löschen Sie Build-Logs in einem vom Nutzer erstellten Log-Bucket:

  1. Gewähren Sie dem Nutzer oder dem Dienstkonto, das Logs löscht, die Rolle Storage Object Admin.

  2. Löschen Sie die Build-Logs gemäß der Anleitung zum Löschen von Cloud Storage-Objekten unter Objekte löschen.

So löschen Sie den vom Nutzer erstellten Log-Bucket:

  1. Weisen Sie dem Nutzer oder dem Dienstkonto, das den Log-Bucket löscht, die Rolle Storage-Administrator zu.

  2. Löschen Sie den Log-Bucket unter Verwendung der Anleitung zum Löschen von Buckets.

Nächste Schritte