Benachrichtigungskanäle für Benachrichtigungen konfigurieren

Auf dieser Seite wird beschrieben, wie Sie Benachrichtigungskanäle konfigurieren, um Benachrichtigungen zu erhalten.

Benachrichtigungskanäle sind die Zustellungsmechanismen für Ihre konfigurierten Benachrichtigungen. Das System benachrichtigt die angegebenen Empfänger über diese Kanäle, wenn ein Ereignis eine Benachrichtigung auslöst. So wird sichergestellt, dass wichtige Benachrichtigungen das zuständige Personal über die bevorzugten Kommunikationsmethoden erreichen.

In GDC-Umgebungen (Google Distributed Cloud) mit Air-Gap-Appliance sind vordefinierte Benachrichtigungskanäle wie Slack oder E-Mail nicht verfügbar. Damit Sie Benachrichtigungen erhalten, müssen Sie mindestens einen benutzerdefinierten Benachrichtigungskanal konfigurieren. Sie bearbeiten benutzerdefinierte ObservabilityPipeline-Ressourcen in Ihrem Projekt-Namespace, um Channel-Konfigurationen anzuwenden.

Durch das Anpassen von Benachrichtigungschannels können Administratoren Folgendes erreichen:

  • Bestimmte Empfänger anvisieren: Richten Sie Benachrichtigungen an Personen, Teams oder Bereitschaftsdienste, die für die Behebung von Problemen zuständig sind.
  • Bevorzugte Kommunikationsmethoden verwenden: Senden Sie Benachrichtigungen über Kanäle wie SMS, PagerDuty, Webhooks oder benutzerdefinierte Integrationen, um den individuellen Vorlieben und betrieblichen Workflows gerecht zu werden.
  • Benachrichtigungsmüdigkeit vermeiden: Reduzieren Sie das Rauschen und sorgen Sie dafür, dass Benachrichtigungen nur von den Personen empfangen werden, die Maßnahmen ergreifen müssen.

Für die Implementierung von Benachrichtigungskanälen in GDC müssen Administratoren die Kanalkonfiguration im System definieren. Dazu müssen in der Regel Parameter wie die folgenden angegeben werden:

  • Kanaltyp: Der verwendete Kanaltyp.
  • Ziel: Der Endpunkt, an den das System Benachrichtigungen senden soll.
  • Authentifizierung: Alle erforderlichen Anmeldedaten für den Zugriff auf das Ziel.

Durch die Konfiguration von Benachrichtigungskanälen können Administratoren dafür sorgen, dass die Monitoring-Plattform wichtige Benachrichtigungen effektiv übermittelt. So können sie schnell auf potenzielle Probleme reagieren und die Stabilität und Leistung von GDC-Umgebungen aufrechterhalten.

Hinweise

Bitten Sie Ihren Organisations-IAM-Administrator oder Projekt-IAM-Administrator, Ihnen eine der zugehörigen ObservabilityPipeline-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Verwalten von benutzerdefinierten ObservabilityPipeline-Ressourcen benötigen.

Bitten Sie Ihren IAM-Administrator der Organisation oder des Projekts, Ihnen die Rolle „ConfigMap Creator“ zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Verwalten von ConfigMap-Objekten in Ihrem Projektnamespace benötigen, die zum Definieren von Konfigurationsregeln erforderlich sind.

Je nach erforderlicher Zugriffsebene und Berechtigungen können Sie für diese Ressourcen in einer Organisation oder einem Projekt die Rollen „Ersteller“, „Bearbeiter“ oder „Betrachter“ erhalten. Weitere Informationen finden Sie unter IAM-Berechtigungen vorbereiten.

Benachrichtigungskanäle konfigurieren

Benachrichtigungskanäle für Benachrichtigungen in Ihrem Projekt-Namespace konfigurieren:

  1. Definieren Sie Ihre benutzerdefinierte Konfiguration für Benachrichtigungskanäle in einer YAML-Datei mit dem Namen alertmanager.yml. Sie müssen dieselbe Syntax wie in der Alertmanager-Spezifikation verwenden:

    https://prometheus.io/docs/alerting/latest/configuration/.

  2. Erstellen Sie ein ConfigMap-Objekt und fügen Sie Ihre benutzerdefinierte Konfiguration aus der Datei alertmanager.yml in das Feld data ein.

    Das folgende Beispiel zeigt, wie das ConfigMap-Objekt mit der alertmanager.yml-Datei aussehen muss:

    apiVersion: v1
kind: ConfigMap
metadata:
  name: CONFIGMAP_NAME
  # The namespace must match your project namespace.
  namespace: PROJECT_NAMESPACE
data:
  # The file name must be alertmanager.yml
  alertmanager.yml: |
    # Define your notification channels.
    # Add the custom configuration in the following lines of this file.
    # Follow the same syntax as in https://prometheus.io/docs/alerting/latest/configuration

  [...]

    Ersetzen Sie Folgendes:

    • CONFIGMAP_NAME: der Name der ConfigMap-Definitionsdatei. Sie verwenden diesen Namen später in der benutzerdefinierten Ressource ObservabilityPipeline.
    • PROJECT_NAMESPACE: Ihr Projekt-Namespace.

  3. Wenden Sie das ConfigMap-Objekt auf den Management API-Server im selben Namespace wie Ihre konfigurierten Benachrichtigungen an:

    kubectl --kubeconfig KUBECONFIG_PATH apply -f CONFIGMAP_NAME.yaml

    Ersetzen Sie Folgendes:

    • KUBECONFIG_PATH: der Pfad zur kubeconfig-Datei für den Management API-Server.
    • CONFIGMAP_NAME: der Name der ConfigMap-Definitionsdatei.

  4. Bearbeiten Sie die Spezifikation der benutzerdefinierten ObservabilityPipeline-Ressource, um Ihre Konfiguration in das Feld alertmanagerConfig zu importieren:

     # Configure the observability pipeline.
apiVersion: observability.gdc.goog/v1
kind: ObservabilityPipeline
metadata:
  # The namespace must match your project namespace.
  namespace: PROJECT_NAMESPACE
  name: OBSERVABILITY_PIPELINE_NAME
spec:
  # Configure alerts.
  alerting:
    # The alerting configuration must be in the ConfigMap.
    # The value must match the ConfigMap name exactly.
    alertmanagerConfig: CONFIGMAP_NAME

  [...]

    Ersetzen Sie Folgendes:

    • PROJECT_NAMESPACE: Ihr Projekt-Namespace.
    • OBSERVABILITY_PIPELINE_NAME: der Name der benutzerdefinierten Ressource ObservabilityPipeline.
    • CONFIGMAP_NAME: der Name, den Sie für die ConfigMap-Definitionsdatei verwendet haben. Der Name muss genau übereinstimmen.

  5. Speichern Sie die Datei.

  6. Wenden Sie die Änderungen der benutzerdefinierten ObservabilityPipeline-Ressource auf den Management API-Server im selben Namespace wie Ihre konfigurierten Benachrichtigungen an:

    kubectl --kubeconfig KUBECONFIG_PATH apply -f OBSERVABILITY_PIPELINE_NAME.yaml

    Ersetzen Sie Folgendes:

    • KUBECONFIG_PATH: der Pfad zur kubeconfig-Datei für den Management API-Server.
    • OBSERVABILITY_PIPELINE_NAME: der Name der ObservabilityPipeline-Definitionsdatei.