LogoLogo
Reliability HubAPI DocsPlatform
  • Welcome to Steadybit
  • Quick Start
    • First Steps
    • Compatibility
    • Install Agent and Extensions
    • Run an Experiment
    • Deploy Example Application
  • Concepts
    • Actions
    • Discovery
    • Query Language
  • Install and Configure
    • Install Agent
      • Architecture
      • Install on Kubernetes
      • Install on Linux Hosts
      • Install using Docker Compose
      • Install on Amazon ECS
      • Extension Registration
      • Using Mutual TLS for Extensions
      • Configuration Options
      • Agent State
      • Agent API
    • Install On-Prem Platform
      • Install on Minikube
      • Advanced Agent Authentication
      • Configuration Options
      • Maintenance & Incident Support
      • Syncing Teams via OIDC Attribute
    • Manage Environments
    • Manage Teams and Users
      • Users
      • Teams
      • Permissions
    • Manage Experiment Templates
  • Use Steadybit
    • Experiments
      • Design
      • Run
      • Run History
      • Schedule
      • Variables
      • Emergency Stop
      • Share
        • Templates
        • Duplicate
        • File
      • OpenTelemetry Integration
    • Explorer
      • Landscape
      • Targets
      • Advice
    • Reporting
  • Integrate with Steadybit
    • Extensions
      • Anatomy of an Extension
      • Extension Installation
      • Extension Kits
      • Available Extensions
    • API
      • Interactive API Documentation
    • CLI
    • Badges
    • Webhooks
      • Custom Webhooks
      • Preflight Webhooks
    • Preflight Actions
    • Slack Notifications
    • Audit Log
    • Hubs
  • Troubleshooting
    • How to troubleshoot
    • Common fixes
      • Extensions
      • Agents
      • On-prem platform
Powered by GitBook

Extension Docs

  • ActionKit
  • DiscoveryKit
  • EventKit

More Resources

  • Reliability Hub
  • API Docs
On this page
  • Precondition
  • Configure
  • Experiment Runs
  • Developing actions
  • Lifecycle of Preflight actions

Was this helpful?

Edit on GitHub
  1. Integrate with Steadybit

Preflight Actions

Last updated 1 month ago

Was this helpful?

Preflight actions are an enterprise feature. Please if you want to get access.

Preflight actions are triggered by Steadybit whenever an experiment is about to start and allow you to prevent an experiment from running. To decide whether that specific experiment run is allowed to start, you get a list of all expected affected targets in the extension action call. Please note that, due to concurrency, these affected targets may change in case one of the targets is gone when the actual step starts or new ones are discovered.

Precondition

You need to write your own extension with added to it. Implement the preflight action at your needs. See .

Configure

You can add preflight actions at Settings -> Integrations -> Preflight Actions.

A preflight action integration has the following parameters to be specified:

Name

The preflight action's name, it is shown in the experiment run.

Team

If no team is specified, preflight actions will be performed for all teams. If you specify a team, preflight actions are only made for this team.

Preflight Action

The Preflight Action to use from a registered extension

Experiment Runs

During the experiment run, you can see the triggered preflight actions. If an preflight action fails, the experiment run fails, and no targets are attacked.

Developing actions

Lifecycle of Preflight actions

A preflight action can be in one of the following lifecycle statuses, indicated in the experiment run:

CREATED

The preflight action was created and has sent the request to the configured action in the extension. It is still waiting for the response.

SUCCESSFUL

The preflight action was resolved successfully. The experiment is allowed to continue (if all preflight actions are successful).

FAILED

The preflight action resolved with a failure. The experiment will fail. Optionally, the response may contain a message as a reason for experiment failure.

ERRORED

Technical error happened while requesting the preflight action, e.g., the extension URL couldn't be resolved, or the HTTP request timed out.

A action will timeout after 55 seconds. In that case, the preflight action is marked as ERRORED, and the experiment will not start. If the action resolves later, the actual result will be submitted to the preflight action step in the experiment.

A preflight action uses . See our to get started.

preflight kit
docs
reach out to us
preflight kit
docs
Add Preflight Action Integration
Preflight Action Success
Preflight Action Failure - Stopped Experiment Run