Öffentliche Verfügbarkeitsdiagnosen erstellen

In diesem Dokument wird beschrieben, wie Sie eine öffentliche Verfügbarkeitsdiagnose erstellen. Bei einer öffentlichen Verfügbarkeitsdiagnose können Anfragen von mehreren Standorten auf der ganzen Welt an öffentlich verfügbare URLs oder Google Cloud-Ressourcen gesendet werden, um festzustellen, ob die Ressource antwortet. Informationen zum Erstellen von Verfügbarkeitsdiagnosen für private Netzwerke finden Sie unter Private Verfügbarkeitsdiagnosen erstellen.

Öffentliche Verfügbarkeitsdiagnosen können die Verfügbarkeit der folgenden überwachten Ressourcen ermitteln:

Links zu Informationen zum Verwalten und Überwachen von Verfügbarkeitsdiagnosen finden Sie im Abschnitt Weitere Informationen dieses Dokuments.

Verfügbarkeitsdiagnosen

Bei HTTP und HTTPS werden allen URL-Weiterleitungen gefolgt und die endgültige Antwort, die die Verfügbarkeitsdiagnose empfängt, wird zur Bewertung von Erfolgskriterien verwendet. Bei HTTPS-Prüfungen wird die Ablaufzeit des SSL-Zertifikats basierend auf dem Serverzertifikat berechnet, das in der endgültigen Antwort empfangen wurde.

Damit eine Verfügbarkeitsdiagnose erfolgreich ist, müssen die folgenden Bedingungen erfüllt sein:

  • Der HTTP-Status muss den von Ihnen angegebenen Kriterien entsprechen.
  • Die Antwortdaten haben keinen erforderlichen Inhalt oder der erforderliche Inhalt ist vorhanden.

Bei Verfügbarkeitsdiagnosen werden keine Seiten-Assets geladen oder JavaScript ausgeführt. Außerdem enthält die Standardkonfiguration einer Verfügbarkeitsdiagnose keine Authentifizierung.

Hinweise

  1. Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für Ihr Projekt zu gewähren, damit Sie die Berechtigungen erhalten, die Sie zum Erstellen von Verfügbarkeitsdiagnosen benötigen:

    • Monitoring Editor (roles/monitoring.editor) – Nutzer der Google Cloud Console
    • Bearbeiter von Konfigurationen für Verfügbarkeitsdiagnosen (roles/monitoring.uptimeCheckConfigEditor) – API-Nutzer
    • Editor für Monitoring-Benachrichtigungsrichtlinien (roles/monitoring.alertPolicyEditor) – API-Nutzer
    • Bearbeiter von Monitoring-Benachrichtigungskanälen (roles/monitoring.notificationChannelEditor) – API-Nutzer

    Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

    Möglicherweise können Sie die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

  2. Prüfen Sie, ob die Ressource, die Sie prüfen möchten, entweder einen öffentlichen Endpunkt hat oder sich hinter einer konfigurierbaren Firewall befindet.

    Für alle anderen Konfigurationen müssen Sie eine private Verfügbarkeitsdiagnose erstellen. Weitere Informationen finden Sie unter Private Verfügbarkeitsdiagnosen erstellen.

  3. Wenn sich die Ressource hinter einer Firewall befindet, konfigurieren Sie diese so, dass eingehender Traffic von den IP-Adressen der Verfügbarkeitsdiagnose-Server zugelassen wird. Weitere Informationen finden Sie unter IP-Adressen des Servers für die Verfügbarkeitsdiagnose auflisten.

  4. Konfigurieren Sie die Benachrichtigungskanäle, die Sie zum Empfangen von Benachrichtigungen verwenden möchten. Wir empfehlen, mehrere Arten von Benachrichtigungskanälen zu erstellen. Weitere Informationen finden Sie unter Benachrichtigungskanäle erstellen und verwalten.

  5. Ermitteln Sie mindestens drei Prüfungen für die Verfügbarkeitsdiagnose. Die Region für Verfügbarkeitsdiagnosen USA umfasst die Regionen USA_OREGON, USA_IOWA und USA_VIRGINIA. Jede der USA_*-Regionen hat eine Prüfung und USA umfasst alle drei. Die anderen Verfügbarkeitsdiagnose-Regionen EUROPE, SOUTH_AMERICA und ASIA_PACIFIC haben jeweils eine Diagnose.

    Wenn Sie in der Google Cloud Console Global oder in der API REGION_UNSPECIFIED auswählen, werden Verfügbarkeitsdiagnosen aus allen Regionen für Verfügbarkeitsdiagnosen ausgegeben.

Verfügbarkeitsdiagnose erstellen

In diesem Abschnitt wird das Erstellen und Konfigurieren von Verfügbarkeitsdiagnosen erläutert.

Folgen Sie dieser Anleitung, um eine Verfügbarkeitsdiagnose für einen externen Load-Balancer zu erstellen, für den mindestens ein TCP- oder HTTP/s-Port konfiguriert ist. Alternativ können Sie für den Dienst die Seite Dienstdetails aufrufen und dann auf Verfügbarkeitsdiagnose erstellen klicken. Auf der Seite Dienstdetails werden die dienstspezifischen Felder automatisch ausgefüllt.

