Set up notifications

By default, Magento Commerce (Cloud) writes build and deploy actions to the app/var/log/cloud.log file inside the Magento root application directory. Optionally, you can send logs to a messaging system, such as Slack and email, to receive real-time notifications.

For example, you could send a Slack message to alert a group of people when a deployment fails, and prompt an investigation into what went wrong.

Plan your notifications

Before you configure notifications, consider the following:

What kind of notifications do you want to receive (Slack messages, email, both)?
How much detail do you want to see in the logs (see Log levels)?
Where do you want to set up notifications (integration, staging, production)?

For example, during initial development you may prefer email notifications that show detailed logs about your Integration environment to help you debug issues before deploying to the Staging environment. However, when you are ready to deploy to the Staging or Production environment, you may prefer a Slack message that contains less detailed information.

The configuration file used to set up notifications is at the root of your project directory, so it applies when you push changes to any environment. If you want to customize notifications per environment, you must modify the configuration file before pushing it to that environment.

Configure notifications

To configure notifications:

Open a terminal and checkout a branch in your local environment.
Locate the .magento.env.yaml.sample file in your project root and rename it .magento.env.yaml. The code in this file is commented out by default.

Remove the code comments and add your messaging system settings, including preferred notification log level.

For example, to configure both Slack and email configurations, use the following:

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 Magento Cloud"
      min_level: "notice"

Magento Commerce (Cloud) only sends emails during the deployment phase.

Commit and push your changes to the remote server.

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

Example Slack configuration

The following example shows a Slack-only configuration:

log:
  slack:
      token: "<your-slack-token>"
      channel: "<your-slack-channel>"
      username: "SlackHandler"
      min_level: "info"

token—Your Slack user token. Your user token authorizes Magento Commerce (Cloud) to send messages.
channel—Name of the Slack channel Magento Commerce (Cloud) sends notifications.
username—Username Magento Commerce (Cloud) uses to send notification messages in Slack.
min_level—Minimum log level for notification messages. We recommend using info.

Example email configuration

The following example shows an email-only configuration:

Magento Commerce (Cloud) only sends emails during the deployment phase.

log:
  email:
      to: <your-email>
      from: <your-email>
      subject: "Log notification from Magento Cloud"
      min_level: "notice"

to—Email address Magento Commerce (Cloud) sends notification messages.
from—Email address for sending notification messages to recipients.
subject—Description of the email.
min_level—Minimum log level for notification messages. We recommend using notice or warning.

Log levels

Log levels determine the level of detail your notification messages contain. You can choose from the following options:

debug—Detailed debug information.
info—Interesting events. For example, a user logs in, SQL logs, etc.
notice—Normal but significant events.
warning—Exceptional occurrences that are not errors. For example, use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
error—Runtime errors that don’t require immediate action but should be logged and monitored.
critical—Critical conditions. For example, an unavailable application component, unexpected exceptions.
alert—Action must be taken immediately. For example, your website is down, the database is unavailable, etc. This should trigger SMS alerts and wake you up.
emergency—The system is unusable.

Edit this page on GitHub

Give us feedback