Synthetischen Monitor erstellen

Console

Wenn Sie einen synthetischen Monitor mit der Google Cloud Console erstellen, wird eine neue Cloud Run-Funktion (2. Generation) bereitgestellt und der Monitor für diese Cloud Run-Funktion erstellt. Sie können keinen synthetischen Monitor erstellen, der eine vorhandene Cloud Run-Funktion überwacht.

1. Achten Sie darauf, dass Sie die erforderlichen APIs aktiviert haben, dass Ihr Projekt ein Compute Engine-Standarddienstkonto enthält und dass diesem Konto die Rolle „Bearbeiter“ (roles/editor) zugewiesen wurde. Weitere Informationen finden Sie unter Vorab.

2. Rufen Sie in der Google Cloud Console die Seite  Synthetisches Monitoring auf:

   Gehen Sie zu Synthetisches Monitoring.

   Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

3. Wählen Sie Synthetischen Monitor erstellen aus.

4. Wählen Sie die Vorlage für Ihre Cloud Run-Funktion aus:

   • Benutzerdefinierter synthetischer Monitor: Verwenden Sie diese Vorlage, wenn Sie Protokolldaten oder Ablaufdaten für ausgehende HTTP-Anfragen erfassen möchten.

   • Mocha-Synthetischer Monitor: Verwenden Sie diese Vorlage, wenn Sie Mocha-Test-Suites schreiben.

   • Vorlage zum Prüfen auf fehlerhafte Links: Mit dieser Vorlage können Sie einen URI und eine konfigurierbare Anzahl von Links testen, die unter diesem URI gefunden werden. Informationen zu den Feldern für diesen Prüfer finden Sie unter Link-Checker erstellen.

5. Geben Sie einen Namen für den Monitor ein.

6. Optional: Aktualisieren Sie die Antwortzeitüberschreitung und die Prüfzeitraum und fügen Sie benutzerdefinierte Labels hinzu.

7. Führen Sie einen der folgenden Schritte aus:

   • Wenn Sie in diesem Projekt Zugriff auf Gemini Code Assist haben und Hilfe beim Schreiben Ihres Codes benötigen, klicken Sie auf Hilfe beim Coden. Diese Funktion befindet sich in der öffentlichen Vorschau. Weitere Informationen zu Prompts finden Sie unter Prompts für synthetische Monitore schreiben.

     Wenn Sie mit dem Code zufrieden sind, klicken Sie auf In Cloud-Funktion einfügen.

   • Klicken Sie auf Funktion erstellen.

8. Gehen Sie im Dialogfeld „Cloud Run-Funktion“ so vor:

   1. Geben Sie einen Anzeigenamen ein und wählen Sie eine Region aus. Namen dürfen innerhalb einer Region nur einmal vorkommen.

   2. Führen Sie im Abschnitt Laufzeit, Build, Verbindungen und Sicherheitseinstellungen die folgenden Schritte aus:

      • Prüfen Sie die Standardeinstellungen und aktualisieren Sie sie bei Bedarf.

      • Wählen Sie im Feld Laufzeitdienstkonto ein Dienstkonto aus.

   3. Bearbeiten Sie den generierten Code oder schreiben oder laden Sie Code für Ihre Cloud Run-Funktion hoch:

      • Wenn Sie den generierten Code bearbeiten, eigenen Code eingeben oder die Standardbeispielfunktion laden möchten, wählen Sie Inline-Editor aus. Die Beispielfunktion, die von der zuvor ausgewählten Vorlage abhängt, sendet eine Anfrage an eine bestimmte URL. Sie können die Standardfunktion ändern.

      • Wenn Sie eine ZIP-Datei von Ihrem lokalen System laden möchten, wählen Sie ZIP-Upload aus.

        Wenn Sie eine ZIP-Datei von Ihrem lokalen System hochladen, müssen Sie auch einen Cloud Storage-Bucket für die ZIP-Datei angeben. Wenn Sie keinen geeigneten Cloud Storage-Bucket haben, erstellen Sie einen.

      • Wenn Sie eine ZIP-Datei aus Cloud Storage laden möchten, wählen Sie ZIP-Datei aus Cloud Storage, den Speicher-Bucket und dann die ZIP-Datei aus, die Sie laden möchten.

        Sie können eine Cloud Run-Funktion auch über die Seiten „Cloud Run-Funktionen“ in der Google Cloud Console erstellen. Wenn Sie einen synthetischen Monitor erstellen möchten, der eine Kopie dieser Cloud Run-Funktion überwacht, rufen Sie den Tab Quelle auf und klicken Sie auf ZIP-Datei herunterladen. Sie können die ZIP-Datei dann hochladen.

   4. Klicken Sie auf Funktion anwenden.