Console

So erstellen Sie eine Verfügbarkeitsdiagnose mit der Google Cloud Console:

  1. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und dann  Verfügbarkeitsdiagnosen aus:

    Verfügbarkeitsdiagnosen aufrufen

  2. Klicken Sie auf Verfügbarkeitsdiagnose erstellen.

    Dialogfeld zum Erstellen einer Verfügbarkeitsdiagnose

  3. Geben Sie das Ziel der Verfügbarkeitsdiagnose an:

    1. Wählen Sie das Protokoll aus. Sie können HTTP, HTTPS oder TCP auswählen.

    2. Wählen Sie einen der folgenden Ressourcentypen aus:

      • URL: Eine IPv4-Adresse oder ein Hostname. Pfad und Port werden separat eingegeben.
      • Kubernetes LoadBalancer Service: Kubernetes-Service vom Typ LoadBalancer.
      • Instanz: Compute Engine- oder AWS EC2-Instanzen.
      • App Engine: Google App Engine-Anwendungen (Module)
      • Elastic Load Balancer: AWS-Lastenausgleichsmodul
    3. Füllen Sie die protokollspezifischen Felder aus:

      • Geben Sie für TCP-Prüfungen den Port ein.

      • Für HTTP- und HTTPS-Prüfungen können Sie einen Pfad auf Ihrem Host oder in Ihrer Ressource eingeben. Alle Verfügbarkeitsdiagnosen, die diese Protokolle verwenden, senden eine Anfrage an http://target/path. In diesem Ausdruck ist target für eine URL-Ressource ein Hostname oder eine IP-Adresse. Bei einer App Engine-Ressource ist target ein Hostname, der vom Dienstnamen abgeleitet wird. Für Instanz- und Load-Balancer-Ressourcen ist target eine IP-Adresse, die von dem Namen abgeleitet wird, den Sie für die Ressource oder die Gruppe von Ressourcen angegeben haben.

        Wenn Sie das Feld path leer lassen oder den Wert auf / setzen, wird die Anfrage an http://target/ gesendet.

        Wenn Sie beispielsweise eine Verfügbarkeitsdiagnose für die URL-Ressource example.com/tester ausgeben möchten, setzen Sie das Feld Hostname auf example.com und das Feld Pfad auf /tester.

        Angenommen, Sie haben einen Server in App Engine mit einem Disponenten bereitgestellt, der / und /hello unterstützt. Lassen Sie das Feld Path leer, um die Verfügbarkeitsdiagnose an den Handler "/" auszugeben. Wenn Sie die Verfügbarkeitsdiagnose an den Handler /hello senden möchten, setzen Sie den Wert des Felds Pfad auf /hello.

    4. Geben Sie die ressourcenspezifischen Felder ein:

      • Geben Sie für URL-Ressourcen den Hostnamen in das Feld Hostname ein. Geben Sie beispielsweise example.com ein.

      • Geben Sie für App Engine-Ressourcen den Dienstnamen in das Feld Dienst ein.

      • Füllen Sie für die Ressourcen Elastic Load Balancer und Instanz das Feld Gilt für so aus:

        • Wenn Sie eine Verfügbarkeitsdiagnose für eine einzelne Instanz oder einen einzelnen Load-Balancer ausgeben möchten, wählen Sie Einzeln aus und verwenden Sie dann das Menü, um die spezifische Instanz oder den jeweiligen Load-Balancer auszuwählen.
        • Wenn Sie eine Verfügbarkeitsdiagnose an eine Monitoring-Gruppe senden möchten, wählen Sie Gruppe und dann im Menü den Gruppennamen aus.
    5. Optional: Legen Sie mit dem Feld Prüfungshäufigkeit fest, wie oft die Verfügbarkeitsdiagnose ausgeführt werden soll.

    6. Optional: Klicken Sie auf Weitere Zieloptionen, um Prüfregionen auszuwählen oder SSL-Zertifikate, Authentifizierung, Header und Ports für HTTP- und HTTPS-Prüfungen zu konfigurieren:

      • Regionen: Wählen Sie die Regionen aus, in denen die Verfügbarkeitsdiagnosen Anfragen erhalten sollen. Eine Verfügbarkeitsdiagnose muss mindestens drei Prüfungen haben. Es gibt eine Prüfung in allen Regionen außer USA. Diese hat drei Diagnosen. Die Standardeinstellung Global umfasst alle Regionen.
      • ICMP-Pings: Konfigurieren Sie die Verfügbarkeitsdiagnose so, dass bis zu drei Pings gesendet werden. Weitere Informationen finden Sie unter ICMP-Pings verwenden.
      • Anfragemethode: Wählen Sie bei HTTP-Prüfungen die Anfragemethode aus.
      • Text: Geben Sie bei HTTP-POST-Prüfungen den URL-codierten Text ein. Sie müssen die Codierung selbst vornehmen. Bei allen anderen Prüfungen lassen Sie dieses Feld leer.
      • Host-Header: Füllen Sie dieses Feld aus, um virtuelle Hosts zu prüfen. Dieses Feld ist für TCP-Diagnosen nicht verfügbar.
      • Port: Geben Sie eine Portnummer an.
      • Benutzerdefinierte Header: Geben Sie benutzerdefinierte Header an und verschlüsseln Sie sie bei Bedarf. Durch die Verschlüsselung werden die Werte des Headers im Formular ausgeblendet. Verwenden Sie die Verschlüsselung für Header im Zusammenhang mit der Authentifizierung, die für andere nicht sichtbar sein sollen.

      • Authentication (Authentifizierung): Geben Sie einen Nutzernamen und ein Passwort an. Diese Werte werden als Autorisierungsheader gesendet. Wenn Sie hier Werte festlegen, geben Sie keinen Autorisierungsheader an. Wenn Sie hingegen einen Autorisierungsheader angeben, legen Sie hier keine Werte fest. Passwörter werden im Formular immer ausgeblendet. Dieses Feld ist für TCP-Diagnosen nicht verfügbar.

      • SSL-Zertifikatvalidierung: Wenn Sie für eine URL-Ressource HTTPS ausgewählt haben, versucht der Dienst standardmäßig, eine Verbindung über HTTPS herzustellen und das SSL-Zertifikat zu validieren. Verfügbarkeitsdiagnosen schlagen fehl, wenn eine URL ein ungültiges Zertifikat hat. Mögliche Gründe für ein ungültiges Zertifikat:

        • Abgelaufenes Zertifikat
        • Ein selbst signiertes Zertifikat
        • Ein Zertifikat mit einem nicht übereinstimmenden Domainnamen
        • Ein Zertifikat, das die Erweiterung „Authority Information Access“ (AIA) verwendet.

        Wählen Sie SSL-Zertifikate validieren aus, um eine HTTPS-Verfügbarkeitsdiagnose zur Validierung des SSL-Zertifikats zu erzwingen.

        Deaktivieren Sie die Option SSL-Zertifikate validieren, um die SSL-Zertifikatsvalidierung zu deaktivieren.

        Wenn Sie SSL-Zertifikate mit AIA-Erweiterungen haben, müssen Sie die SSL-Zertifikatsvalidierung deaktivieren. Diese Zertifikatstypen werden nicht unterstützt und schlagen die Validierungssequenz fehl. In der Regel lautet die Fehlermeldung "Antwort mit SSL-Handshake-Fehler in 10.000 ms".

        Sie können den Messwert monitoring.googleapis.com/uptime_check/time_until_ssl_cert_expires verwenden, um eine Benachrichtigung zu erstellen, die Sie benachrichtigt, bevor Ihr Zertifikat abläuft. Weitere Informationen finden Sie unter Beispielrichtlinien: Richtlinie zur Verfügbarkeitsdiagnose.

        Klicken Sie das Kästchen SSL-Zertifikate prüfen an.

  4. Klicken Sie auf Weiter und konfigurieren Sie die Antwortanforderungen. Alle Einstellungen in diesem Abschnitt haben Standardwerte:

    • Im Feld Antwortzeitlimit können Sie das Zeitlimit für die Verfügbarkeitsdiagnose ändern. Eine Verfügbarkeitsdiagnose schlägt fehl, wenn innerhalb dieses Zeitraums keine Antwort von mehr als einem Standort empfangen wird.

    • Wenn Sie die Verfügbarkeitsdiagnose für den Inhaltsabgleich konfigurieren möchten, muss die Ein/Aus-Schaltfläche Inhaltsabgleich ist aktiviert lauten:

      • Wählen Sie im Optionsmenü die Option Response Content Match Type (Keyword-Option für Antwort) aus. Dieses Feld bestimmt, wie der Antwortinhalt mit den zurückgegebenen Daten verglichen wird. Angenommen, der Antwortinhalt ist abcd und der Übereinstimmungstyp für den Inhalt ist Enthält. Die Verfügbarkeitsdiagnose ist nur erfolgreich, wenn die Antwortdaten abcd enthalten. Weitere Informationen finden Sie unter Antwortdaten validieren.
      • Geben Sie den Antwortinhalt ein. Der Antwortinhalt darf ein String sein, der nicht länger als 1.024 Byte ist. In der API ist dieses Feld das Objekt ContentMatcher.
    • Löschen Sie Logprüfungsfehler, um zu verhindern, dass Logeinträge aufgrund von Verfügbarkeitsdiagnosen erstellt werden.

    • Konfigurieren Sie für die HTTP-Verfügbarkeitsdiagnosen die zulässigen Antwortcodes. Standardmäßig markieren HTTP-Verfügbarkeitsdiagnosen jede 2xx-Antwort als erfolgreiche Antwort.

  5. Klicken Sie auf Weiter und konfigurieren Sie Warnungen und Benachrichtigungen.

    Wenn Sie bei Fehlschlagen einer Verfügbarkeitsdiagnose benachrichtigt werden möchten, erstellen Sie eine Benachrichtigungsrichtlinie und konfigurieren Sie Benachrichtigungskanäle für diese Richtlinie:

    1. Optional: Aktualisieren Sie den Namen der Benachrichtigungsrichtlinie.
    2. Optional: Wählen Sie im Feld Duration aus, wie lange die Verfügbarkeitsdiagnosen fehlschlagen müssen, bevor Benachrichtigungen gesendet werden. Standardmäßig werden Benachrichtigungen gesendet, wenn mindestens zwei Regionen mindestens eine Minute lang fehlgeschlagene Verfügbarkeitsdiagnosen melden.
    3. Klicken Sie im Feld Benachrichtigungskanäle auf Menü, wählen Sie die hinzuzufügenden Kanäle aus und klicken Sie dann auf OK.

      Im Menü sind die Benachrichtigungskanäle für jeden Kanaltyp alphabetisch gruppiert.

    Wenn Sie keine Benachrichtigungsrichtlinie erstellen möchten, muss der Text der Ein/Aus-Schaltfläche Keine Benachrichtigung erstellen lauten.

  6. Klicken Sie auf Weiter und schließen Sie die Verfügbarkeitsdiagnose ab:

    1. Geben Sie einen aussagekräftigen Titel für die Verfügbarkeitsdiagnose ein.

    2. Optional: So fügen Sie der Verfügbarkeitsdiagnose benutzerdefinierte Labels hinzu:

      1. Klicken Sie auf Nutzerlabels anzeigen.
      2. Geben Sie im Feld Schlüssel einen Namen für das Label ein. Labelnamen müssen mit einem Kleinbuchstaben beginnen und können Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Geben Sie beispielsweise severity ein.
      3. Geben Sie im Feld Wert einen Wert für das Label ein. Labelwerte können Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Geben Sie beispielsweise critical ein.
      4. Klicken Sie für jedes zusätzliche Label auf Nutzerlabel hinzufügen und geben Sie dann den Schlüssel und den Wert des Labels ein.
    3. Klicken Sie auf Test (Testen), um die Konfiguration der Verfügbarkeitsdiagnose zu prüfen. Wenn das Ergebnis nicht Ihren Erwartungen entspricht, lesen Sie den Abschnitt Diagnosefehler, korrigieren Sie Ihre Konfiguration und wiederholen Sie den Bestätigungsschritt.

    4. Klicken Sie auf Erstellen. Wenn Sie Erstellen auswählen und ein Pflichtfeld nicht ausgefüllt ist, wird eine Fehlermeldung angezeigt.

