2898b77dd6
Previously, when you searched for 'stale toggle' in the docs, the first result would be the API docs and it'd be hard to find any form of explanation of what a stale toggle is at all. To combat that, this commit adds a section to the tech debt chapter explaining what they are.
3.6 KiB
| id | title |
|---|---|
| technical_debt | Technical Debt |
At Unleash we care deeply about code quality. Technical debt creeps up over time and slowly builds to the point where it really starts to hurt. At that point it's too late. Feature toggles that have outlived their feature and are not cleaned up represent technical debt that you should remove from your code.
Stale and potentially stale toggles
When a toggle is no longer useful, we say that it has become stale. A stale toggle is a toggle that has served its purpose and that you should remove from the code base. For a toggle to become stale, you have to explicitly mark it as such. You can mark a toggle as stale in the technical debt dashboard.
Unleash also has a concept of potentially stale toggles. These are toggles that have lived longer than what Unleash expects them to based on their feature toggle type. However, Unleash can't know for sure whether a toggle is actually stale or not, so it's up to you to make the decision on whether to mark it as stale or to keep it as an active toggle.
A toggle being (potentially) stale, does not affect how it performs in your application; it's only there to make it easier for you to manage your toggles.
The technical debt dashboard
In order to assist with removing unused feature toggles, Unleash provides a technical debt dashboard in the management-ui. You can find it by clicking on “Advanced” in the top-line menu then choose Reporting in the dropdown menu.
The dasboard includes a health report card, and a list of toggles that can be filtrated on different parameters.
Report card
The report card includes some statistics of your application. It lists the overall amount of your active toggles, the overall amount of stale toggles, and lastly, the toggles that Unleash believes should be stale. This calculation is performed on the basis of toggle types:
- Release - Used to enable trunk-based development for teams practicing Continuous Delivery. Expected lifetime 40 days
- Experiment - Used to perform multivariate or A/B testing. Expected lifetime 40 days
- Operational - Used to control operational aspects of the system's behavior. Expected lifetime 7 days
- Kill switch - Used to to gracefully degrade system functionality. (permanent)
- Permission - Used to change the features or product experience that certain users receive. (permanent)
If your toggle exceeds the expected lifetime of it's toggle type it will be marked as potentially stale.
One thing to note is that the report card and corresponding list are showing stats related to the currently selected project. If you have more than one project, you will be provided with a project selector in order to swap between the projects.
Health rating
Unleash calculates a project's health rating based on the project's total number of active toggles and how many of those active toggles are stale or potentially stale. When you archive a toggle, it no longer counts towards your project's health rating.
The health rating updates once every hour, so there may be some lag if you have recently added, removed, or changed the status of a toggle.
Toggle list
The toggle list gives an overview over all of your toggles and their status. In this list you can sort the toggles by their name, last seen, created, expired, status and report. This will allow you to quickly get an overview over which toggles may be worth deprecating and removing from the code.