New Release Notifications

With the "New Release" notification rule, Tideways informs you about new releases of your project and compares the performance before and after each release.

To create releases, see Release Tracking.

Each release can cause two notifications:

  1. A new release notification directly after the release is created.

  2. A release comparison notification after the comparison timeframe of the release has passed. The timeframe is the compareAfterMinutes value of the release (default: 90 minutes).

Configuration

  1. Open the Notifications settings screen in your project.

  2. Click "Create Notification Rule" and select "New Release".

  3. Select Services and Environments to match the notification rule.

  4. Configure "Notify me after the release if" with one of these options:

    • Always: Tideways sends the new release notification and the release comparison notification for each release.

    • When something is wrong: Tideways sends no new release notification. It only sends the release comparison notification when the release has a performance issue.

  5. Select the integrations to send the notifications to.

  6. Save the Notification Rule.

When Something Is Wrong

Tideways compares the timeframe after the release with a timeframe of the same length before the release. A release has a performance issue when both of these conditions are true:

  • The 95th percentile response time after the release is more than 20% higher than before the release.

  • The requests per minute after the release are more than 80% of the requests per minute before the release.

The second condition makes sure that the traffic is similar before and after the release. When the traffic decreases by 20% or more, the comparison is not reliable and Tideways sends no notification.

Notification Contents

New Release

The new release notification contains:

  • The name of the release

  • The service and environment of the release

  • A link to the release in Tideways

Integration Contents

Slack

In compact mode, the title "New Release" with the release name, environment and service. In detailed mode, the release name as title and a text with the service and environment.

Microsoft Teams

The release name with a link, and the service and environment.

E-Mail

The release name, the project and a link to the release.

Webhook

The type release and the release_name.

Tideways does not send this notification to Opsgenie, PagerDuty or Splunk On-Call.

Example webhook payload:

{
  "type": "release",
  "link": "https:\/\/app.tideways.io\/o\/demo\/shopware\/events",
  "organization": "demo",
  "application": "shopware",
  "date": "2017-04-10 09:30:00",
  "notification": {
    "release_name": "Test"
  }
}

Release Comparison

The release comparison notification contains these values before and after the release:

  • 95th percentile response time in milliseconds

  • Requests per minute

  • Failure rate in percent

Integration Contents

Slack

In compact mode, the title tells if the response time is "as before", "improved" or "degraded". In detailed mode, the before and after values are fields. When the release has a performance issue, the message is red and shows "Warning: This release decreased the performance." Otherwise, the message is green.

Microsoft Teams

The release name with a link, and the before and after values.

E-Mail

The release name, the before and after values and a link to the release.

Webhook

The type compare_release, the release_name and the objects before_release and after_release. Each object contains response_time, requests and error_rate. The requests value is the total number of requests in the comparison timeframe.

Tideways does not send this notification to Opsgenie, PagerDuty or Splunk On-Call.

Example webhook payload:

{
  "type": "compare_release",
  "link": "https:\/\/app.tideways.io\/o\/demo\/shopware\/events",
  "organization": "demo",
  "application": "shopware",
  "date": "2017-04-10 07:11:00",
  "notification": {
    "release_name": "Test",
    "before_release": {
      "response_time": 1903,
      "requests": 2601,
      "error_rate": 0.12
    },
    "after_release": {
      "response_time": 1431,
      "requests": 3280,
      "error_rate": 0
    }
  }
}
Still need help? Email [email protected]