gcloud

Führen Sie zum Erstellen der Verfügbarkeitsdiagnose den Befehl gcloud monitoring uptime create aus:

gcloud monitoring uptime create DISPLAY_NAME REQUIRED_FLAGS OPTIONAL_FLAGS

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

  • Ersetzen Sie DISPLAY_NAME durch den Namen der Verfügbarkeitsdiagnose.

  • Konfigurieren Sie den REQUIRED_FLAGS, um die von der Verfügbarkeitsdiagnose geprüfte Ressource anzugeben. Mit dem folgenden Befehl wird beispielsweise eine Verfügbarkeitsdiagnose erstellt, mit der die URL EXAMPLE.com für ein bestimmtes Projekt getestet wird:

    gcloud monitoring uptime create DISPLAY_NAME \
    --resource-labels=host=EXAMPLE.com,project_id=PROJECT_ID \
    --resource-type=uptime_url
    

    Der vorherige Befehl gibt Werte für jedes Label an, das vom Ressourcentyp uptime_url benötigt wird.

  • Konfigurieren Sie die OPTIONAL_FLAGS-Flags so, dass Standardwerte überschrieben werden. Beispielsweise müssen Sie das Flag --protocol festlegen, wenn das Protokoll nicht http ist.

API

Rufen Sie zum Erstellen einer Verfügbarkeitsdiagnose die Methode projects.uptimeCheckConfigs.create auf. Legen Sie die Parameter der Methode so fest:

  • parent: Erforderlich. Dies muss der Name des Projekts sein, in dem die Verfügbarkeitsdiagnose erstellt werden soll. Ersetzen Sie PROJECT_ID durch Ihre Google Cloud-Projekt-ID. Das Format dafür ist:

    projects/PROJECT_ID
    
  • Der Anfragetext muss ein UptimeCheckConfig-Objekt für die neue Verfügbarkeitsdiagnose enthalten. Auf dieser Seite finden Sie Informationen zu einigen Feldern. Eine vollständige Dokumentation zu diesem Objekt und seinen Feldern finden Sie unter UptimeCheckConfig:

    • Lassen Sie das Feld name des Konfigurationsobjekts leer. Das System legt dieses Feld fest, wenn es das Antwortkonfigurationsobjekt erstellt.

    • Wenn Sie eine HTTP- oder HTTPS-Prüfung konfigurieren, müssen Sie das Feld HttpCheck des Objekts UptimeCheckConfig ausfüllen. Legen Sie in diesem Objekt das Feld requestMethod auf GET oder POST fest. Wenn dieses Feld ausgelassen oder auf METHOD_UNSPECIFIED gesetzt wird, wird eine GET-Anfrage ausgegeben.

      Wenn Sie eine POST-Anfrage konfigurieren, füllen Sie die Felder contentType, das optionale customContentType und body aus.