9. Konfigurieren Sie die Benachrichtigungsrichtlinie:

   1. Optional: Aktualisieren Sie den Namen der Benachrichtigungsrichtlinie und die Dauer des Fehlers, bevor Benachrichtigungen gesendet werden.

   2. Fügen Sie die Benachrichtigungskanäle hinzu.

10. Klicken Sie auf Erstellen.

    Die von Ihnen definierte Cloud Run-Funktion wird als Cloud Run-Funktion der 2. Generation erstellt und bereitgestellt. Der synthetische Monitor wird erstellt.

gcloud

Wenn Sie einen synthetischen Monitor mit der Google Cloud CLI oder der Cloud Monitoring API erstellen, übergeben Sie den Funktionsnamen an den API-Aufruf. Daher können Sie nur einen synthetischen Monitor erstellen, der eine vorhandene Cloud Run-Funktion überwacht.

1. Achten Sie darauf, dass Sie die erforderlichen APIs aktiviert haben, dass Ihr Projekt ein Compute Engine-Standarddienstkonto enthält und dass diesem Konto die Rolle „Bearbeiter“ (roles/editor) zugewiesen wurde. Weitere Informationen finden Sie unter Vorab.
2. Cloud Run-Funktion der 2. Generation schreiben und bereitstellen

   So stellen Sie beispielsweise das synthetics-sdk-nodejs-Beispiel im Repository Google Cloud/synthetics-sdk-nodejs bereit:

   1. Klonen Sie das Repository und rufen Sie den Speicherort des Quellcodes auf:

      git clone https://github.com/GoogleCloudPlatform/synthetics-sdk-nodejs.git
      cd synthetics-sdk-nodejs/samples/generic-synthetic-nodejs
      

   2. Stellen Sie die Cloud Run-Funktion mit dem Befehl gcloud functions deploy bereit:

      gcloud functions deploy FUNCTION_NAME \
      --gen2 --region="us-west2" --source="." \
      --entry-point=SyntheticFunction --trigger-http --runtime=nodejs18
      

      Führen Sie im Befehl gcloud functions deploy folgende Schritte aus:

      • Der Wert des Felds FUNCTION_NAME muss innerhalb der Bereitstellungsregion eindeutig sein.

      • Fügen Sie das Flag --gen2 hinzu und legen Sie die Bereitstellungsregion fest.

      • Legen Sie das Feld --entry-point so fest:

        • Mocha: SyntheticMochaSuite
        • Nicht Mocha: SyntheticFunction.

      • Setzen Sie das Feld --runtime auf nodejs18.

      • Fügen Sie das Flag --trigger-http ein.

      • Legen Sie das Feld --ingress-settings fest, wenn Sie nicht die Standardeinstellung verwenden möchten, bei der der gesamte Traffic zugelassen wird.

      Cloud Run-Funktionen erstellen und stellen Ihre Cloud Run-Funktion bereit. Die Ergebnisse des Google Cloud CLI-Befehls enthalten Informationen zur Funktion, einschließlich ihres voll qualifizierten Namens:

      name: projects/PROJECT_ID/locations/REGION/functions/FUNCTION_NAME
      

      Weitere Informationen zum Bereitstellen einer Funktion finden Sie unter Cloud Run-Funktion bereitstellen.

   Verwenden Sie den Befehl gcloud functions list, um die Cloud Run-Funktionen in Ihrem Google Cloud-Projekt aufzulisten:

   gcloud functions list
   

   Die Antwort auf diesen Aufruf besteht aus Listeneinträgen, in denen jeweils eine Cloud Run-Funktion aufgeführt ist:

   NAME: function-1
   STATE: ACTIVE
   TRIGGER: HTTP Trigger
   REGION: us-west2
   ENVIRONMENT: 2nd gen
   

   Wenn Sie den vollqualifizierten Namen für eine bestimmte Cloud Run-Funktion ermitteln möchten, führen Sie den Befehl gcloud monitoring uptime describe aus.

