DORA metric monitoring for your team in just 15 minutes with Apache Dev Lake
Tags: github, development, productivity
Published: 2022-10-16 20:55:48

---
title: DORA metric monitoring for your team in just 15 minutes with Apache Dev Lake
published: true
date: 2022-10-16 17:12:33 UTC
tags: #github #development #productivity
canonical_url: https://www.darraghoriordan.com/2022/10/16/report-on-dora-metrics-apache-dev-lake/
---

DORA (DevOps Research and Assessment) metrics are an excellent way for engineering organisations to measure and improve their performance.

Up until now, monitoring the DORA metrics across Github, Jira, Azure Devops etc required custom tooling or a tedious manual process.

With Apache Dev Lake you can get beautiful reporting for DORA metrics on your local machine in as little as 15 minutes (honestly!).

[![From Google Sheets to Grafana](https://www.darraghoriordan.com/static/8c01179a7caa6efd47c6ba2c3267ca15/acf8f/headerJourney.png "From Google Sheets to Grafana")](/static/8c01179a7caa6efd47c6ba2c3267ca15/4b538/headerJourney.png)
_From Google Sheets to Grafana_

<!-- end excerpt -->
## DORA Metrics

DORA metrics are 4 dimensions for improving your engineering team. The metrics came out of a report by Google in 2020. They’re designed so they balance velocity and stability.

- Deployment Frequency
- Lead time for changes
- Median Time to Restore Service
- Change Failure Rate

These metrics are explained in detail in books ([here](https://www.amazon.com.au/Accelerate-Software-Performing-Technology-Organizations/dp/1942788339)) and blogs ([here](https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance)) so I won’t go in to any detail on what they are here.

I have a note at the end of this article on updates to DORA since 2020 and the newer Microsoft SPACE framework.

## The old way of tracking DORA metrics

Most teams will have various support systems like Github, Azure DevOps, Jira etc.

Extracting the metrics required for DORA across so many developer tools is difficult to automate without custom software. The time cost is too much, especially for small teams.

When I first started tracking DORA I used a spreadsheet and did everything manually.

It wasn’t pretty and it was a lot of work but I was able to see a noticeable increase in deployed work when deployment frequency increased.

[![Custom spreadsheet of DORA metrics](https://www.darraghoriordan.com/static/ce4389ab9ddacdd6fd5afeabc820c0a2/e3f06/manualDora.jpg "Custom spreadsheet of DORA metrics")](/static/ce4389ab9ddacdd6fd5afeabc820c0a2/e3f06/manualDora.jpg)
_Custom spreadsheet of DORA metrics_

## Tracking DORA metrics in 2022: Apache Dev Lake

Apache Dev Lake is a project from the Apache Foundation specifically for tracking engineering performance metrics.

The project is new and it is in the incubation stage at the Apache Foundation.

Dev Lake is a set of services in containers - a database, a data pipeline, a grafana instance with pre-built reports and a configuration web application.

The dev lake team provide helm charts and docker compose files for easy setup of the infrastructure.

The benefits of tracking your DORA metrics in Dev Lake are:

- It connects to most major platforms out of the box (Jira, Github, DevOps)
- Comes with pre built Grafana charts for DORA and many other metrics
- Free and you can easily run it locally to get started
- Your data or your client’s data never leaves your organisation

Having the data processed and stored locally is a huge benefit for many organisations. It means you don’t have to add an additional supplier to get started with DORA metrics.

Visit the [dev lake site](https://devlake.apache.org/) for more details.

## Setting up a local instance of Apache Dev Lake

You should have docker desktop installed before continuing.

1. Get the docker compose and .env files from the releases page - [https://github.com/apache/incubator-devlake/releases/latest](https://github.com/apache/incubator-devlake/releases/latest) and place them in a folder
2. Open a terminal in that folder and `mv .env.example .env`
3. `docker compose up`
4. That’s it! Wait for the 4 services to start
5. You should be able to access the configuration site at [https://localhost:4000](https://localhost:4000)

[![The Dev Lake homepage](https://www.darraghoriordan.com/static/d4793f39291bd42e3d916bb044ed2dc1/acf8f/blueprints.png "The Dev Lake homepage")](/static/d4793f39291bd42e3d916bb044ed2dc1/1d94f/blueprints.png)
_The Dev Lake homepage_

There are some sites already configured on the instance in the image above. Yours will be empty for now.

Now you can add any connections to your engineering tools like Jira or Github.

## Adding connections to common dev tools

Github is very popular so let’s use that to demonstrate setting up a tool connection.

1. Click on Data Connections > Github
2. Give the connection a name you’ll remember
3. The endpoint is `https://api.github.com/` unless you have a special enterprise account - then you’ll need to use your own endpoint
4. Get a personal access token from Github and paste it in the token field ([https://github.com/settings/tokens](https://github.com/settings/tokens))

The PAT permissions you need are:

- `repo:status`
- `repo_deployment`
- `public_repo`
- `repo:invite`
- `read:user`
- `read:org`

I set the github rate limit to 5000 requests per hour but you can leave that as default if you like.

[![Adding a Github connection](https://www.darraghoriordan.com/static/4aae45c7e2e23b79d2173cc331fd5674/acf8f/addGithubconnection.png "Adding a Github connection")](/static/4aae45c7e2e23b79d2173cc331fd5674/1d94f/addGithubconnection.png)
_Adding a Github connection_

## Configuring projects in Dev Lake

Now that you have a connection to your dev tools you can configure projects. In Dev Lake a project is called a “Blueprint”.

I’ll add one of my open source projects ([https://github.com/darraghoriordan/eslint-plugin-nestjs-typed](https://github.com/darraghoriordan/eslint-plugin-nestjs-typed)) to show how it works.

1. Click on Blueprints > Add Blueprint in the main left-hand menu
2. Give it a name and select the Github connection you created earlier

[![Add blueprint screen - summary](https://www.darraghoriordan.com/static/b06b0a7bd07946f804e0fe1cb143e29f/acf8f/addingBlueprintScreen1.png "Add blueprint screen - summary")](/static/b06b0a7bd07946f804e0fe1cb143e29f/36405/addingBlueprintScreen1.png)
_Add blueprint screen - summary_

1. Click next and enter the name of the repo(s) associated with your project

[![Add blueprint screen - repository](https://www.darraghoriordan.com/static/1c70ca6cd571d66801fe415f484307d2/acf8f/addingBlueprintScreen2.png "Add blueprint screen - repository")](/static/1c70ca6cd571d66801fe415f484307d2/9e9da/addingBlueprintScreen2.png)
_Add blueprint screen - repository_

1. Click next and on the summary screen click on the “add transformation” link. You have to tell Dev Lake how to identify deploys and incidents for your setup.

[![Add blueprint screen - optional transformation](https://www.darraghoriordan.com/static/6d73ee73b695c7a3efc04374bcdf1a93/acf8f/AddingBlueprintScreen3.png "Add blueprint screen - optional transformation")](/static/6d73ee73b695c7a3efc04374bcdf1a93/5c4aa/AddingBlueprintScreen3.png)
_Add blueprint screen - optional transformation_

1. On the add transformation screen you have to configure the tag you use on a Github issue that identifies an incident and the Github actions `Job` that identifies a deploy.

[![Add blueprint screen - adding transformation](https://www.darraghoriordan.com/static/e16997929c85b3b07dc8315fec72d236/acf8f/addingTransformation.png "Add blueprint screen - adding transformation")](/static/e16997929c85b3b07dc8315fec72d236/f349c/addingTransformation.png)
_Add blueprint screen - adding transformation_

For the deployment section make sure that you’re getting the Job name and not the workflow name.

To get the job name on Github, click into an old run of your workflow and you’ll see the job name on the left hand side.

[![Github actions settings for transformation](https://www.darraghoriordan.com/static/ebd095240afa06471df5bb60cd0a0036/acf8f/githubJob.png "Github actions settings for transformation")](/static/ebd095240afa06471df5bb60cd0a0036/f36fd/githubJob.png)
_Github actions settings for transformation_

1. Click on “save and run now” and you should be done configuring Dev Lake. Wait for the blueprint data collection run to complete.

You can open the Blueprints page anytime and click on the graph “squiggle” icon to open the blueprint overview for your project.

[![Eslint for NestJs Blueprint overview](https://www.darraghoriordan.com/static/34ac926bdceb095da93cd4050735a363/acf8f/projectBlueprint.png "Eslint for NestJs Blueprint overview")](/static/34ac926bdceb095da93cd4050735a363/99e81/projectBlueprint.png)
_Eslint for NestJs Blueprint overview_

The status overview allows you to see the status of the data pipeline for your project.

## Configuring Sync Settings for Local

Because this is a local instance you can go to settings and change the sync frequency to “Manual”.

This isn’t required but makes sense for local instances.

Then you can use the blueprint status page and the “Run Now” button to manually get the latest data when you need to.

## Viewing the DORA metrics

Ok so now that you have all the data downloaded, filtered and transformed into the DORA metrics you can view them in Grafana.

Click on the “Dashboard” menu button to open Grafana.

Then click on the magnifying glass icon in the left-hand menu to open the search bar.

Search for “DORA” and you should see a dashboard called “DORA”.

[![DORA dashboard on Grafana](https://www.darraghoriordan.com/static/41afddff21de43306c633e79cbd2234d/acf8f/doraDisplay.png "DORA dashboard on Grafana")](/static/41afddff21de43306c633e79cbd2234d/669cd/doraDisplay.png)
_DORA dashboard on Grafana_

The image is the metrics for my small open source project. I update it once a month maybe. The users do report issues occasionally so I guess now I’ll have to fix them in a bit quicker!

You can filter to a specific Github Repo if you added more than one.

Along with DORA there are 10-20 other pre-built reports you can access. Here’s one for Github stats.

[![Github engineering report on Grafana](https://www.darraghoriordan.com/static/34fdcf68ee788982943d6d3a9e395181/acf8f/githubReporting.png "Github engineering report on Grafana")](/static/34fdcf68ee788982943d6d3a9e395181/669cd/githubReporting.png)
_Github engineering report on Grafana_

## SaaS Platforms for DORA Metrics

It’s important to mention that there are some excellent platforms for tracking DORA and more metrics if you want more mature, managed applications with support.

### Multitudes

Multitudes tracks DORA but supplements engineering metrics with around well-being and collaboration.

More details on the [multitudes site](https://www.multitudes.co/our-product).

[![Multitudes marketing page](https://www.darraghoriordan.com/static/8ed22e3ce7403d61fed2b41a7167a0ad/84bf8/multitudes.png "Multitudes marketing page")](/static/8ed22e3ce7403d61fed2b41a7167a0ad/84bf8/multitudes.png)
_Multitudes marketing page_

### Linear B

LinearB tracks DORA metrics and helps you fix workflow issues.

More details on the [LinearB site](https://linearb.io/dora-metrics/).

[![LinearB marketing page](https://www.darraghoriordan.com/static/4921441c6aa4e2338591d96b91290115/6acbf/linearb.png "LinearB marketing page")](/static/4921441c6aa4e2338591d96b91290115/6acbf/linearb.png)
_LinearB marketing page_

## Developments in Engineering and DevOps Metrics since DORA 2020

There have been developments since these metrics were first published in 2020 and it’s a rapidly changing, exciting space.

The DevOps report of 2022 changed the categorisation to “Low, Medium, High”, removing the “elite” name.

They also added a 5th dimension to DORA for reliability.

Microsoft released their SPACE metrics paper in 2021 and arguably they are much more human focused which is great.

It’s worth reading the microsoft docs for SPACE and the Future of Work Report - [https://www.microsoft.com/en-us/research/publication/the-space-of-developer-productivity-theres-more-to-it-than-you-think/](https://www.microsoft.com/en-us/research/publication/the-space-of-developer-productivity-theres-more-to-it-than-you-think/)

## Conclusion

It’s easier than ever to track your DORA metrics. You can use a local instance of Apache Dev Lake or a SaaS platform like Multitudes or LinearB.

If you’re interested in tracking DORA metrics in your organisation, I’d recommend starting with a local instance of Dev Lake. It’s free and you can get started in minutes.

Like anything, don’t over do it with these metrics. They’re just a tool to help you improve your engineering practices. They shouldn’t be used as a KPI.