Die Methode create gibt das Objekt UptimeCheckConfig für die neue Konfiguration zurück.

Wenn die erstellte Verfügbarkeitskonfiguration nicht wie erwartet funktioniert, lesen Sie den Abschnitt Diagnosefehler auf dieser Seite.

C#

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

public static object CreateUptimeCheck(string projectId, string hostName,
    string displayName)
{
    // Define a new config.
    var config = new UptimeCheckConfig()
    {
        DisplayName = displayName,
        MonitoredResource = new MonitoredResource()
        {
            Type = "uptime_url",
            Labels = { { "host", hostName } }
        },
        HttpCheck = new UptimeCheckConfig.Types.HttpCheck()
        {
            Path = "/",
            Port = 80,
        },
        Timeout = TimeSpan.FromSeconds(10).ToDuration(),
        Period = TimeSpan.FromMinutes(5).ToDuration()
    };
    // Create a client.
    var client = UptimeCheckServiceClient.Create();
    ProjectName projectName = new ProjectName(projectId);
    // Create the config.
    var newConfig = client.CreateUptimeCheckConfig(
        projectName,
        config,
        CallSettings.FromExpiration(
            Expiration.FromTimeout(
                TimeSpan.FromMinutes(2))));
    Console.WriteLine(newConfig.Name);
    return 0;
}