3. Führen Sie den Befehl gcloud monitoring uptime create aus, um den synthetischen Monitor zu erstellen:

   gcloud monitoring uptime create DISPLAY_NAME --synthetic-target=TARGET
   

   Führen Sie vor dem Ausführen des vorherigen Befehls die folgenden Schritte aus:

   • Ersetzen Sie DISPLAY_NAME durch den Namen des synthetischen Monitors.
   • Ersetzen Sie TARGET durch den vollständig qualifizierten Namen Ihrer Cloud Run-Funktion.

4. Erstellen Sie eine Benachrichtigungsrichtlinie.

   Aufgrund der Komplexität der Konfiguration von Benachrichtigungsrichtlinien empfehlen wir, die Seite Synthetische Monitore in der Google Cloud Console aufzurufen und die Optionen zum Erstellen einer Benachrichtigungsrichtlinie zu verwenden. Bei diesem Ansatz werden die meisten Felder der Benachrichtigungsrichtlinie für Sie ausgefüllt. Wenn Sie die Benachrichtigungsrichtlinie mit der Google Cloud Console erstellen möchten, klicken Sie auf der Seite Synthetische Monitore auf Richtlinie erstellen.

   Wenn Sie die Google Cloud CLI oder die Cloud Monitoring API verwenden möchten, konfigurieren Sie den Filter der Bedingung so:

   "filter": "resource.type = \"cloud_run_revision\" AND
               metric.type = \"monitoring.googleapis.com/uptime_check/check_passed\" AND
               metric.labels.check_id = \"CHECK_ID\"",
   

   Die Bedingung überwacht die Zeitreihe uptime_check/check_passed, die von Ihrem synthetischen Monitor geschrieben wird. Ersetzen Sie CHECK_ID durch die Kennung des synthetischen Monitors, die in den Antwortdaten eines Befehls vom Typ „create“ enthalten ist.

   Informationen zum Erstellen einer Benachrichtigungsrichtlinie finden Sie unter Benachrichtigungsrichtlinien mit der API erstellen.

API

Wenn Sie einen synthetischen Monitor mit der Google Cloud CLI oder der Cloud Monitoring API erstellen, übergeben Sie den Funktionsnamen an den API-Aufruf. Daher können Sie nur einen synthetischen Monitor erstellen, der eine vorhandene Cloud Run-Funktion überwacht.

1. Achten Sie darauf, dass Sie die erforderlichen APIs aktiviert haben, dass Ihr Projekt ein Compute Engine-Standarddienstkonto enthält und dass diesem Konto die Rolle „Bearbeiter“ (roles/editor) zugewiesen wurde. Weitere Informationen finden Sie unter Vorab.
2. Cloud Run-Funktion der 2. Generation schreiben und bereitstellen

   So stellen Sie beispielsweise das synthetics-sdk-nodejs-Beispiel im Repository Google Cloud/synthetics-sdk-nodejs bereit:

   1. Klonen Sie das Repository und rufen Sie den Speicherort des Quellcodes auf:

      git clone https://github.com/GoogleCloudPlatform/synthetics-sdk-nodejs.git
      cd synthetics-sdk-nodejs/samples/generic-synthetic-nodejs
      

   2. Stellen Sie die Cloud Run-Funktion mit dem Befehl gcloud functions deploy bereit:

      gcloud functions deploy FUNCTION_NAME \
      --gen2 --region="us-west2" --source="." \
      --entry-point=SyntheticFunction --trigger-http --runtime=nodejs18
      

      Führen Sie im Befehl gcloud functions deploy folgende Schritte aus:

      • Der Wert des Felds FUNCTION_NAME muss innerhalb der Bereitstellungsregion eindeutig sein.

      • Fügen Sie das Flag --gen2 hinzu und legen Sie die Bereitstellungsregion fest.

      • Legen Sie das Feld --entry-point so fest:

        • Mocha: SyntheticMochaSuite
        • Nicht Mocha: SyntheticFunction.

      • Setzen Sie das Feld --runtime auf nodejs18.

      • Fügen Sie das Flag --trigger-http ein.

      • Legen Sie das Feld --ingress-settings fest, wenn Sie nicht die Standardeinstellung verwenden möchten, bei der der gesamte Traffic zugelassen wird.

      Cloud Run-Funktionen erstellen und stellen Ihre Cloud Run-Funktion bereit. Die Ergebnisse des Google Cloud CLI-Befehls enthalten Informationen zur Funktion, einschließlich ihres voll qualifizierten Namens:

      name: projects/PROJECT_ID/locations/REGION/functions/FUNCTION_NAME
      

      Weitere Informationen zum Bereitstellen einer Funktion finden Sie unter Cloud Run-Funktion bereitstellen.

   Verwenden Sie den Befehl gcloud functions list, um die Cloud Run-Funktionen in Ihrem Google Cloud-Projekt aufzulisten:

   gcloud functions list
   

   Die Antwort auf diesen Aufruf besteht aus Listeneinträgen, in denen jeweils eine Cloud Run-Funktion aufgeführt ist:

   NAME: function-1
   STATE: ACTIVE
   TRIGGER: HTTP Trigger
   REGION: us-west2
   ENVIRONMENT: 2nd gen
   

   Wenn Sie den vollqualifizierten Namen für eine bestimmte Cloud Run-Funktion ermitteln möchten, führen Sie den Befehl gcloud monitoring uptime describe aus.

