https://github.com/green-coding-solutions/green-metrics-tool
Measure energy and carbon consumption of software
https://github.com/green-coding-solutions/green-metrics-tool
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
Last synced: 3 days ago
JSON representation
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-03T04:56:53.000Z (8 days ago)
- Last Synced: 2025-05-03T14:38:15.360Z (7 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.6 MB
- Stars: 204
- Watchers: 3
- Forks: 31
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
- open-sustainable-technology - 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. (Consumption / Computation and Communication)
README
[](https://github.com/green-coding-solutions/green-metrics-tool/actions/workflows/tests-vm-main.yml)
[](https://metrics.green-coding.io/ci.html?repo=green-coding-solutions/green-metrics-tool&branch=main&workflow=45267393) (This is the carbon emitted for running our CI-Pipelines to test GMT on Github. [Find out more about Eco-CI](https://www.green-coding.io/products/eco-ci/))
[](https://codespaces.new/green-coding-solutions/green-metrics-tool)
# 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](https://docs.green-coding.io/docs/measuring/metric-providers/metric-providers-overview/) for many sensors (RAPL, IPMI, PSU, Docker, Temperature, CPU ...)
- [Low overhead](https://docs.green-coding.io/docs/measuring/metric-providers/overhead-of-measurement-providers/)
- Statististical frontend with charts - [DEMO](https://metrics.green-coding.io/stats.html?id=7169e39e-6938-4636-907b-68aa421994b2)
- API - [DEMO](https://api.green-coding.io)
- [Cluster setup](https://docs.green-coding.io/docs/installation/installation-cluster/)
- [Free Hosted service for more precise measurements](https://docs.green-coding.io/docs/measuring/measurement-cluster/)
- Timeline-View: Monitor software projects over time - [DEMO for Wagtail](https://metrics.green-coding.io/timeline.html?uri=https://github.com/green-coding-solutions/bakerydemo-gold-benchmark&filename=usage_scenario_warm.yml&branch=&machine_id=7) / [DEMO Overview](https://metrics.green-coding.io/watchlist.html)
- [Energy ID Score-Cards](https://www.green-coding.io/products/energy-id/) 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](https://metrics.green-coding.io)
# Documentation
To see the the documentation and how to install and use the tool please go to [Green Metrics Tool Documentation](https://docs.green-coding.io)
# Comparison with other tools
## What GMT is not
- GMT is not a real time monitoring system -> Use [CodeCarbon](https://codecarbon.io/) 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](https://www.green-coding.io/products/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!](https://docs.green-coding.io)
# Energy ID Scorecards
Details: [Energy ID project page](https://www.green-coding.io/products/energy-id/)
# 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](https://www.green-coding.io/products/green-metrics-tool) for more information regarding a commercial license.