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

Draft
wants to merge 26 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
26 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
68d3f38
Update link to Zombie Flag document in `sidebar.js` and `website/src/…
codedbychavez May 21, 2025
dbbd3b9
Add notes
codedbychavez May 21, 2025
608c359
Add: updated screenshots and instruction notes #1
codedbychavez May 22, 2025
a1c002b
Updates
codedbychavez May 23, 2025
ce98ec0
Add: Zombie flag report email screenshot and update documentation.
codedbychavez May 27, 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
47 changes: 47 additions & 0 deletions website/docs/my-zombie-flags-report.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
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.
---

Zombie flags are feature flags that are no longer needed or rarely used. Over time, they contribute to technical debt and, if unmanaged, may cause unintended errors or issues.

Here are a few ways zombie flags can form:

- A flag was initially tied to a feature that has since become permanent and is no longer controlled by the flag.

- A decision was made to keep a feature on or off, yet the flag still lingers in your code or DevOps workflow.

- The flag was used for a one-time deployment, but the rollout is over.

- You haven't toggled the flag in a long time.

## Managing Zombie Flags

The Zombie Flags (Stale Flags) Report lists all feature flags that weren't flipped for a while. There is a high chance these flags are not needed anymore but are still referenced in your source code, and ConfigCat recommends removing these flags to avoid tech debt.

### Setting Up the Zombie Feature Flags Report

Login to your [ConfigCat dashboard](https://app.configcat.com), click your Organization name at the top right, then select **My Zombie Flags Report**.

<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="1224" decoding="async" loading="lazy" />

Here is what the **My Zombie Flags Report** page looks like:

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

Here, you could enable the **Receive report via email** option and select how often the report should be sent by setting the **Frequency**. The **Criteria** option sets how long a flag should be inactive before it is considered stale. Use the **Scope** option to select which flags should be in the report. You can decide if you want the report to include all your feature flags or only the ones you are explicitly watching. Lastly, select the **environment**.

## Demo

Based on your Stale Flags Report settings, the email you receive should look something like this:

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

## Other Tools for Identifying Unused Feature Flags

Here are some alternative ways to identify zombie flags:

- [Scan & Upload Code References](https://configcat.com/docs/advanced/code-references/overview) to track feature flags in your code.
- [The ConfigCat CLI](https://configcat.com/docs/advanced/cli) finds feature flags in your code that were removed from the 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'
],
},
{
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.