Green Metrics Tool

An open source suite to measure, display and compare software energy and CO2 consumption for containerized software. External power meters as well as RAPL and also ML-estimation models are supported.
https://github.com/green-coding-solutions/green-metrics-tool

Category: Consumption
Sub Category: Computation and Communication

Keywords

carbon-emissions carbon-footprint carbon-measurement climate-change co2-emissions co2-footprint co2-measurement energy-consumption-analysis green-coding green-computing green-software metrics power-consumption power-consumption-measurement sustainability sustainable-software

Keywords from Contributors

green-energy climate-change-mitigation carbon-footprint-estimation carbon-footprint-calculator metrics-gathering sustainable-development-goals transforms archiving measur conversion

Last synced: about 11 hours ago
JSON representation

Repository metadata

Measure energy and carbon consumption of software

Host: GitHub
URL: https://github.com/green-coding-solutions/green-metrics-tool
Owner: green-coding-solutions
License: agpl-3.0
Created: 2022-02-25T13:45:29.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2025-05-10T08:09:01.000Z (8 days ago)
Last Synced: 2025-05-10T18:02:36.175Z (8 days ago)
Topics: carbon-emissions, carbon-footprint, carbon-measurement, climate-change, co2-emissions, co2-footprint, co2-measurement, energy-consumption-analysis, green-coding, green-computing, green-software, metrics, power-consumption, power-consumption-measurement, sustainability, sustainable-software
Language: Python
Homepage: https://metrics.green-coding.io
Size: 20.7 MB
Stars: 205
Watchers: 3
Forks: 31
Open Issues: 57
Releases: 37
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
- Security: SECURITY.md

README.md

(This is the carbon emitted for running our CI-Pipelines to test GMT on Github. Find out more about Eco-CI)

Introduction

The Green Metrics Tool is a developer tool indented for measuring the energy and CO2 consumption of software through a software life cycle analysis (SLCA).

Key features are:

Reproducible measurements through configuration/setup-as-code
POSIX style metric providers for many sensors (RAPL, IPMI, PSU, Docker, Temperature, CPU ...)
Low overhead
Statististical frontend with charts - DEMO
API - DEMO
Cluster setup
Free Hosted service for more precise measurements
Timeline-View: Monitor software projects over time - DEMO for Wagtail / DEMO Overview
Energy ID Score-Cards for software (Also see below)

It is designed to re-use existing infrastructure and testing files as much as possible to be easily integrateable into every software repository and create transparency around software energy consumption.

It can orchestrate Docker containers according to a given specificaion in a usage_scenario.yml file.

These containers will be setup on the host system and the testing specification in the usage_scenario.yml will be
run by sending the commands to the containers accordingly.

This repository contains the command line tools to schedule and run the measurement report
as well as a web interface to view the measured metrics in some nice charts.

Frontend

To see the frontend in action and get an idea of what kind of metrics the tool can collect and display go to out Green Metrics Frontend

Documentation

To see the the documentation and how to install and use the tool please go to Green Metrics Tool Documentation

Comparison with other tools

What GMT is not

GMT is not a real time monitoring system -> Use CodeCarbon for this
GMT is not a LoC optimization system -> Use classic debuggers for this

What GMT is great at

Comparing software implementations
- How much does algorithm A save in carbon vs. Algorithm B
- How much dies Inferencing with LLama 2 cost in carbon vs. LLama 3.1
- ...
Comparing architectures of whole software systems against each other on service/container level
- How much do I save with a micoservice approach vs. a monolith architecture?
- How much does MySQL consume in carbon vs. PostgreSQL
- ...
Understanding the life-cycle of an application
- Are my emissions rather in CI/CD testing or in development or in running our VM fleet? (See also CarbonDB for this)
- How much do my Docker builds cost vs. running the application?
- How much does the training of my AI model cost vs. Inferencing?
Tracking and evaluating code sustainability targets
- How do my carbon emissions for a given software feature develop over time? Are we getting better or worse?
- Which commit has led to an energy / carbon regression
  And so much more! See the documentation!

Energy ID Scorecards

Details: Energy ID project page

Screenshots of Single Run View

Screenshots of Comparison View

License and Copyright

The Green Metrics Tool is available under open-source AGPL and commercial license agreements. If you determine you cannot meet the requirements of the AGPL, please contact Green Coding Solutions for more information regarding a commercial license.

Citation (CITATION.cff)

cff-version: 1.2.0
title: Green Metrics Tool
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Arne
    family-names: Tarara
    email: [email protected]
    affiliation: Green Coding Solutions GmbH
  - given-names: Dan
    family-names: Mateas
    email: [email protected]
    affiliation: Green Coding Solutions GmbH
  - given-names: Geerd-Dietger
    family-names: Hoffmann
    email: [email protected]
    affiliation: Green Coding Solutions GmbH
repository-code: 'https://github.com/green-coding-solutions/green-metrics-tool'
url: 'https://www.green-coding.io/'
repository: 'https://github.com/green-coding-solutions/'
abstract: >-
  The Green Metrics Tool is a developer tool indented for
  measuring the energy and CO2 consumption of software
  through a software life cycle analysis (SLCA).
keywords:
  - Green Coding
  - 'Software Life Cycle Assessment '
license: AGPL-3.0-or-later

Owner metadata

Name: Green Coding Solutions
Login: green-coding-solutions
Email:
Kind: organization
Description: We create open source tools to measure software energy consumption
Website: https://www.green-coding.io
Location: Germany
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/97227681?v=4
Repositories: 47
Last ynced at: 2024-04-16T05:54:48.943Z
Profile URL: https://github.com/green-coding-solutions

