Metrik

<!-- PROJECT SHIELDS -->

<!-- PROJECT TITLE --> <h1 align="center"> _{<img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/frontend/src/assets/source/logo.svg" height=20% width=20%>} </h1> <p align="center"> ^{<i> Maintained by SEA team, ThoughtWorks Inc.</i>} <br> </p>

Read this in other languages: English, 简体中文

<!-- TABLE OF CONTENTS --> <details open="open"> <summary>Table of Contents</summary> <ul> <li><a href="#about-the-project">About the Project</a></li> <li><a href="#usage">Usage</a></li> <li><a href="#how-to-compute-faqs">How to Compute</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#getting-started">Getting Started</a></li> <li><a href="#more">More</a></li> <li><a href="#license">License</a></li> </ul> </details> <!-- END OF PROJECT TITLE --> <!-- ABOUT THE PROJECT -->

About the Project

For development teams who wants to measure their software delivery and operational (SDO) performance, this is a tool that helps them collect data from CD pipelines and visualize the key metrics in a friendly format.

The key differentiators:

• One page configuration, quick and easy.
• The ability to work across different CD platforms.
• User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the only one that matters)

Don't know what are those four key metrics?

Integration roadmap

List of CD tools the product supports now/plan to support

• [x] Jenkins

• [x] Bamboo

• [x] GitHub Actions

• [x] Buddy

• [ ] CircleCI

  ...and more on the way

<!-- END OF ABOUT THE PROJECT --> <!-- USAGE -->

Usage

Follow the two steps below to run the tool, and measure the four key metrics of your projects.

Install and run

The product is released to a public repository hosted on Docker Hub docker.io/wszzwpshh1/metrik. Please follow the steps:

1. Ensure Docker has already installed on your OS.
2. Find available release versions in the release page.
   Or, you can find all history versions from our image repository
3. Run the container locally via the following command:

docker run -d -p 80:80 --name metrik wszzwpshh1/metrik:latest

⚠️ We use port 80 to access the app. You may switch to any other port in case port 80 is occupied by other apps running on your machine.
⚠️ The latest tag matches the most recent version of this repository. Thus using wszzwpshh1/metrik:latest or wszzwpshh1/metrik will ensure you are running the most up to date version of this image.
If you want to stick to a specific version tag, remember there no "v" in version name. e.g. wszzwpshh1/metrik:latest: 1.6.5

Configure your projects

After the container is running on your machine. Go to your favourite browser and open the app. If running in local that would be http://localhost:80/.

1. Start the configuration:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step1.png" height=70% width=70%></div>

2. And the charts for each key metric will be available at the main page:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step2.png" height=70% width=70%></div>

3. Also the full screen view if you want to put it on big screens:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step3.png" height=70% width=70%></div>

Advanced usage

If you would like to keep the 4-key-metrics data to avoid losing any data when remove container, you can mount the database folder /data/db out. And logs are also available if you mount the log folder /app/logs. As shown in the example below:

docker run -d -p 80:80 --name metrik -v "/path/to/local/directory:/data/db" -v "/path/to/another/directory:/app/logs" wszzwpshh1/metrik:${release_version}

<!-- END OF USAGE --> <!-- Our Wiki -->

How to Compute, FAQs

See our Wiki page

<!-- END OF HOW TO COMPUTE --> <!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Please check our contributing guideline form HERE

<!-- END OF CONTRIBUTING --> <!-- GETTING STARTED -->

Getting Started

The codebase comprises of three major components frontend, backend, ci.

• Frontend app is a web application built with:

  • TypeScript
  • ReactJS
  • ReCharts

  Go to frontend folder to find more details.

• Backend app is built with:

  • Kotlin
  • Spring Boot Web
  • MongoDB

  Go to backend folder to find more details.

• Build/Package scripts lives in ci folder

<!-- END OF GETTING STARTED --> <!-- MORE -->

More

You might also like:

• Buildvis, transparency for your build pipeline's results and runtime
• HeartBeat, calculates delivery metrics from CI/CD build data, revision control and project planning tools.
• GoCD Analytics Plugin, provides insights into your GoCD instance.

<!-- END OF MORE --> <!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information

<!-- END OF LICENSE --> <!-- CONTRIBUTORS -->

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/zhe-zhao"><img src="https://avatars.githubusercontent.com/u/7913366?v=4?s=100" width="100px;" alt="Zhe ZHAO"/><br />_{<b>Zhe ZHAO</b>}</a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=zhe-zhao" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/hyrepo"><img src="https://avatars.githubusercontent.com/u/15993536?v=4?s=100" width="100px;" alt="Hao Yang"/><br />_{<b>Hao Yang</b>}</a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=hyrepo" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.hackl0us.com"><img src="https://avatars.githubusercontent.com/u/10215166?v=4?s=100" width="100px;" alt="Jason Zhang"/><br />_{<b>Jason Zhang</b>}</a><br /><a href="#infra-Hackl0us" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://reeli.github.io/"><img src="https://avatars.githubusercontent.com/u/8966348?v=4?s=100" width="100px;" alt="橘子小睿"/><br />_{<b>橘子小睿</b>}</a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=reeli" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/binfang-huang"><img src="https://avatars.githubusercontent.com/u/51937651?v=4?s=100" width="100px;" alt="HUANG Binfang"/><br />_{<b>HUANG Binfang</b>}</a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=binfang-huang" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/HeZhuConnie"><img src="https://avatars.githubusercontent.com/u/32558396?v=4?s=100" width="100px;" alt="HeZhuConnie"/><br />_{<b>HeZhuConnie</b>}</a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=HeZhuConnie" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mengqiuPeng"><img src="https://avatars.githubusercontent.com/u/81615273?v=4?s=100" width="100px;" alt="Mengqiu PENG"/><br />_{<b>Mengqiu PENG</b>}</a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=mengqiuPeng" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kikychn"><img src="https://avatars.githubusercontent.com/u/17060422?v=4?s=100" width="100px;" alt="Kiky"/><br />_<b>Kiky</b></a><br /><a href="https://github.com/thoughtworks/metrik/commits?author=kikychn" title="Code">💻</a></td> <td align="center" valign="top" width=