Heartbeat Project

• Heartbeat Project
• News
• 1 About Heartbeat
• 2 Support tools
• 3 Product Features
  • 3.1 Config project info
    • 3.1.1 Config Board/Pipeline/Source data
      • 3.1.2 Config search data
        • 3.1.2.1 Date picker validation rules
      • 3.1.3 Config project account
        • 3.1.3.1 Guideline for generating Jira token
        • 3.1.3.2 Guideline for generating Buildkite token
        • 3.1.3.3 Guideline for generating GitHub token
        • 3.1.3.4 Authorize GitHub token with correct organization
    • 3.2 Config Metrics data
      • 3.2.1 Config Crews/Board Mappings
      • 3.2.2 Setting Classification
      • 3.2.3 Rework times Setting
      • 3.2.4 Setting advanced Setting
      • 3.2.5 Pipeline configuration
  • 3.3 Export and import config info
    • 3.3.1 Export Config Json File
    • 3.3.2 Import Config Json File
  • 3.4 Generate Metrics report
    • 3.4.1 Velocity
    • 3.4.2 Cycle Time
    • 3.4.3 Classification
    • 3.4.4 Rework
    • 3.4.5 Deployment Frequency
    • 3.4.6 Lead time for changes Data
    • 3.4.7 Dev Change Failure Rate
    • 3.4.8 Dev Mean time to recovery
  • 3.5 Export original data
    • 3.5.1 Export board data
      • 3.5.1.1 Done card exporting
      • 3.5.1.1 Undone card exporting
    • 3.5.2 Export pipeline data
  • 3.6 Caching data
• 4 Known issues
  • 4.1 Change status name in Jira board setting when there are cards in this status
• 5 Instructions
  • 5.1 Prepare for Jira Project
  • 5.2 Prepare env to use Heartbeat tool
• 6 Run Heartbeat
  • 6.1 How to run frontend
  • 6.1.1 How to build and local preview
  • 6.1.2 How to run unit tests
  • 6.1.3 How to generate a test report
  • 6.1.4 How to run E2E tests locally
  • 6.2 How to run backend
• 7 How to trigger BuildKite Pipeline
  • Release
    • Release command in main branch
• 8 How to use
  • 8.1 Docker-compose
    • 8.1.1 Customize story point field in Jira
    • 8.1.2 Multiple instance deployment
  • 8.2 K8S
    • 8.2.1 Multiple instance deployment
• 9 Contribution
• 10 Pipeline Strategy

News

• 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
• Feb 29 2024 - Release Heartbeat - 1.1.5
• Apr 2 2024 - Release heartbeat - 1.1.6

1 About Heartbeat

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. Based on that, Heartbeat introduce below metrics as below.

8 metrics supported by heartbeat:

1. Velocity
2. Cycle time
3. Classification
4. Rework
5. Deployment Frequency
6. Lead Time for changes
7. Dev Change Failure Rate
8. Dev Mean Time To Recovery

2 Support tools

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 √ </br> Trello × | Buildkite √ </br>Teamcity × </br> GoCD × | Github √ </br> Bitbucket × |

Note： “√” means can support, “×” means can not support

3 Product Features

3.1 Config project info

3.1.1 Config Board/Pipeline/Source data

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

3.1.2 Config search data

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:

1. Regular Calendar(Weekend Considered): If you select this item, it means all data will exclude the weekend.
2. 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 spe