GitHub Events

Total

Create event: 189
Release event: 2
Issues event: 73
Watch event: 29
Delete event: 192
Issue comment event: 407
Push event: 622
Pull request review comment event: 686
Pull request review event: 243
Pull request event: 391
Fork event: 7

Last Year

Create event: 189
Release event: 2
Issues event: 73
Watch event: 29
Delete event: 192
Issue comment event: 407
Push event: 622
Pull request review comment event: 686
Pull request review event: 243
Pull request event: 391
Fork event: 7

Committers metadata

Last synced: 8 days ago

Total Commits: 1,993
Total Committers: 10
Avg Commits per committer: 199.3
Development Distribution Score (DDS): 0.317

Commits in past year: 649
Committers in past year: 4
Avg Commits per committer in past year: 162.25
Development Distribution Score (DDS) in past year: 0.33

Name	Email	Commits
Arne Tarara	a**e@d**e	1362
dependabot[bot]	4****]	339
dan-mm	3****m	99
Didi Hoffmann	3****a	86
Danilo Ješić	3****c	42
Alexandre	a**o@g**m	28
David	d****p	23
Dan M	d**n@g**g	10
Sai Teja	4****7	3
alexzurbonsen	8****n	1

Committer domains:

green-coding.org: 1
datafuse.de: 1

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 178
Total pull requests: 684
Average time to close issues: 9 months
Average time to close pull requests: 6 days
Total issue authors: 12
Total pull request authors: 9
Average comments per issue: 2.38
Average comments per pull request: 1.82
Merged pull request: 590
Bot issues: 0
Bot pull requests: 326

Past year issues: 38
Past year pull requests: 418
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 5 days
Past year issue authors: 7
Past year pull request authors: 7
Past year average comments per issue: 2.79
Past year average comments per pull request: 1.44
Past year merged pull request: 357
Past year bot issues: 0
Past year bot pull requests: 223

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/green-coding-solutions/green-metrics-tool

Top Issue Authors

ArneTR (75)
ribalba (72)
davidkopp (16)
dan-mm (4)
schlichtanders (2)
hellstromme (2)
djesic (2)
mrchrisadams (1)
raits (1)
chrischanwz (1)
anitaschuettler (1)
andracs (1)

Top Pull Request Authors

dependabot[bot] (326)
ArneTR (266)
ribalba (49)
davidkopp (22)
dan-mm (14)
alexzurbonsen (3)
Bob-Sideshow (2)
pkutschera (1)
thiloettelt (1)

Top Issue Labels

good first issue (32)
enhancement (23)
help wanted (20)
idea (4)
front end (3)
research (3)
python (3)
bug (3)
wontfix (2)
question (1)

Top Pull Request Labels

dependencies (326)
python (287)
docker (31)
github_actions (8)
blocked (2)
help wanted (1)
wontfix (1)

Dependencies

.github/workflows/tests-bare-metal-main.yml actions

./.github/actions/gmt-pytest * composite
actions/checkout v3 composite
green-coding-berlin/eco-ci-activity-checker main composite

.github/workflows/tests-vm-main.yml actions

./.github/actions/gmt-pytest * composite
actions/checkout v3 composite
green-coding-berlin/eco-ci-activity-checker main composite

requirements.txt pypi

PyYAML ==6.0
pandas ==1.5.2
psycopg2 ==2.9.5

requirements-dev.txt pypi

pydantic ==1.10.2 development
pylint ==2.15.10 development
pytest ==7.2.0 development
requests ==2.25.1 development

.github/actions/gmt-pytest/action.yml actions

actions/setup-python v4 composite
docker/login-action v2 composite
docker/setup-buildx-action master composite

.github/workflows/build-and-push-containers.yml actions

actions/checkout v3 composite
docker/login-action v3 composite
docker/setup-buildx-action v3 composite
docker/setup-qemu-action v3 composite

.github/workflows/tests-eco-ci-energy-estimation.yaml actions

./.github/actions/gmt-pytest * composite
actions/checkout v3 composite
green-coding-berlin/eco-ci-energy-estimation testing composite

.github/workflows/tests-vm-pr.yml actions

./.github/actions/gmt-pytest * composite
actions/checkout v3 composite
green-coding-berlin/eco-ci-energy-estimation v2 composite

docker/auxiliary-containers/gcb_playwright/Dockerfile docker

mcr.microsoft.com/playwright/python v1.35.0-jammy build

docker/requirements.txt pypi

PyYAML ==6.0.1
anybadge ==1.14.0
fastapi ==0.103.1
gunicorn ==21.2.0
orjson ==3.9.7
pandas ==2.1.0
psycopg ==3.1.10
schema ==0.7.5
scipy ==1.11.2
uvicorn ==0.23.2

.github/workflows/build-codespace-container.yml actions

docker/build-push-action v2 composite
docker/login-action v2 composite
docker/setup-buildx-action v3 composite
docker/setup-qemu-action v3 composite

.github/workflows/codeql.yml actions

actions/checkout v4 composite
github/codeql-action/analyze v3 composite
github/codeql-action/autobuild v3 composite
github/codeql-action/init v3 composite

tests/data/test_cases/subdir_volume_loading/Dockerfile docker

alpine latest build

tests/data/test_cases/subdir_volume_loading/subdir/Dockerfile docker

alpine latest build

tests/stress-application/Dockerfile docker

alpine latest build

.github/workflows/tests-vm-mac.yml actions

./.github/actions/gmt-pytest * composite
actions/checkout v4 composite
green-coding-solutions/eco-ci-activity-checker v1 composite

Score: 7.8709295967551425

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology