Skip to content

green-coding-solutions/green-metrics-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tests Status - Main

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

Try in Github Codespaces!

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:

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

Screenshot 2023-10-24 at 10 43 28 AM

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.