Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DevoteamNL/opendora
Team performance insights for your organization.
https://github.com/DevoteamNL/opendora
Last synced: 7 days ago
JSON representation
Team performance insights for your organization.
- Host: GitHub
- URL: https://github.com/DevoteamNL/opendora
- Owner: DevoteamNL
- License: gpl-3.0
- Created: 2023-03-31T07:00:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-29T08:14:01.000Z (6 months ago)
- Last Synced: 2024-05-29T20:48:49.611Z (6 months ago)
- Language: Go
- Homepage:
- Size: 2.03 MB
- Stars: 42
- Watchers: 4
- Forks: 5
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@devoteam-nl/open-dora-backstage-plugin)
# OpenDORA
_Team performance observability for your organization._
OpenDORA includes an open-source plugin for [Backstage](https://backstage.io), a popular developer portal platform. It integrates with [Apache DevLake](https://devlake.apache.org) to organize and aggregate data from deployment and project management tooling like Gitlab, GitHub, Jira, and Jenkins. OpenDORA extracts meaningful insights from this data through its API, and renders dashboards within Backstage that provide insights on the teams' performance.
## What are DORA metrics?
DORA, short for [DevOps Research and Assessment](https://dora.dev), is a research program that began in 2013 investigating ways to measure and improve software delivery, operations, team, and organizational performance. The program has collected data from thousands of professionals and [publishes findings in annual reports](https://dora.dev/publications/).
The key [4 DORA metrics](https://dora.dev/guides/dora-metrics-four-keys/) are:
- Deployment frequency
- Lead time to changes
- Change failure rate
- Mean time to recovery
Today, DORA metrics are widely accepted as a framework to determine stability and velocity of software teams. They provide a benchmark for determining the maturity of software teams, helping set a path towards high performance.
## How does it work?
OpenDORA has largely a pluggable architecture, with some opinionated tooling choices that we can talk about at length. Ingestor scripts running on schedule fetch data from external tools (Gitlab, Jira, etc) and push them to DevLake. The `devlake-go` API exposes this data and provides endpoints to retrieve it from DevLake. The `backstage-plugin` utilizes this API and renders the results on the Backstage frontend. This is a React plugin based on Material UI.
The resulting dashboard as rendered within Backstage:
Below is a description of the main components of this repo.
### backstage-plugin
This is a [Backstage](https://backstage.io) plugin setup used to develop the frontend plugin.
[More details](backstage-plugin/README.md)
### devlake-go
This contains the docker image and configuration scripts to setup DevLake to properly ingest the DORA metrics from a GitLab repo and group them according to Backstage groups.
[More details](devlake-go/README.md)
### dora-api-mock
This is a basic Spring application used to provide a mock for the DORA API metric datapoints. This can be used to develop the frontend plugin without needing to setup the local backend API.
[More details](dora-api-mock/README.md)
## Setup
Goto [Plugin setup documentation](backstage-plugin/plugins/open-dora/README.md) and follow the steps to install and setup the plugin in your Backstage environment.
## Contributor Guide
The OpenDORA team are looking for feedback and contributions. We encourage you to try out the Backstage plugin or other parts of the solution. Please create an issue on GitHub or reach out to us at [email protected].
We also accept pull requests for the code and documentation. Kindly use the discussions in the issue, and please read the [contribution guidelines](CONTRIBUTING.md) page.
# DORA Plugin Development Environment
## Prerequisites
- Docker Runtime
- Docker Compose
## Configuring the Environment
### Running the Dev Environment
OpenDORA contains an initial Docker Compose with the services needed to test the metrics in the dev's local environment.
- Make sure you have copied the .env.dist to .env. The .env is in .gitignore because it contains secrets and custom configuration
```shell
cp .env.dist .env
```
- Run the Docker environment with Docker Compose v2.*
```shell
docker compose --profile dev up -d
```
It may take some time for all the containers to be available. Healthchecks to monitor this are not available right now.
- When using the development profile. There won't be a Devlake available to manage. Instead, It will use a mock-api to create responses. If you want to test Opendora with a Devlake instance, use the `test` profile.
```shell
docker compose --profile test up -d
```
- A Grafana container is also available in case you want to access the default dashboards delivered with Apache DevLake.
To start it, run the below:
```shell
docker compose --profile dashboard up -d
```
After that, the services will be accessible on the below:
- DevLake Configuration UI: http://localhost:4000
- Grafana Dashboards (if started with profile `dashboard`): http://localhost:3002 (initial credential: `admin`/`admin`)
For more information about Docker Compose, check their official documentation: [Docker Compose](https://docs.docker.com/compose/)
### Apache DevLake
Before running the Dev Environment, some minor configurations needs to be performed. This development environment
already provides default values for the majority of them but at least an encryption key (`DEVLAKE_ENCRYPTION_SECRET`) needs to be provided.
To generate one, run the below:
```shell
openssl rand -base64 2000 | tr -dc 'A-Z' | fold -w 128 | head -n 1
```
It can be configured globally, and it will be picked up by the docker compose, or it can be added to the `.env` file.
Some environment variables can be customised. The list below has all of them as well as their default values:
| Variable Name | Default Value |
|--------------------------------|------------------------------------------------------------------------|
| `DEVLAKE_ENCRYPTION_SECRET` | |
| `DEVLAKE_MYSQL_USER` | `merico` |
| `DEVLAKE_MYSQL_PASSWORD` | `merico` |
| `DEVLAKE_MYSQL_CONNECTION_URL` | `mysql://merico:merico@mysql:3306/lake?charset=utf8mb4&parseTime=True` |
| `DEVLAKE_ADMIN_USER` | `devlake` |
| `DEVLAKE_ADMIN_PASSWORD` | `merico` |
For more information on how to configure Apache DevLake with docker compose, check their official reference: [Launch DevLake with Docker Compose](https://devlake.apache.org/docs/v0.18/GettingStarted/DockerComposeSetup).
Also, make sure to check [DevLake's Configuration documentation](https://devlake.apache.org/docs/v0.18/Configuration) to correctly configure
the connection, data scope, etc. For the DORA metrics, the most important part is the [transformations](https://devlake.apache.org/docs/v0.18/Configuration/Tutorial#step-3---add-transformations-optional),
so make sure to configure it accordingly (job names) for the metrics to be properly calculated.