Java

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

private static void createUptimeCheck(
    String projectId, String displayName, String hostName, String pathName) throws IOException {
  CreateUptimeCheckConfigRequest request =
      CreateUptimeCheckConfigRequest.newBuilder()
          .setParent(ProjectName.format(projectId))
          .setUptimeCheckConfig(
              UptimeCheckConfig.newBuilder()
                  .setDisplayName(displayName)
                  .setMonitoredResource(
                      MonitoredResource.newBuilder()
                          .setType("uptime_url")
                          .putLabels("host", hostName))
                  .setHttpCheck(HttpCheck.newBuilder().setPath(pathName).setPort(80))
                  .setTimeout(Duration.newBuilder().setSeconds(10))
                  .setPeriod(Duration.newBuilder().setSeconds(300)))
          .build();
  try (UptimeCheckServiceClient client = UptimeCheckServiceClient.create()) {
    UptimeCheckConfig config = client.createUptimeCheckConfig(request);
    System.out.println("Uptime check created: " + config.getName());
  } catch (Exception e) {
    usage("Exception creating uptime check: " + e.toString());
    throw e;
  }
}

Go

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.


// createGet creates an example uptime check on a GET request.
func createGet(w io.Writer, projectID string) (*monitoringpb.UptimeCheckConfig, error) {
	ctx := context.Background()
	client, err := monitoring.NewUptimeCheckClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewUptimeCheckClient: %w", err)
	}
	defer client.Close()
	req := &monitoringpb.CreateUptimeCheckConfigRequest{
		Parent: "projects/" + projectID,
		UptimeCheckConfig: &monitoringpb.UptimeCheckConfig{
			DisplayName: "new GET uptime check",
			Resource: &monitoringpb.UptimeCheckConfig_MonitoredResource{
				MonitoredResource: &monitoredres.MonitoredResource{
					Type: "uptime_url",
					Labels: map[string]string{
						"host": "example.com",
					},
				},
			},
			CheckRequestType: &monitoringpb.UptimeCheckConfig_HttpCheck_{
				HttpCheck: &monitoringpb.UptimeCheckConfig_HttpCheck{
					RequestMethod: monitoringpb.UptimeCheckConfig_HttpCheck_GET,
					Path:          "/",
					Port:          80,
				},
			},
			Timeout: &duration.Duration{Seconds: 10},
			Period:  &duration.Duration{Seconds: 300},
		},
	}
	config, err := client.CreateUptimeCheckConfig(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("CreateUptimeCheckConfig GET: %w", err)
	}
	fmt.Fprintf(w, "Successfully created GET uptime check %q\n", config.GetDisplayName())
	return config, nil
}

// createPost creates an example uptime check on a POST request.
func createPost(w io.Writer, projectID string) (*monitoringpb.UptimeCheckConfig, error) {
	ctx := context.Background()
	client, err := monitoring.NewUptimeCheckClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewUptimeCheckClient: %w", err)
	}
	defer client.Close()
	req := &monitoringpb.CreateUptimeCheckConfigRequest{
		Parent: "projects/" + projectID,
		UptimeCheckConfig: &monitoringpb.UptimeCheckConfig{
			DisplayName: "new POST uptime check",
			Resource: &monitoringpb.UptimeCheckConfig_MonitoredResource{
				MonitoredResource: &monitoredres.MonitoredResource{
					Type: "uptime_url",
					Labels: map[string]string{
						"host": "example.com",
					},
				},
			},
			CheckRequestType: &monitoringpb.UptimeCheckConfig_HttpCheck_{
				HttpCheck: &monitoringpb.UptimeCheckConfig_HttpCheck{
					RequestMethod: monitoringpb.UptimeCheckConfig_HttpCheck_POST,
					ContentType:   monitoringpb.UptimeCheckConfig_HttpCheck_URL_ENCODED,
					Path:          "/",
					Port:          80,
					Body:          []byte(base64.URLEncoding.EncodeToString([]byte("key: value"))),
				},
			},
			Timeout: &duration.Duration{Seconds: 10},
			Period:  &duration.Duration{Seconds: 300},
		},
	}
	config, err := client.CreateUptimeCheckConfig(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("CreateUptimeCheckConfig POST: %w", err)
	}
	fmt.Fprintf(w, "Successfully created POST uptime check %q\n", config.GetDisplayName())
	return config, nil
}

