Benachrichtigungen einrichten

Standardmäßig schreibt Adobe Commerce in der Cloud-Infrastruktur Build- und Bereitstellungsaktionen in die Datei "app/var/log/cloud.log"im Stammordner der Adobe Commerce-Anwendung. Optional können Sie Protokolle an ein Messaging-System wie Slack und E-Mail senden, um Echtzeit-Benachrichtigungen zu erhalten.

Beispielsweise können Sie eine Slack-Nachricht senden, um eine Benutzergruppe bei einem fehlgeschlagenen Bereitstellungsprozess zu benachrichtigen und eine Untersuchung darüber einzuleiten, was schiefgelaufen ist.

Planen von Benachrichtigungen

Beachten Sie vor der Konfiguration von Benachrichtigungen Folgendes:

  • Welche Art von Benachrichtigungen möchten Sie erhalten (Slack-Nachrichten, E-Mails, beides)?
  • Wie viele Details möchten Sie in den Protokollen sehen?
  • Wo möchten Sie Benachrichtigungen einrichten (Integration, Staging, Produktion)?

Beispielsweise können Sie während der ersten Entwicklung E-Mail-Benachrichtigungen mit detaillierten Protokollen zu Ihrer Integrationsumgebung bevorzugen, um Probleme zu beheben, bevor Sie sie in der Staging-Umgebung bereitstellen. Wenn Sie für die Bereitstellung in der Staging- oder Produktionsumgebung bereit sind, sollten Sie eine Slack-Nachricht mit weniger detaillierten Informationen bevorzugen.

NOTE
Die Konfigurationsdatei, die zum Einrichten von Benachrichtigungen verwendet wird, befindet sich im Stammverzeichnis Ihres Projektverzeichnisses. Sie gilt also, wenn Sie Änderungen an eine Umgebung pushen. Wenn Sie Benachrichtigungen pro Umgebung anpassen möchten, müssen Sie die Konfigurationsdatei ändern, bevor Sie sie an diese Umgebung senden.

Benachrichtigungen konfigurieren

So konfigurieren Sie Benachrichtigungen:

  1. Wechseln Sie auf Ihrer lokalen Workstation zum Projektverzeichnis.

  2. Fügen Sie in der Datei ".magento.env.yaml"im Projektstamm Ihre Einstellungen für das Messaging-System hinzu, einschließlich der bevorzugten Benachrichtigungsebene Protokollebenen.

    Um beispielsweise die E-Mail-Konfigurationen für Slack und zu konfigurieren, verwenden Sie Folgendes:

    code language-yaml
    log:
      slack:
        token: "<your-slack-token>"
        channel: "<your-slack-channel>"
        username: "SlackHandler"
        min_level: "info"
      email:
        to: <your-email>
        from: <your-email>
        subject: "Log notification from Adobe Commerce"
        min_level: "notice"
    
    note note
    NOTE
    Adobe Commerce in der Cloud-Infrastruktur sendet nur E-Mails während der Bereitstellungsphase.
  3. Übertragen Sie Ihre Änderungen auf den Remote-Server.

    code language-bash
    git -A && git commit -m "Configure build/deploy notifications"
    
    code language-bash
    git push origin <branch-name>
    

Slack-Beispielkonfiguration

Das folgende Beispiel zeigt eine Nur-Slack-Konfiguration:

log:
  slack:
    token: "<your-slack-token>"
    channel: "<your-slack-channel>"
    username: "SlackHandler"
    min_level: "info"
  • token - Ihr Slack Benutzer-Token. Ihr Benutzer-Token autorisiert Adobe Commerce in der Cloud-Infrastruktur zum Senden von Nachrichten.
  • channel - Der Name des Slack-Kanals Adobe Commerce in der Cloud-Infrastruktur sendet Benachrichtigungen.
  • username—Benutzername Adobe Commerce in der Cloud-Infrastruktur verwendet , um Benachrichtigungen in Slack zu senden.
  • min_level—Minimale Protokollebene für Benachrichtigungsmeldungen. Es wird empfohlen, info zu verwenden.

Beispiel für eine E-Mail-Konfiguration

Das folgende Beispiel zeigt eine E-Mail-Konfiguration:

NOTE
Adobe Commerce in der Cloud-Infrastruktur sendet nur E-Mails während der Bereitstellungsphase.
log:
  email:
    to: <your-email>
    from: <your-email>
    subject: "Log notification from Adobe Commerce"
    min_level: "notice"
  • to - E-Mail-Adresse Adobe Commerce in der Cloud-Infrastruktur sendet Benachrichtigungen.
  • from - E-Mail-Adresse zum Senden von Benachrichtigungsinhalten an Empfänger.
  • subject—Beschreibung der E-Mail.
  • min_level—Minimale Protokollebene für Benachrichtigungsmeldungen. Es wird empfohlen, notice oder warning zu verwenden.
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26