Developer Connect-Statistiken einrichten

In diesem Dokument wird beschrieben, wie Sie Developer Connect-Statistiken einrichten, um sie für Gemini Cloud Assist-Prüfungen und in Cloud Logging verfügbar zu machen.

Weitere Informationen zu Developer Connect-Statistiken.

Hinweis

  1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  2. Verify that billing is enabled for your Google Cloud project.

  3. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  4. Wenn Sie Developer Connect aktivieren, wird auch die Secret Manager API aktiviert.

  5. Installieren Sie die Google Cloud CLI.

    Wenn Sie sie bereits installiert haben, prüfen Sie mit gcloud components update, ob Sie die neueste Version verwenden.

  6. Erstellen Sie den Developer Connect Dienst-Agent:
    gcloud beta services identity create \
    --service=developerconnect.googleapis.com \
    --project=PROJECT_NUM

    Die Rolle roles/developerconnect.serviceAgent wird diesem Dienst-Agent automatisch hinzugefügt.

Erforderliche Rollen

Wenn Ihre Statistikkonfiguration auf eine App Hub-Anwendung beschränkt ist, die von einem Verwaltungsprojekt verwaltet wird (Ordnergrenze):

  • Der Nutzer, der Statistiken konfiguriert , benötigt die folgenden Rollen für das Verwaltungsprojekt:
    • Developer Connect Insights Admin (roles/developerconnect.insightsAdmin)
    • Viewer von App Hub (roles/apphub.viewer)
  • Der Developer Connect Service Agent benötigt die folgenden Rollen:
    • Die Rolle „Developer Connect Service Agent“ (roles/developerconnect.serviceAgent) und die Rolle „Developer Connect Insights Agent“ (roles/developerconnect.insightsAgent) für das Verwaltungsprojekt.
    • Die Rolle „Developer Connect Insights Agent“ (roles/developerconnect.insightsAgent) für den Ordner , der das Verwaltungsprojekt enthält.

Wenn Ihre Statistikkonfiguration auf eine App Hub-Anwendung beschränkt ist, die von einem Hostprojekt verwaltet wird:

  • Der Nutzer, der Statistiken konfiguriert , benötigt die folgenden Rollen für das Hostprojekt:
    • Developer Connect Insights Admin (roles/developerconnect.insightsAdmin)
    • Viewer von App Hub (roles/apphub.viewer)
  • Der Developer Connect Service Agent benötigt die folgenden Rollen:
    • Die Rolle „Developer Connect Service Agent“ (roles/developerconnect.serviceAgent) und die Rolle „Developer Connect Insights Agent“ (roles/developerconnect.insightsAgent) für das Hostprojekt.
    • Die Rolle „Developer Connect Insights Agent“ (roles/developerconnect.insightsAgent) für alle Dienstprojekte.
    • Wenn Sie vorhandene Ressourcen verwenden (z. B. aus Cloud Build oder Artifact Registry), die sich nicht im selben Ordner befinden, gewähren Sie dem Developer Connect Service Agent aus dem Hostprojekt in diesen Projekten die Rolle „Developer Connect Insights Agent“.

Wenn Ihre Statistikkonfiguration auf einzelne Zielprojekte beschränkt ist:

  • Der Nutzer, der Statistiken konfiguriert , benötigt die folgenden Rollen für das Hostprojekt:
    • Developer Connect Insights Admin (roles/developerconnect.insightsAdmin).
  • Der Developer Connect Service Agent benötigt die folgenden Rollen:
    • Die Rolle „Developer Connect Service Agent“ (roles/developerconnect.serviceAgent) und die Rolle „Developer Connect Insights Agent“ (roles/developerconnect.insightsAgent) für das Hostprojekt.
    • Die Rolle „Developer Connect Insights Agent“ (roles/developerconnect.insightsAgent) für alle Zielprojekte.

Um Statistiken über die Befehlszeile aufzurufen, benötigen Nutzer, die Statistiken aufrufen , Folgendes:

  • Die Rolle „Developer Connect Insights Viewer“ (roles/developerconnect.insightsViewer) für das Hostprojekt.
  • Die Rolle „Betrachter von Container Analysis-Vorkommen“ (roles/containeranalysis.occurrences.viewer) für das Hostprojekt.