Node.js

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

// Imports the Google Cloud client library
const monitoring = require('@google-cloud/monitoring');

// Creates a client
const client = new monitoring.UptimeCheckServiceClient();

/**
 * TODO(developer): Uncomment and edit the following lines of code.
 */
// const projectId = 'YOUR_PROJECT_ID';
// const hostname = 'mydomain.com';

const request = {
  // i.e. parent: 'projects/my-project-id'
  parent: client.projectPath(projectId),
  uptimeCheckConfig: {
    displayName: 'My Uptime Check',
    monitoredResource: {
      // See the Uptime Check docs for supported MonitoredResource types
      type: 'uptime_url',
      labels: {
        host: hostname,
      },
    },
    httpCheck: {
      path: '/',
      port: 80,
    },
    timeout: {
      seconds: 10,
    },
    period: {
      seconds: 300,
    },
  },
};

// Creates an uptime check config for a GCE instance
const [uptimeCheckConfig] = await client.createUptimeCheckConfig(request);
console.log('Uptime check created:');
console.log(`ID: ${uptimeCheckConfig.name}`);
console.log(`Display Name: ${uptimeCheckConfig.displayName}`);
console.log('Resource: %j', uptimeCheckConfig.monitoredResource);
console.log('Period: %j', uptimeCheckConfig.period);
console.log('Timeout: %j', uptimeCheckConfig.timeout);
console.log(`Check type: ${uptimeCheckConfig.check_request_type}`);
console.log(
  'Check: %j',
  uptimeCheckConfig.httpCheck || uptimeCheckConfig.tcpCheck
);
console.log(
  `Content matchers: ${uptimeCheckConfig.contentMatchers
    .map(matcher => matcher.content)
    .join(', ')}`
);
console.log(`Regions: ${uptimeCheckConfig.selectedRegions.join(', ')}`);

PHP

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

use Google\Api\MonitoredResource;
use Google\Cloud\Monitoring\V3\Client\UptimeCheckServiceClient;
use Google\Cloud\Monitoring\V3\CreateUptimeCheckConfigRequest;
use Google\Cloud\Monitoring\V3\UptimeCheckConfig;

/**
 * Example:
 * ```
 * create_uptime_check($projectId, 'myproject.appspot.com', 'Test Uptime Check!');
 * ```
 *
 * @param string $projectId Your project ID
 * @param string $hostName
 * @param string $displayName
 */
function create_uptime_check($projectId, $hostName = 'example.com', $displayName = 'New uptime check')
{
    $projectName = 'projects/' . $projectId;
    $uptimeCheckClient = new UptimeCheckServiceClient([
        'projectId' => $projectId,
    ]);

    $monitoredResource = new MonitoredResource();
    $monitoredResource->setType('uptime_url');
    $monitoredResource->setLabels(['host' => $hostName]);

    $uptimeCheckConfig = new UptimeCheckConfig();
    $uptimeCheckConfig->setDisplayName($displayName);
    $uptimeCheckConfig->setMonitoredResource($monitoredResource);
    $createUptimeCheckConfigRequest = (new CreateUptimeCheckConfigRequest())
        ->setParent($projectName)
        ->setUptimeCheckConfig($uptimeCheckConfig);

    $uptimeCheckConfig = $uptimeCheckClient->createUptimeCheckConfig($createUptimeCheckConfigRequest);

    printf('Created an uptime check: %s' . PHP_EOL, $uptimeCheckConfig->getName());
}

Python

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

def create_uptime_check_config_get(
    project_id: str, host_name: str = None, display_name: str = None
) -> uptime.UptimeCheckConfig:
    """Creates a new uptime check configuration

    Args:
        project_id: Google Cloud project id where the uptime check is created
        host_name: An example label's value for the "host" label
        display_name: A human friendly name of the configuration

    Returns:
        A structure that describes a new created uptime check
    """
    config = monitoring_v3.UptimeCheckConfig()
    config.display_name = display_name or "New GET uptime check"
    config.monitored_resource = {
        "type": "uptime_url",
        "labels": {"host": host_name or "example.com"},
    }
    config.http_check = {
        "request_method": monitoring_v3.UptimeCheckConfig.HttpCheck.RequestMethod.GET,
        "path": "/",
        "port": 80,
    }
    config.timeout = {"seconds": 10}
    config.period = {"seconds": 300}

    client = monitoring_v3.UptimeCheckServiceClient()
    new_config = client.create_uptime_check_config(
        request={"parent": project_id, "uptime_check_config": config}
    )
    pprint.pprint(new_config)
    return new_config