3. So erstellen Sie einen synthetischen Monitor:

   1. Klicken Sie auf projects.uptimeCheckConfigs.create, um die API-Referenzseite für die Methode zu öffnen.
   2. Klicken Sie auf Ausprobieren, um den APIs Explorer zu öffnen.

   3. Legen Sie die Werte für die folgenden Felder fest und führen Sie dann den Befehl aus.

      • Übergeordnetes Feld: projects/PROJECT_ID.

      • Geben Sie im Anfragetext Folgendes an:

        • displayName: Legen Sie den Anzeigenamen für den synthetischen Monitor fest.
        • syntheticMonitor: Muss den voll qualifizierten Namen Ihrer Cloud Run-Funktion enthalten.

      Bei Erfolg sieht die Antwort des API-Aufrufs in etwa so aus:

      {
      "name": "projects/myproject/uptimeCheckConfigs/17272586127463315332",
      "displayName": "MyMonitor",
      ...
      "syntheticMonitor": {
       "cloudFunctionV2": {
          "name": "projects/myproject/locations/us-west2/functions/function-1",
          "cloudRunRevision": {
          "type": "cloud_run_revision",
          "labels": {
             "project_id": "myproject",
             "configuration_name": "",
             "location": "us-west2",
             "revision_name": "",
             "service_name": "function-1"
          }
          }
       }
      }
      }
      

4. Erstellen Sie eine Benachrichtigungsrichtlinie.

   Aufgrund der Komplexität der Konfiguration von Benachrichtigungsrichtlinien empfehlen wir, die Seite Synthetische Monitore in der Google Cloud Console aufzurufen und die Optionen zum Erstellen einer Benachrichtigungsrichtlinie zu verwenden. Bei diesem Ansatz werden die meisten Felder der Benachrichtigungsrichtlinie für Sie ausgefüllt. Wenn Sie die Benachrichtigungsrichtlinie mit der Google Cloud Console erstellen möchten, klicken Sie auf der Seite Synthetische Monitore auf Richtlinie erstellen.

   Wenn Sie die Google Cloud CLI oder die Cloud Monitoring API verwenden möchten, konfigurieren Sie den Filter der Bedingung so:

   "filter": "resource.type = \"cloud_run_revision\" AND
               metric.type = \"monitoring.googleapis.com/uptime_check/check_passed\" AND
               metric.labels.check_id = \"CHECK_ID\"",
   

   Die Bedingung überwacht die Zeitreihe uptime_check/check_passed, die von Ihrem synthetischen Monitor geschrieben wird. Ersetzen Sie CHECK_ID durch die Kennung des synthetischen Monitors, die in den Antwortdaten eines Befehls vom Typ „create“ enthalten ist.

   Informationen zum Erstellen einer Benachrichtigungsrichtlinie finden Sie unter Benachrichtigungsrichtlinien mit der API erstellen.

Terraform

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle. Weitere Informationen finden Sie in der Anbieterreferenzdokumentation zu Terraform.

So erstellen Sie einen synthetischen Monitor und eine Benachrichtigungsrichtlinie für diese Prüfung:

1. Achten Sie darauf, dass Sie die erforderlichen APIs aktiviert haben, dass Ihr Projekt ein Compute Engine-Standarddienstkonto enthält und dass diesem Konto die Rolle „Bearbeiter“ (roles/editor) zugewiesen wurde. Weitere Informationen finden Sie unter Vorab.