Für einzelne Tools sind möglicherweise zusätzliche Google Cloud oder nicht von Google stammende Rollen und Berechtigungen erforderlich. Wenn Berechtigungsfehler auftreten, prüfen Sie mit Ihrem Administrator, ob Sie die richtigen Rollen und Berechtigungen haben.

Neben diesen Rollen und Berechtigungen müssen Sie beim Konfigurieren einer neuen Statistikkonfiguration mit dem interaktiven Workflow die Berechtigung haben, auf alle von Ihnen angegebenen Ressourcen zuzugreifen.

Zusätzliche Voraussetzungen

  • Wenn Ihre Developer Connect-Statistiken auf eine App Hub-Anwendung beschränkt sein sollen, müssen Sie diese Anwendung haben oder erstellen.

    Developer Connect-Statistiken unterstützen alle App Hub Einrichtungsmodelle für Anwendungen. Wir empfehlen, einen für die Anwendungsverwaltung konfigurierten Ordner zu verwenden, damit Sie Gemini Cloud Assist und andere anwendungsorientierte Funktionennutzen können.

    Sie können Ihre Developer Connect-Statistiken auch auf ein Projekt beschränken, anstatt auf eine App Hub-Anwendung.

  • Sie müssen Cloud Build und ein unterstütztes Quellcodeverwaltungssystem (GitHub, GitLab oder Bitbucket) verwenden.

  • Ihr Build muss eine Provenienz generieren, damit Provenienzinformationen in die Logs aufgenommen werden können.

    Dies kann aus einer der folgenden Quellen stammen:

    • Verwenden Sie Cloud Build und Artifact Registry.

      Sie können Cloud Build verwenden, um Ihr Image zu erstellen. Der Build muss mit einem Trigger gestartet werden und der Build-Prozess muss eine Provenienz generieren. Von Ihrem Build generierte Artefakte werden in Artifact Registry gespeichert.

    • Verwenden Sie GitHub-Attestierungen.

      Wenn Sie Version 4 oder höher von docker/build-push-action, verwenden, fügt die Aktion Ihrem Image automatisch Provenienz-Attestierungen hinzu.

      Alternativ können Sie die actions/attest-build-provenance mit der Option push-to-registry verwenden, um die Provenienz-Attestierung in der Container Registry zu veröffentlichen. Dort können Developer Connect-Statistiken sie unabhängig von dem Registry-Anbieter lesen.

    • Verwenden Sie das Flag docker buildx provenance.

      Weitere Informationen

    • Verwenden Sie den docker buildx-Registry-Exporter.

      Setzen Sie oci-artifact auf true. Weitere Informationen

    GitHub-Attestierungen müssen aus einem öffentlich verfügbaren Repository stammen. Das docker buildx-Artefakt muss in der Container Registry öffentlich verfügbar sein.

    Sie können Developer Connect-Statistiken auch ohne Provenienz verwenden, aber die Statistiken sind dann weniger nützlich.

  • Gemini Cloud Assist

    Developer Connect-Statistiken verbessern die Gemini Cloud Assist-Funktionen, indem sie dem Prüfungskontext Ereignisse zur Anwendungsbereitstellung hinzufügen. Sie können Gemini Cloud Assist so konfigurieren, dass Developer Connect-Statistiken mit Gemini Cloud Assist-Prüfungen verwendet werden.

  • Wenn Ihre Developer Connect-Statistiken auf eine App Hub-Anwendung beschränkt sind, muss sich Ihre Statistikkonfiguration im selben Projekt wie diese Anwendung befinden.

    Wenn sie nach Projekt beschränkt ist, muss sich die Konfiguration nicht im selben Projekt wie das Projekt im Umfang befinden.

    Es wird empfohlen, dass sich Ihre anderen relevanten Ressourcen (z. B. Developer Connect-Statistiken, Google Kubernetes Engine-Cluster, Cloud Run-Dienste, Cloud Build, Artifact Registry-Repositories) am selben Ort befinden, dies ist jedoch nicht erforderlich.

