Configuration des notifications

Par défaut, Adobe Commerce sur l’infrastructure cloud écrit et déploie les actions sur la app/var/log/cloud.log dans le répertoire de l’application racine Adobe Commerce. Vous pouvez éventuellement envoyer des journaux à un système de messagerie, tel que Slack et courrier électronique, pour recevoir des notifications en temps réel.

Par exemple, vous pouvez envoyer un message d’alerte à un groupe de personnes en cas d’échec d’un déploiement et demander une enquête sur les problèmes.

Planification des notifications

Avant de configurer des notifications, tenez compte des points suivants :

  • Quel type de notification souhaitez-vous recevoir (messages du Slack, email, les deux) ?
  • Combien de détails voulez-vous voir dans les logs ?
  • Où souhaitez-vous configurer des notifications (intégration, évaluation, production) ?

Par exemple, lors du développement initial, vous préférez peut-être recevoir des notifications par e-mail qui affichent des journaux détaillés sur votre environnement d’intégration afin de vous aider à déboguer les problèmes avant de procéder au déploiement dans l’environnement d’évaluation. Lorsque vous êtes prêt à effectuer un déploiement dans l’environnement d’évaluation ou de production, vous préférez peut-être un message de Slack contenant des informations moins détaillées.

NOTE
Le fichier de configuration utilisé pour configurer les notifications se trouve à la racine de votre répertoire de projet. Il s’applique donc lorsque vous poussez des modifications dans n’importe quel environnement. Si vous souhaitez personnaliser les notifications par environnement, vous devez modifier le fichier de configuration avant de le transférer dans cet environnement.

Configurer les notifications

Pour configurer les notifications :

  1. Sur votre poste de travail local, modifiez le répertoire de votre projet.

  2. Dans le .magento.env.yaml dans la racine de votre projet, ajoutez les paramètres de votre système de messagerie, y compris les notifications de votre choix. Niveaux de journalisation.

    Par exemple, pour configurer les deux Slack et les configurations d’email, utilisez ce qui suit :

    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 sur l’infrastructure cloud envoie uniquement des emails pendant la phase de déploiement.
  3. Validez et envoyez vos modifications au serveur distant.

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

Exemple de configuration de Slack

L’exemple suivant illustre une configuration réservée aux Slack :

log:
  slack:
    token: "<your-slack-token>"
    channel: "<your-slack-channel>"
    username: "SlackHandler"
    min_level: "info"
  • token: votre Slack jeton utilisateur. Votre jeton utilisateur autorise Adobe Commerce sur l’infrastructure cloud pour envoyer des messages.
  • channel: nom du canal Slack Adobe Commerce sur l’infrastructure cloud envoie des notifications.
  • username—Nom d’utilisateur Adobe Commerce sur l’infrastructure cloud utilise pour envoyer des messages de notification en Slack.
  • min_level—Niveau de journal minimum pour les messages de notification. Nous vous recommandons d’utiliser info.

Exemple de configuration de courrier électronique

L’exemple suivant illustre une configuration par email uniquement :

NOTE
Adobe Commerce sur l’infrastructure cloud envoie uniquement des emails pendant la phase de déploiement.
log:
  email:
    to: <your-email>
    from: <your-email>
    subject: "Log notification from Adobe Commerce"
    min_level: "notice"
  • to: adresse électronique Adobe Commerce envoie des messages de notification sur l’infrastructure cloud.
  • from: adresse email pour envoyer des messages de notification aux destinataires.
  • subject—Description de l’email.
  • min_level—Niveau de journal minimum pour les messages de notification. Nous vous recommandons d’utiliser notice ou warning.
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26