2. Bearbeiten Sie Ihre Terraform-Konfigurationsdatei, fügen Sie eine google_storage_bucket-Ressource hinzu und wenden Sie die Änderungen an.

   Der folgende Code definiert einen Cloud Storage-Bucket am Speicherort US:

   resource "google_storage_bucket" "gcf_source" {
      name = "gcf-v2-source-9948673986912-us"
      location = "US"
      uniform_bucket_level_access = true
   }
   

3. Bearbeiten Sie Ihre Terraform-Konfigurationsdatei, fügen Sie eine google_storage_bucket_object-Ressource hinzu und wenden Sie die Änderungen an.

   Die Ressource gibt den Namen des Objekts in Ihrem Bucket und den Speicherort der ZIP-Datei auf Ihrem lokalen System an. Wenn Sie beispielsweise den folgenden Code anwenden, wird Ihrem Speicher-Bucket eine Datei mit dem Namen example-function.zip hinzugefügt:

   resource "google_storage_bucket_object" "object" {
      name = "example-function.zip"
      bucket = google_storage_bucket.gcf_source.name
      source = "generic-synthetic-node.js.zip"
   }
   

4. Bearbeiten Sie Ihre Terraform-Konfigurationsdatei, fügen Sie eine google_cloudfunctions2_function-Ressource hinzu und wenden Sie die Änderungen an.

   Achten Sie darauf, dass in Ihrer google_cloudfunctions2_function-Ressource eine Node.js-Laufzeit und der von synthetischen Monitoren verwendete Einstiegspunkt angegeben sind. Wenn Sie beispielsweise den folgenden Code anwenden, wird eine Funktion mit dem Namen sm-central1 bereitgestellt:

   resource "google_cloudfunctions2_function" "central1" {
      name = "sm-central1"
      location = "us-central1"
   
      build_config {
         runtime = "nodejs20"
         entry_point = "SyntheticFunction"
         source {
               storage_source {
                  bucket = google_storage_bucket.gcf_source.name
                  object = google_storage_bucket_object.object.name
               }
         }
      }
   
      service_config {
         max_instance_count = 1
         available_memory = "256Mi"
         timeout_seconds  = 60
      }
   }
   

5. Wenn Sie einen synthetischen Monitor erstellen möchten, bearbeiten Sie Ihre Terraform-Konfigurationsdatei, fügen Sie eine google_monitoring_uptime_check_config-Ressource hinzu und wenden Sie die Änderungen an.

   Geben Sie für diese Ressource den Block synthetic_monitor an:

   resource "google_monitoring_uptime_check_config" "synthetic" {
      display_name = "sm-central1"
      timeout = "30s"
   
      synthetic_monitor {
         cloud_function_v2 {
               name = google_cloudfunctions2_function.central1.id
         }
      }
   }
   

6. Optional: Erstellen Sie einen Benachrichtigungskanal und eine Benachrichtigungsrichtlinie.

   In den folgenden Schritten wird beschrieben, wie Sie mit der Google Cloud Console den Benachrichtigungskanal und die Benachrichtigungsrichtlinie erstellen. So wird sichergestellt, dass die Benachrichtigungsrichtlinie nur die Daten überwacht, die von Ihrem synthetischen Monitor generiert werden.

   1. So erstellen Sie einen Benachrichtigungskanal:

      1. Rufen Sie in der Google Cloud Console die Seite notifications Benachrichtigungen auf:

         Zu Benachrichtigungen

         Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

      2. Wählen Sie Benachrichtigungskanäle verwalten aus.
      3. Rufen Sie den Kanaltyp auf, den Sie hinzufügen möchten, klicken Sie auf Hinzufügen und füllen Sie das Dialogfeld aus.

   2. So erstellen Sie eine Benachrichtigungsrichtlinie:

      1. Rufen Sie in der Google Cloud Console die Seite  Synthetisches Monitoring auf:

         Gehen Sie zu Synthetisches Monitoring.

         Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

      2. Suchen Sie den synthetischen Monitor, wählen Sie more_vert Mehr und dann Benachrichtigungsrichtlinie hinzufügen aus.
      3. Gehen Sie im Dialogfeld zum Bereich Benachrichtigungen und Name, maximieren Sie Benachrichtigungskanäle und treffen Sie Ihre Auswahl.
      4. Geben Sie einen Namen für die Benachrichtigungsrichtlinie ein und klicken Sie dann auf Richtlinie erstellen.