def create_uptime_check_config_post(
    project_id: str, host_name: str = None, display_name: str = None
) -> uptime.UptimeCheckConfig:
    """Creates a new uptime check configuration

    Args:
        project_id: Google Cloud project id where the uptime check is created
        host_name: An example label's value for the "host" label
        display_name: A human friendly name of the configuration

    Returns:
        A structure that describes a new created uptime check
    """
    config = monitoring_v3.UptimeCheckConfig()
    config.display_name = display_name or "New POST uptime check"
    config.monitored_resource = {
        "type": "uptime_url",
        "labels": {"host": host_name or "example.com"},
    }
    config.http_check = {
        "request_method": monitoring_v3.UptimeCheckConfig.HttpCheck.RequestMethod.POST,
        "content_type": monitoring_v3.UptimeCheckConfig.HttpCheck.ContentType.URL_ENCODED,
        "body": "foo=bar".encode("utf-8"),
        "path": "/",
        "port": 80,
    }
    config.timeout = {"seconds": 10}
    config.period = {"seconds": 300}

    client = monitoring_v3.UptimeCheckServiceClient()
    new_config = client.create_uptime_check_config(
        request={"parent": project_id, "uptime_check_config": config}
    )
    pprint.pprint(new_config)
    return new_config

Ruby

Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

def create_uptime_check_config project_id: nil, host_name: nil, display_name: nil
  require "google/cloud/monitoring"

  client = Google::Cloud::Monitoring.uptime_check_service
  project_name = client.project_path project: project_id
  config = {
    display_name:       display_name.nil? ? "New uptime check" : display_name,
    monitored_resource: {
      type:   "uptime_url",
      labels: { "host" => host_name.nil? ? "example.com" : host_name }
    },
    http_check:         { path: "/", port: 80 },
    timeout:            { seconds: 10 },
    period:             { seconds: 300 }
  }
  new_config = client.create_uptime_check_config \
    parent:              project_name,
    uptime_check_config: config
  puts new_config.name
  new_config
end

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 eine Verfügbarkeitsdiagnose und eine Benachrichtigungsrichtlinie zur Überwachung dieser Prüfung:

  1. Bearbeiten Sie die Terraform-Konfigurationsdatei, fügen Sie eine google_monitoring_uptime_check_config-Ressource hinzu und wenden Sie dann die Konfigurationsdatei an.

    Das folgende Beispiel zeigt eine Konfiguration, mit der eine öffentliche URL geprüft wird:

    resource "google_monitoring_uptime_check_config" "example" {
        display_name = "example"
        timeout      = "60s"
    
        http_check {
            port = "80"
            request_method = "GET"
        }
    
        monitored_resource {
            type = "uptime_url"
            labels = {
                project_id = "PROJECT_ID"
                host="EXAMPLE.com"
            }
        }
    
        checker_type = "STATIC_IP_CHECKERS"
    }
    
  2. Optional: Erstellen Sie einen Benachrichtigungskanal und eine Benachrichtigungsrichtlinie:

    In den folgenden Schritten wird die Google Cloud Console verwendet, um den Benachrichtigungskanal und die Benachrichtigungsrichtlinie zu erstellen. Dieser Ansatz sorgt dafür, dass die Benachrichtigungsrichtlinie nur die von der Verfügbarkeitsdiagnose generierten Daten überwacht.

    1. So erstellen Sie einen Benachrichtigungskanal:

      1. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend  Benachrichtigungen aus:

        Zu Benachrichtigungen

      2. Wählen Sie Benachrichtigungskanäle verwalten aus.
      3. Rufen Sie den Typ des Kanals 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. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und dann  Verfügbarkeitsdiagnosen aus:

        Verfügbarkeitsdiagnosen aufrufen

      2. Suchen Sie Ihre Verfügbarkeitsdiagnose, wählen Sie Mehr und dann Benachrichtigungsrichtlinie hinzufügen aus.
      3. Wechseln Sie im Dialogfeld zum Abschnitt 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.

    Sie können eine Benachrichtigungsrichtlinie erstellen, indem Sie der Konfigurationsdatei eine google_monitoring_alert_policy-Ressource hinzufügen und die neue Konfiguration anwenden.

Es kann bis zu 5 Minuten dauern, bis die Ergebnisse der Verfügbarkeitsdiagnose bei Monitoring eintreffen. Bis dahin meldet das Verfügbarkeitsdiagnose-Dashboard als Status "no data available" (Keine Daten verfügbar).

ICMP-Pings verwenden

Um Fehler bei fehlgeschlagenen öffentlichen Verfügbarkeitsdiagnosen zu beheben, können Sie Ihre Verfügbarkeitsdiagnosen so konfigurieren, dass während der Prüfung bis zu 3 ICMP-Pings gesendet werden. Mithilfe der Pings können Sie leichter zwischen Fehlern unterscheiden, die beispielsweise durch Netzwerkverbindungsprobleme und Zeitüberschreitungen in Ihrer Anwendung verursacht werden.

