Skip to content

Add: Zombie Flags Report Documentation #530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
464d13b
Add path to `sidebars.ts`
codedbychavez Apr 2, 2025
72b033c
Initial draft of My Zombie Flags Report
codedbychavez Apr 2, 2025
bfdebe0
Additional updates and screenshots
codedbychavez Apr 3, 2025
9360153
Add link to `website/src/pages/index.js`
codedbychavez Apr 3, 2025
c04ba28
Fix: https://github.com/configcat/docs/pull/530#discussion_r2030721387
codedbychavez Apr 7, 2025
cbfe2fb
Fix: https://github.com/configcat/docs/pull/530/files/936015325bc339b…
codedbychavez Apr 7, 2025
f780248
Fix: https://github.com/configcat/docs/pull/530/files/936015325bc339b…
codedbychavez Apr 7, 2025
ab2cfd5
Merge branch 'master' into add-zombie-flags-report-documentation
codedbychavez Apr 14, 2025
b97fd84
Merge branch 'master' into add-zombie-flags-report-documentation
codedbychavez Apr 14, 2025
240e164
Update website/docs/my-zombie-flags-report.mdx
codedbychavez Apr 17, 2025
0a42831
Update website/docs/my-zombie-flags-report.mdx
codedbychavez Apr 17, 2025
e862153
Apply suggestions from code review
codedbychavez Apr 17, 2025
e2e64a8
Update website/docs/my-zombie-flags-report.mdx
codedbychavez Apr 17, 2025
f3f2276
Add new section
codedbychavez Apr 17, 2025
d11fc03
Lint fixes
codedbychavez Apr 17, 2025
53f1f63
Fix bold text
codedbychavez Apr 17, 2025
e3cb4cc
Update
codedbychavez Apr 17, 2025
b40b4c4
Apply suggestions from code review
codedbychavez Apr 30, 2025
088b306
Apply suggestions from code review
codedbychavez May 12, 2025
4f681d0
Fix screenshots
codedbychavez May 12, 2025
e0fa908
Merge branch 'master' into add-zombie-flags-report-documentation
codedbychavez May 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions website/docs/my-zombie-flags-report.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: my-zombie-flags-report
title: My Zombie Flags Report
description: This page explains how to use The Zombie Flags Report to list all feature flags that weren't flipped for a while.
---

My Zombie Flags Report is a ConfigCat feature that helps you identify stale or unused feature flags—also known as zombie flags—in your projects. Removing these outdated flags can reduce technical debt, improve performance, and simplify your codebase.

## What Are Zombie (Stale) Feature Flags?

Zombie flags are feature flags that are no longer needed or actively used. They often remain in the codebase long after their purpose has been fulfilled.

Common scenarios where zombie flags appear:

- A temporary feature becomes permanent, but its flag is never removed.
- A flag was introduced for a one-time rollout or experiment that's now complete.
- A decision was made to always keep a feature on or off, making the flag redundant.
- The flag hasn't been toggled or referenced for an extended period.

## Why Removing Zombie Flags Matters

Leaving stale flags in your code can lead to:
- **Increased complexity:** Unused flags clutter code and reduce maintainability.
- **Unexpected behavior:** Outdated flags might trigger legacy logic unintentionally.
- **Longer onboarding and reviews:** Developers waste time reviewing obsolete logic.
- **Performance degradation:** In large-scale systems, excess flags can slow down operations.

## About the My Zombie Flags Report

My Zombie Flags Report scans your ConfigCat environments and identifies feature flags that haven't been updated or toggled within a specified timeframe. It highlights flags that are likely obsolete but still present in your source code or workflows.

### How to Set Up Zombie Feature Flags Report

1. Log in to your [ConfigCat dashboard](https://app.configcat.com/my-account/zombie-flags-report).
2. Click your Organization name in the top-right corner.
3. Select **My Zombie Flags Report** from the dropdown menu.

<img alt="Navigating to My Zombie Flags Report" src="/docs/assets/guide/my-zombie-flags-report/navigating-to-my-zombie-flags-report_192dpi.png" width="1366" height="768" decoding="async" loading="lazy" />

### Exploring the My Zombie Flags Report Page

On the My Zombie Flags Report page, you can customize the report to fit your workflow:

- **Receive Report via Email:** Get regular email updates with stale flag info.
- **Frequency:** Set how often you'd like to receive the report (e.g., weekly or monthly).
- **Criteria:** Define how long a flag must be inactive before it's marked as stale.
- **Scope:** Choose to include all feature flags or only the ones you're watching.
- **Environment:** Select the ConfigCat [environment](https://configcat.com/docs/main-concepts/#environment) for which you want to analyze flags.

<img alt="My Zombie Flags Report" src="/docs/assets/guide/my-zombie-flags-report/my-zombie-flags-report_192dpi.png" width="1366" height="850" decoding="async" loading="lazy" />

## Sample Email Report

Once your preferences are set, ConfigCat will email you a Zombie Flags Report. Here's a preview of what that report might look like:

<img alt="Zombie Flags Report Email" src="/docs/assets/guide/my-zombie-flags-report/zombie-flags-report-email_192dpi.png" width="1366" height="768" decoding="async" loading="lazy" />

## Other Tools for Identifying Unused Feature Flags

In addition to the My Zombie Flags Report, ConfigCat provides several tools to help you detect and clean up unused feature flags:

- [Scan & Upload Code References](https://configcat.com/docs/advanced/code-references/overview): Track where feature flags appear in your code.
- [The ConfigCat CLI](https://configcat.com/docs/advanced/cli): Detect flags still in your code that no longer exist in the ConfigCat Dashboard.
- [GitHub Action](https://configcat.com/docs/integrations/github/) and [CircleCI Orb](https://configcat.com/docs/integrations/circleci): Find feature flags in your code that you might want to remove.
1 change: 1 addition & 0 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ const sidebars: SidebarsConfig = {
},
],
},
'my-zombie-flags-report',
{
label: 'Migration from LaunchDarkly',
type: 'category',
Expand Down
1 change: 1 addition & 0 deletions website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const features = [
{ url: 'network-traffic', title: 'Network Traffic' },
{ url: 'purchase', title: 'Plans, Purchase & Billing' },
{ url: 'organization', title: 'Organization & Roles' },
{ url: 'my-zombie-flags-report', title: 'Zombie (stale) feature flags' },
{ url: 'news', title: 'News & Product Updates' },
{ url: 'faq', title: 'FAQ' },
{ url: 'glossary', title: 'Glossary' },
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.