Git Metrics

Right now, if you want to track the evolution of some metrics for your project over time, you need an external tool to store those metrics. But these metrics could be stored withing the git repository. Git provides a mechanism of notes that git-metrics simplifies.

How to install

From sources

cargo install --git https://github.com/jdrouet/git-metrics

How to use it

Locally

# fetch the remote metrics
$ git metrics pull
# add a new metric
$ git metrics add binary-size \
    --tag "platform.arch: amd64" \
    --tag "unit: byte" \
    1024.0
# push the metrics to remote
$ git metrics push
# log all the metrics for the past commits
$ git metrics log --filter-empty
# display the metrics on current commit
$ git metrics show
binary-size{platform.arch="amd64", unit="byte"} 1024.0
# display the metrics difference between commits
$ git metrics diff HEAD~2..HEAD
- binary-size{platform.arch="amd64", unit="byte"} 512.0
+ binary-size{platform.arch="amd64", unit="byte"} 1024.0 (+200.00 %)

With a github action

name: monitoring metrics

on:
  push:
    branches:
      - main

jobs:
  building:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: jdrouet/action-install-git-metrics@main
      - name: getting binary size and pushing
        run: |
          git-metrics --backend command pull
          git-metrics add binary-size \
            --tag "platform.os: linux" \
            --tag "platform.arch: x86_64" \
            $(stat --printf="%s" path/to/binary)
          git-metrics --backend command push

Project goals

• git-metrics show displays the metrics to the current commit
• git-metrics add adds a metric to the current commit
• git-metrics remove removes a metric from the current commit
• git-metrics fetch fetches the metrics
• git-metrics push pushes the metrics
• git-metrics log displays the metrics for the last commits
• git-metrics diff computes the diff of the metrics between 2 commits
• git-metrics page generates a web page with charts for every metrics
• add a way to create a budget and compare to it
• create an action to comment a PR with the comparison to the main branch