Standardmäßig werden bei Verfügbarkeitsdiagnosen keine Pings gesendet. Jeder Ping erhöht die Latenz der Verfügbarkeitsdiagnose. Private Verfügbarkeitsdiagnosen können keine Pings senden.

Wenn eine öffentliche Verfügbarkeitsdiagnose fehlschlägt, werden die Ergebnisse der Pings in Cloud Logging-Logs geschrieben. Wenn der Ping fehlschlägt, werden dem Feld httpRequest des Logeintrags die folgenden Felder hinzugefügt:

  • rtt_usec: Umlaufzeit für jede fehlgeschlagene Ping-Anfrage.
  • unreachable_count: Anzahl der Ping-Anfragen, bei denen der Statuscode ICMP_DEST_UNREACH zurückgegeben wurde.
  • no_answer_count: Anzahl der Ping-Anfragen, bei denen das Zeitlimit überschritten und keine Antwort zurückgegeben wurde.

Die Ergebnisse von Pings für erfolgreiche Verfügbarkeitsdiagnosen werden nicht protokolliert.

Pings konfigurieren

Jede Verfügbarkeitsdiagnosekonfiguration enthält entweder ein HttpCheck- oder ein TcpCheck-Objekt. Beide Objekte enthalten das Feld pingConfig. Geben Sie in diesem Feld die Anzahl der ICMP-Pings an, die bei jeder Prüfung berücksichtigt werden sollen (maximal 3). Standardmäßig werden keine Pings gesendet.

Führen Sie einen der folgenden Schritte aus, um Pings zu konfigurieren:

  • Maximieren Sie in der Google Cloud Console die Option Weitere Zieloptionen und geben Sie in das Feld ICMP Pings einen Wert ein.

  • Verwenden Sie in der Cloud Monitoring API das Objekt PingConfig, das folgende Struktur hat:

    {
      "pingsCount": integer
    }
    

    Weitere Informationen zur Verwendung der Monitoring API für Verfügbarkeitsdiagnosekonfigurationen finden Sie unter Verfügbarkeitsdiagnose erstellen: API oder Verfügbarkeitsdiagnose bearbeiten: API.

Verfügbarkeitsdiagnose prüfen

Wenn Sie eine Verfügbarkeitsdiagnose in der Google Cloud Console erstellen, können Sie die Konfiguration vor dem Speichern testen.

Erfolgreiche Prüfungen

Eine Verfügbarkeitsdiagnose ist erfolgreich, wenn die folgenden Bedingungen erfüllt sind:

  • Der HTTP-Status stimmt mit den ausgewählten Kriterien überein.
  • Es gibt für die Antwort keinen erforderlichen Inhalt bzw. der erforderliche Inhalt ist in der Antwort auffindbar.

Nicht bestandene Prüfungen

Im Folgenden sind einige mögliche Fehlerursachen bei Verfügbarkeitsdiagnosen aufgeführt:

  • Connection Error – Refused (Verbindungsfehler – Abgelehnt): Achten Sie bei Verwendung des Standardverbindungstyps HTTP darauf, dass ein Webserver installiert ist, der auf HTTP-Anfragen reagiert. Bei einer neuen Instanz kann ein Verbindungsfehler auftreten, wenn Sie keinen Webserver installiert haben. Weitere Informationen finden Sie im Schnellstart für Compute Engine. Bei Verwendung des Verbindungstyps HTTPS müssen Sie unter Umständen zusätzliche Konfigurationsschritte ausführen. Informationen zu Firewallproblemen finden Sie unter IP-Adressen des Servers für die Verfügbarkeitsdiagnose auflisten.
  • Name or service not found (Name oder Dienst nicht gefunden): Der Hostname ist möglicherweise falsch.
  • 403 Forbidden (403 – Verboten): Der Dienst liefert während der Verfügbarkeitsdiagnose einen Fehlercode. Die Standardkonfiguration für den Apache-Webserver gibt diesen Code beispielsweise unter Amazon Linux zurück. Unter bestimmten Linux-Versionen erhalten Sie hingegen den Code 200 (Success) (200 (Erfolg)). Weitere Informationen finden Sie in der LAMP-Anleitung für Amazon Linux oder in der Dokumentation Ihres Webservers.
  • 404 – Not found (Nicht gefunden): Möglicherweise ist der Pfad falsch.
  • 408 Request timeout (408 – Zeitüberschreitung bei Anfrage) oder keine Antwort: Möglicherweise ist die Portnummer falsch, der Dienst wird nicht ausgeführt oder ist nicht erreichbar oder das Zeitlimit ist zu niedrig. Prüfen Sie, ob Ihre Firewall Traffic von den Verfügbarkeitsservern zulässt. Weitere Informationen finden Sie unter IP-Adressen für Verfügbarkeitsdiagnosen auflisten. Das Zeitlimit ist Teil der Antwortvalidierung angegeben.

Wenn Ihre Verfügbarkeitsdiagnose für das Senden von Pings konfiguriert ist, werden die Ergebnisse von Pings für fehlgeschlagene Verfügbarkeitsdiagnosen in Cloud Logging geschrieben. Weitere Informationen finden Sie unter ICMP-Pings verwenden.

Nächste Schritte