Einrichten von Benachrichtigungen

Standardmäßig schreibt Adobe Commerce in der Cloud-Infrastruktur Erstellungs- und Bereitstellungsaktionen in die app/var/log/cloud.log im Stammverzeichnis der Adobe Commerce-Anwendung. Optional können Sie Protokolle an ein Messaging-System senden, z. B. Slack und E-Mail, um Echtzeitbenachrichtigungen zu erhalten.

Sie können beispielsweise eine Slack-Nachricht senden, um eine Gruppe von Personen zu benachrichtigen, wenn eine Bereitstellung fehlschlägt, und eine Untersuchung der Fehlerursache einleiten.

Benachrichtigungen planen

Beachten Sie Folgendes, bevor Sie Benachrichtigungen konfigurieren:

  • Welche Art von Benachrichtigungen möchten Sie erhalten (Slack-Nachrichten, E-Mail, beides)?
  • Wie viele Details sollen in den Protokollen angezeigt werden?
  • Wo sollen Benachrichtigungen eingerichtet werden (Integration, Staging, Produktion)?

Beispielsweise können Sie bei der ersten Entwicklung E-Mail-Benachrichtigungen bevorzugen, die detaillierte Protokolle über Ihre Integrationsumgebung enthalten, um Probleme vor der Bereitstellung in der Staging-Umgebung zu beheben. Wenn Sie für die Bereitstellung in der Staging- oder Produktionsumgebung bereit sind, bevorzugen Sie möglicherweise eine Slack-Nachricht, die weniger detaillierte Informationen enthält.

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

Konfigurieren von Benachrichtigungen

So konfigurieren Sie Benachrichtigungen:

  1. Wechseln Sie auf Ihrer lokalen Workstation in Ihr Projektverzeichnis.

  2. Fügen Sie in der .magento.env.yaml-Datei in Ihrem Projektstammverzeichnis Ihre Messaging-Systemeinstellungen hinzu, einschließlich bevorzugter Benachrichtigungs- Protokollebenen.

    Verwenden Sie z. B. Folgendes, um sowohl die Slack und-E-Mail-Konfigurationen zu konfigurieren:

    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 während der Bereitstellungsphase E-Mails.
  3. Übergeben Sie Ihre Änderungen und übertragen Sie sie auf den Remote-Server.

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

Beispiel einer Slack-Konfiguration

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 - Name des Slack-Kanals, über den Adobe Commerce in der Cloud-Infrastruktur Benachrichtigungen sendet.
  • username - Benutzername, den Adobe Commerce in der Cloud-Infrastruktur verwendet, um Benachrichtigungen auf Slack zu senden.
  • min_level - Minimale Protokollebene für Benachrichtigungsinhalte Es wird empfohlen, info zu verwenden.

Beispiel einer E-Mail-Konfiguration

Das folgende Beispiel zeigt eine reine E-Mail-Konfiguration:

NOTE
Adobe Commerce in der Cloud-Infrastruktur sendet nur während der Bereitstellungsphase E-Mails.
log:
  email:
    to: <your-email>
    from: <your-email>
    subject: "Log notification from Adobe Commerce"
    min_level: "notice"
  • to: Die E-Mail-Adresse Adobe Commerce in der Cloud-Infrastruktur sendet Benachrichtigungsnachrichten.
  • from - E-Mail-Adresse für den Versand von Benachrichtigungsinhalten an Empfänger.
  • subject - Beschreibung der E-Mail.
  • min_level - Minimale Protokollebene für Benachrichtigungsinhalte Es wird empfohlen, notice oder warning zu verwenden.
recommendation-more-help