Deployment Events

Tideways can track deployment/release events to compare performance and error rate before and after you released changes to your project.

Creating a deployment/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 only release.

  • description (optional) More details about the release if you want.

  • environment (optional) The environment this release is performed on, defaults to "production".

  • service (optional) The service this release is performed on, defaults to "web" or the default project service name.

  • compareAfterMinutes (optional) Default is 90 minutes, this is the time span after release event that will be compared. Allowed value is between¬†5¬†and 90 minutes.

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

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

As a third option, you can also create Deployment/Release events from the user interface. Click on the "0 Events" link on the projects main screen, located in the top right next to response time, requests and error rate. It will open a view that allows you to add a new deployment event.

Deployment Events and Errors

When you use deployment/release events it will interact with errors in the following way:

  • The occurrences counter "since last release" is reset to 0. You can find out how often each error occurred since the last release.

  • If you use a "New Error/Exception" alert, then every error that occurs again for the first time since the release triggers a new notification.

Still need help? Email [email protected]