- Feb 28 2023 - Released Heartbeat - 0.9.0
- July 27 2023 - Release Heartbeat - 1.0.0
- Oct 9 2023 - Release Heartbeat - 1.1.0
- Nov 6 2023 - Release Heartbeat - 1.1.2
- Nov 21 2023 - Release Heartbeat - 1.1.3
- Dev 4 2023 - Release Heartbeat - 1.1.4
Heartbeat is a tool for tracking project delivery metrics that can help you get a better understanding of delivery performance. This product allows you easily get all aspects of source data faster and more accurate to analyze team delivery performance which enables delivery teams and team leaders focusing on driving continuous improvement and enhancing team productivity and efficiency.
State of DevOps Report is launching in 2019. In this webinar, The 4 key metrics research team and Google Cloud share key metrics to measure DevOps performance, measure the effectiveness of development and delivery practices. They searching about six years, developed four metrics that provide a high-level systems view of software delivery and performance.
Here are the four Key meterics:
- Deployment Frequency (DF)
- Lead Time for changes (LTC)
- Mean Time To Recover (MTTR)
- Change Failure Rate (CFR)
In Heartbeat tool, we also have some other metrics, like: Velocity, Cycle Time and Classification. So we can collect DF, LTC, CFR, Velocity, Cycle Time and Classification.
For MTTR meter, specifically, if the pipeline stay in failed status during the selected period, the unfixed part will not be included for MTTR calculation.
Here is the user manaul for Version 1 on 2020/06. For now, we just can support Jira/Buildkite/Github to generate the corresponding metrics data.
| Type | Board | Pipeline | Repo |
|---|---|---|---|
| Support tools | Jira √ Trello × |
Buildkite √ Teamcity × GoCD × |
Github √ Bitbucket × |
Note： “√” means can support, “×” means can not support
Before generator the metrics data, user need to config the project info, in Home page (Image3-1), you can create a new project for your project, or you can import a project config json file (If you already saved one config file, for import file feature will introduce in “Import and Export feature ”).
Image 3-1，home page
If you are first use the product, you need to select “Create A New Project”，it will go to config page (Image 3-2)
Image 3-2，Project config page
Users need to select a period of time, then all of the data that follows is based on that time period.
Have two items of time period:
- Regular Calendar(Weekend Considered): If you select this item, it means all data will exclude the weekend.
- Calendar with Chinese Holiday: If you select this item, it means all data will exclude the weekend and Chinese holiday. So if the time period you selected contains Chinese holiday, you need to select this item.
All need to select which data you want to get, for now, we support seven metrics data (Image 3-3). Those seven metrics are Deployment Frequency (DF), Lead Time for changes (LTC), Mean Time To Recover (MTTR), Change Failure Rate (CFR), and Velocity, Cycle time, Classification, where
Velocity: includes how many story points and cards we have completed within selected time period.Cycle time: the time it take for each card start to do until move to done.Classification: provide different dimensions to view how much efforts team spent within selected time period.
Image 3-3，Metrics Data
Because all metrics data from different tools that your projects use. Need to have the access to these tools then you can get the data. So after select time period and metrics data, then you need to input the config for different tools(Image 3-4).
According to your selected required data, you need to input account settings for the respective data source. Below is the mapping between your selected data to data source.
| Required Data | Datasource |
|---|---|
| Velocity | Board |
| Cycle time | Board |
| Classification | Board |
| Lead time for changes | Repo，Pipeline |
| Deployment frequency | Pipeline |
| Change failure rate | Pipeline |
| Mean time to recovery | Pipeline |
Image 3-4，Project config
The details for board:
| Items | Description |
|---|---|
| Board Type | Support two types of board: Classic Jira and Next-gen Jira |
| Board Id | The value of BoardId is number. You need to find it from your team’s Jira board URL. For Example: 1. Your jira board URL like below, then 2 is the boardId https://dorametrics.atlassian.net/jira/software/projects/ADM/boards/2 2. Your jira board URL like below, then rapidView=3, 3 is the boardId https://pokergame.atlassian.net/secure/RapidBoard.jspa?projectKey=KAN1&useStoredSettings=true&rapidView=3 |
| ProjectKey | You can find it from your team’s Jira board URL. For Example: 1. Your jira board URL like below, then ADM is the projectkey https://dorametrics.atlassian.net/jira/software/projects/ADM/boards/2 2. Your jira board URL like below, then projectKey is KAN1 https://pokergame.atlassian.net/secure/RapidBoard.jspa?projectKey=KAN1&useStoredSettings=true&rapidView=3 |
| Site | Site is the domain for your jira board, like below URL, dorametrics is the site https://dorametrics.atlassian.net/jira/software/projects/ADM/boards/2 |
| The email can access to the Jira board | |
| Token | Generate a new token with below link, https://id.atlassian.com/manage-profile/security/api-tokens |
The details for Pipeline:
| Items | Description |
|---|---|
| PipelineTool | The pipeline tool you team use, currently heartbeat only support buildkite |
| Token | Generate buildkite token with below link, https://buildkite.com/user/api-access-tokens |
The details for SourceControl:
| Items | Description |
|---|---|
| SourceControl | The source control tool you team use, currently heartbeat only support Github |
| Token | Generate Github token with below link(classic one), https://github.com/settings/tokens |
After inputting the details info, users need to click the Verify button to verify if can access to these tool. Once verified, they could click the Next button go to next page -- Config Metrics page(Image 3-5，Image 3-6，Image 3-7)
Image 3-5, Crews/Cycle Time config
Crew Settings: You could select your team members from a list get from board source. The list will include the assignees for those tickets that finished in the time period selected in the last step.
Cycle Time: It will list all columns for the current active jira board. Then users need to map the each column to the supported columns. Like, if your board have “in progress” column, it means developer doing this ticket, so it should be mapping with “In Dev” for the list we provide.
| Status | Description |
|---|---|
| To do | It means the ticket needs to be done, waiting for Dev to pick it. Cycle time doesn't include this time. |
| Analysis | BA or other people still need to analyze the ticket. Cycle time doesn't include this time. |
| In Dev | It means dev is doing the ticket. This time should be a part of cycle time. And it is named development time. |
| Block | It means the tickets blocked by some issues, cannot be done now. This time should be a part of cycle time. And it is named block time. |
| Waiting for testing | It means waiting for Dev to pick or QA to testing. This time should be a part of cycle time. And it is named waiting time. |
| Testing | It means QA is testing the tickets. This time should be a part of cycle time. And it is named testing time. |
| Review | It means PO or other people are reviewing the tickets. This time should be a part of cycle time. And it is named review time. |
| Done | It means the tickets are already done. Cycle time doesn't include this time. |
| -- | If you don't need to map, you can select -- |
Image 3-6，Classification Settings
In classification settings, it will list all Context fields for your jira board. Users can select anyone to get the data for them. And according to your selection, in the export page, you will see the classification report to provide more insight with your board data.
Image 3-7，Settings for Pipeline
They are sharing the similar settings which you need to specify the pipeline step so that Heartbeat will know in which pipeline and step, team consider it as deploy to PROD. So that we could use it to calculate metrics.
| Items | Description |
|---|---|
| Organization | The organization for your pipelines |
| Pipeline Name | Your pipeline name |
| Steps | The pipeline step that consider as deploy to PROD |
When user first use this tool, need to create a project, and do some config. To avoid the user entering configuration information repeatedly every time, we provide a “Save” button in the config and metrics pages. In config page, click the save button, it will save all items in config page in a Json file. If you click the save button in the metrics page, it will save all items in config and metrics settings in a Json file. Here is the json file (Image 3-8)。Note: Below screenshot just contains a part of data.
Image 3-8, Config Json file
When user already saved config file before, then you don’t need to create a new project. In the home page, can click Import Project from File button(Image 3-1) to select the config file. If your config file is too old, and the tool already have some new feature change, then if you import the config file, it will get some warning info(Image 3-9). You need to re-select some info, then go to the next page.
Image 3-9, Warning message
After config, then it will generate the report for you.
In Velocity Report, it will list the corresponding data by Story Point and the number of story tickets. (image 3-10)
Image 3-10，Velocity Report
The calculation process data and final result of Cycle Time are calculated by rounding method, and two digits are kept after the decimal point. Such as: 3.567... Is 3.56; 3.564... Is 3.56.
Image 3-11，Cycle Time Report
It will show the classification data of Board based on your selection on Classification Settings in metrics page.
The percentage value represent the count of that type tickets vs total count of tickets.
Image 3-12，Classification Report
Image 3-13，Deployment Frequency Report
Image 3-14，Lead time for changes Report
Image 3-15，Change Failure Rate Report
After generating the report, you can export the original data for your board and pipeline (Image 3-15). Users can click the “Export board data” or “Export pipeline data” button to export the original data.
It will export a csv file for board data. It contains two parts: Part 1: Export the all done tickets during the time period Part 2: Export the all non-done tickets in your current active board. And it will order by ticket status (Image 3-16)
Image 3-16，Exported Board Data
All columns for Jira board:
| Column name | Description |
|---|---|
| Issue key | Ticket ID |
| Summary | -- |
| Issue Type | -- |
| Status | -- |
| Story Point | -- |
| Assignee | -- |
| Reporter | -- |
| Project Key | -- |
| Project Name | -- |
| Priority | -- |
| Parent Summary | The epic for ticket |
| Sprint | Which sprint this ticket in |
| Labels | -- |
| Cycle Time | total Cycle Time |
| Cycle Time / Story Points | Cycle Time for each point |
| Analysis Days | Analysis days for each ticket |
| In Dev Days | Development days for each ticket |
| Waiting Days | After development, how long will take before testing |
| Testing Days | Testing days for each ticket |
| Block Days | Blocked days for each ticket |
| Review Days | -- |
| Original Cycle Time: {Column Name} | The data for Jira board original data |
It will export a csv file for pipeline data (image 3-17).
Image 3-17，Exported Pipeline Data
All columns for pipeline data:
| Column name | Description |
|---|---|
| Pipeline Name | -- |
| Pipeline Step | Step name |
| Committer | -- |
| Code Committed Time | Committed time |
| PR Created Time | -- |
| PR Merged Time | -- |
| Deployment Completed Time | When it finished deploy |
| Total Lead Time (mins) | -- |
| PR lead time (mins) | -- |
| Pipeline lead time (mins) | -- |
| Status | Status for pipeline (Pass or Failed) |
In the current version, if you add or delete some columns for the jira board, it will change finish time for all last column tickets to add/delete column time. (It just impact Next-gen Jira), here are the details info:
| Jira Template | Add column | Delete column |
|---|---|---|
| Kanban | It will change finish time for all last column tickets to add/delete column time | If delete non-last column: It will change finish time for all last column tickets to add/delete column time If delete the last column: It will change finish time for current last column tickets to add/delete column time |
| Scrum | finish time for all last column tickets to add/delete column time All finished ticket’s finish time changed to add/delete column time |
If delete the last column: It will change finish time for current last column tickets to add/delete column time |
In case that not only your team but also other team was contributing on the same repo and pipeline, the metrics (Lead time for change, deployment frenquency, change failure rate, mean time to recovery) might not be as accurate which might include the other team's contribution. Because currently Heartbeat could't not differentiate which pipeline trigger by your team or other team within specified time range. The feature is still under development.
Currently the calculated metrics for change failure rate might not be precise in some scenarios. And MTTR is still under development.
As an administrator of the jira board, if you modify the workflow to change the status name, it will affect the calculation of duration for cards in that status. Considering the potential loss of duration, changing the status name can lead to loss of precision in cycle time calculation for related cards.
For Classic Jira users, before you use this tool, you need to do some settings for the jira board. Otherwise, you cannot get the data. Here are the steps you need to do:
-
Open https://{site}.atlassian.net/secure/admin/ViewIssueFields.jspa?start=0&searchFilter=
Image 5-1 -
You need to enable any items you want to know. In the above page, If you want to change any items' screens, you can click the screens link in the actions column for that item. Then in the next page, check the project you want to change, and update it. Like: Story points
-
Image 5-2 -
Image 5-3
For the next-gen Jira, when you add story points item, the name should be Story Points or Story point estimate.
For now, we just can download the code in our local machine, please follow below steps:
- Clone the backend code in your local machine: https://github.com/thoughtworks/HeartBeat/
- Follow the steps as below
cd HearBeat/frontend
pnpm install
pnpm start
pnpm build
pnpm preview
pnpm test
pnpm coverage
- Start the mock server
cd HearBeat/stubs
docker-compose up -d
- Start the backend service
cd HearBeat/backend
./gradlew bootRun --args='--spring.profiles.active=local --MOCK_SERVER_URL=http://localhost:4323'
- Start the frontend service
cd HearBeat/frontend
pnpm start
- Run the e2e tests
cd HearBeat/frontend
pnpm e2e
-
Add
[stub]tag to the title of a commit message or PR to trigger stub-related deployments. -
Add
[infra]tag to the title of the commit message or PR to trigger infra-related deployments. -
Add
[backend]tag to the title of the commit message or PR to trigger backend-related deployments. -
Add
[frontend]tag to the title of the commit message or PR to trigger frontend-related deployments. -
Add
[docs]tag to the title of the commit message or PR to trigger docs-related deployments.
Release version follows Software release life cycle
git tag {tag name}
git push origin {tag name}
# Delete tag
git tag -d {tag name}
git push origin :refs/tags/{tag name}First, create a docker-compose.yml file, and copy below code into the file.
version: "3.4"
services:
backend:
image: ghcr.io/au-heartbeat/heartbeat_backend:latest
container_name: backend
ports:
- 4322:4322
restart: always
frontend:
image: ghcr.io/au-heartbeat/heartbeat_frontend:latest
container_name: frontend
ports:
- 4321:80
depends_on:
- backend
restart: alwaysThen, execute this command
docker-compose up -d frontendSpecifically, story point field can be indicated in docker-compose.yml. You can do it as below.
version: "3.4"
services:
backend:
image: ghcr.io/au-heartbeat/heartbeat_backend:latest
container_name: backend
ports:
- 4322:4322
restart: always
environment:
STORY_POINT_KEY: customfield_10061
frontend:
image: ghcr.io/au-heartbeat/heartbeat_frontend:latest
container_name: frontend
ports:
- 4321:80
depends_on:
- backend
restart: always