Release Tracking

Tideways can track releases to compare performance, failure rate and error occurrances before and after you released changes to your project.

You can automate the creation of releases using either the REST API or commandline.

Create Release via REST API

Creating a release event is best done using the REST API endpoint:

POST https://app.tideways.io/api/events
Content-Type: application/json

{
    "apiKey": "api key here",
    "name": "Name of the release",
    "description": "Optional details about the release if necessary",
    "type": "release",
    "environment": "production",
    "service": "web",
    "compareAfterMinutes": 90
}

Or as a cURL command:

curl -d '{"apiKey": "api key here", "name": "v1.0", "type": "release", "environment": "production", "service": "web", "compareAfterMinutes":90}' -X POST https://app.tideways.io/api/events

The following arguments can be set in the payload:

apiKey (required) Check to "Project Settings" to find the API key necessary to authenticate the Create Event request.
name (required) Name of the release (free-form text field)
type (required) Type of the event. Currently supports release and marker.
description (optional) More details about the release if you want.
environment (optional) The environment this release is performed on, otherwise the default environment is used.
service (optional) The service this release is performed on, otherwise the default service of the project is used.
compareAfterMinutes (optional) Defaults to 90 minutes. Specifies the timeframes around the event for which the performance will be compared. Supported values are between 5 minutes and 1440 minutes (one day).

Create Release via Tideways CLI

Alternatively you can use the tideways CLI command to create an event.

$ tideways event create acme/myapp17 release "v1.0"

Release Tracking

Create Release via REST API

Create Release via Tideways CLI

Further reading