Managing Incidents with Alerts β
Terramate Cloud alerts help manage critical events, such as failed deployments and detected drift. Alerts are automatically generated for these events and assigned to the appropriate individuals or teams (for example, the author of a commit or Pull Request).
Alerts seamlessly integrate with Slack via the Slack App integration, sending direct messages to assigned recipients whenever alerts are created or updated.
INFO
Unless a member of your Terramate Cloud organization uses the same email address among all their third-party accounts (e.g., GitHub user, GitLab user, Slack user, etc.), users must link their accounts with their Terramate Cloud user in the profile section. Otherwise, Terramate cannot automatically assign alerts because of the lack of mapping, e.g., for GitHub and Slack users.
Linking accounts can be done in the user profile. Learn more about this in the account linking documentation.
Alert List β
The Alert Dashboard displays all alertsβboth resolved and unresolvedβacross the organization. In the list view, each alert includes:
- Alert Type: The alert's category
- Stack Name: The stack name and commit ID that triggered the drift.
- Status: The current state of the alert (
open
orresolved
). - Assignees: Team members assigned to the alert.
- Last Updated: Timestamp of the most recent action.
- Action Buttons: Direct controls for each alert:
- Take Ownership: Assign the alert to yourself (triggers a Slack notification for assignees).
- Share Link: Share the alert with your team.
- Resolve: Mark the alert as resolved (triggers a Slack notification for assignees).
Alert Details β
This view allows you to inspect detailed alert information and take the following actions:
- Assignees: Add or remove assignees beyond the default auto-assignees.
- Resolve Alert: Mark the alert as resolved (assignees receive a Slack notification). Alerts automatically resolve when the corresponding stack becomes healthy.
- Visit Stack Details: Access detailed information about the associated stack.
Types of Alerts β
Currently, Terramate Cloud automatically creates, assigns and resolves alerts for the following incidents:
Failed Deployment β
A failed deployment in Terramate describes a deployment that contains one or multiple failed stacks. Alerts for failed deployments will be automatically assigned to several individuals:
- Author of the Pull Requests from which the failed deployment originated.
- All reviewers of the Pull Requests from which the failed deployment originated.
- The person who triggered the deployment by merging the origin Pull Requests or triggering a local deployment.
Detected Drift β
A detected drift in Terramate describes a stack that has drifted. Alerts for drifted stacks will be automatically assigned to several individuals:
- The person who triggered the last deployment (merging the latest Pull Requests or triggering a local deployment).
Auto Resolving of Alerts β
Whenever the underlying root issue that causes an alert in the first place gets resolved, alerts are resolved automatically. For example, let's assume that drift has been introduced for a stack and an alert has been created during a scheduled drift detection run. If the drift is resolved (e.g., by someone logging in to the AWS console and remediating the drift) during the next scheduled drift detection run, the alert will be resolved automatically.
Integrating Alerts with Slack β
To integrate alerts with your Slack workspace, install the Slack App. Once installed, the Slack App will send notifications for all newly created and updated alerts to all assigned users. Users will be able to open alerts and affected stacks directly from Slack.