Beschränkungen

Für Developer Connect-Statistikkonfigurationen gelten die folgenden Beschränkungen:

  • Ein einzelnes Projekt kann maximal 50 Statistikkonfigurationen enthalten.

  • Bei Konfigurationen auf Projektebene können mit einer einzelnen Konfiguration maximal 5 Projekte verfolgt werden.

  • Mit einer einzelnen Statistikkonfiguration können maximal 3.000 Runtimes verfolgt werden.

Anwendung in App Hub erstellen

Dies ist nur relevant, wenn Sie Ihre Developer Connect-Statistiken auf eine App Hub-Anwendung beschränken.

  1. Richten Sie App Hub ein. Wir empfehlen, die Verwendung eines für die Anwendungsverwaltung konfigurierten Ordners , damit Sie Gemini Cloud Assist und andere anwendungsorientierte Funktionennutzen können.

  2. Erstellen Sie eine App Hub-Anwendung.

Developer Connect-Statistiken für Ihre Anwendung konfigurieren

Erstellen Sie mit dem folgenden Befehl eine Developer Connect-Statistik:

gcloud developer-connect insights-configs create DCI_CONFIG_NAME \
       --project PROJECT_ID \
       --app-hub-application APP_HUB_APPLICATION_NAME \
       --target-projects TARGET_PROJECT_IDS \
       --location LOCATION

Wobei:

  • DCI_CONFIG_NAME ist ein Name für die Statistik konfiguration, die generiert wird.

  • PROJECT_ID ist die ID des Projekts, in dem Sie die Developer Connect-Statistikkonfiguration erstellen.

  • APP_HUB_APPLICATION_NAME ist der vollständig qualifizierte Name der zuvor erstellten App Hub-Anwendung zuvor.

    Dies gilt nur, wenn Sie diese Statistikkonfiguration auf eine App Hub-Anwendung und nicht auf ein Projekt beschränken.

  • TARGET_PROJECT_IDS ist die durch Kommas getrennte Liste der IDs der Projekte, auf die Sie diese Developer Connect-Statistik konfiguration beschränken.

    Dies gilt nur, wenn Sie diese Statistikkonfiguration auf Projekte und nicht auf eine App Hub-Anwendung beschränken. Mit einer einzelnen Konfiguration können maximal 5 Projekte verfolgt werden.

  • LOCATION ist die Region, in der Sie diese Statistikkonfiguration erstellen möchten.

Mit diesem Befehl wird ein Prozess zur automatischen Erkennung ausgelöst, der alle App Hub-Arbeitslasten und ‑Dienste in Ihrem Projekt findet. Außerdem wird geprüft, ob Sie die erforderlichen Berechtigungen haben.

Dieser Befehl gibt auch eine OPERATION_ID zurück, mit der Sie den Status der Konfiguration prüfen können.

So prüfen Sie den Status Ihrer Developer Connect-Statistikkonfiguration:

gcloud developer-connect operations describe OPERATION_ID

Dabei ist OPERATION_ID die vollständig angegebene Vorgangs-ID , die vom gcloud developer-connect insights-configs create Befehl zurückgegeben wurde.

Dieser Vorgang ist eine Bestätigung der ursprünglichen Anfrage. Das Feld response darin ist ein Snapshot der Ressource genau in dem Moment, in dem die Erstellungsaufgabe akzeptiert wurde. Führen Sie den Befehl insights-configs describe aus, um den Status des Erkennungsprozesses abzurufen.

Nachdem der Prozess zur automatischen Erkennung abgeschlossen ist, können Sie den Status dieser Developer Connect-Statistik mit dem folgenden Befehl prüfen:

gcloud developer-connect insights-configs describe DCI_CONFIG_NAME \
       --location=REGION

Wobei:

  • DCI_CONFIG_NAME ist der Name, den Sie für den gcloud developer-connect insights-configs create Befehl verwendet haben.

  • REGION ist die Region, in der Sie die Konfiguration erstellt haben.

Nächste Schritte