No results for ""
EXPAND ALL
  • Home
  • API docs

Managing guarded rollouts

Read time: 2 minutes
Last edited: Oct 02, 2024

Overview

This topic explains how to manage guarded rollouts.

Monitor a guarded rollout

When you are monitoring metrics on the flag, a message displays at the top of the flag targeting page:

The "Guarded rollout" badge at the top of the flag targeting page.
The "Guarded rollout" badge at the top of the flag targeting page.

Additionally, a message displays on the rule that you are monitoring:

  • LaunchDarkly is monitoring this rule for any regressions: LaunchDarkly is actively monitoring metrics on the flag rule.
  • No regressions found. Rule enabled fully.: the monitoring window is over and LaunchDarkly found no regressions in the metrics on the flag rule.
  • Measured rollout reverted early: the release was manually rolled back before the end of the monitoring window.
  • Measured rollout completed early: the release was manually completed before the end of the monitoring window.
  • Regression detected and mitigated. LaunchDarkly successfully rolled back this rule.: LaunchDarkly found a regression and automatically rolled back the release. This message may appear during or after the monitoring window has ended.
  • Regression detected on the metric [name], roll back this rule immediately to mitigate the issue: LaunchDarkly found a regression, but you did not enable automatic rollback so you must manually roll back the release. This message may appear during or after the monitoring window has ended.

Roll back releases

To manually roll back a release after LaunchDarkly has detected a regression:

  1. From the flag's targeting page, find the rule with the detected regression.

  2. Click Roll back. The "Stop rollout early" dialog appears.

    Information about metric performance on a flag's default rule.
    Information about metric performance on a flag's default rule.
  3. Choose which Variation to serve to all contexts after you stop monitoring. The field defaults to the control variation.

  4. Click Stop.

Dismiss regression alerts

If LaunchDarkly detects a regression, but you want to continue with the release, you can dismiss the regression alert.

To dismiss an alert:

  1. Navigate to the rule with the regression on the flag's targeting page.
  2. Click Dismiss alert. The "Dismiss alert" dialog appears.
  3. Click Dismiss alert.

If LaunchDarkly detects another regression, you will receive another alert. If LaunchDarkly does not detect any additional regressions, the release will continue.

Edit metrics attached to a flag

To edit the metrics attached to a flag, click the pencil icon next to "Guarded rollout metrics" in the side panel:

The guarded rollout metrics on a flag, with pencil icon called out.
The guarded rollout metrics on a flag, with pencil icon called out.

Then, use the "Edit metrics" dialog to add or remove metrics from the flag.

Stop monitoring early

To stop monitoring before the monitoring window is over:

  1. From the flag's targeting page, click Stop monitoring. A "Stop rollout early" dialog appears.
  2. Choose which Variation to serve to all contexts after you stop monitoring. The field defaults to the control variation.
  3. Click Stop.

You can also use the REST API: Update feature flag