Skip to content

mahendrapaipuri/ceems

Repository files navigation

Compute Energy & Emissions Monitoring Stack (CEEMS)

CI/CD ci CircleCI Coverage
Docs docs Go Doc
Package Release
Meta GitHub License Go Report Card code style

Compute Energy & Emissions Monitoring Stack (CEEMS) (pronounced as kiːms) contains a Prometheus exporter to export metrics of compute instance units and a REST API server that serves the metadata and aggregated metrics of each compute unit. Optionally, it includes a TSDB load balancer that supports basic access control on TSDB so that one user cannot access metrics of another user.

"Compute Unit" in the current context has a wider scope. It can be a batch job in HPC, a VM in cloud, a pod in k8s, etc. The main objective of the repository is to quantify the energy consumed and estimate emissions by each "compute unit". The repository itself does not provide any frontend apps to show dashboards and it is meant to use along with Grafana and Prometheus to show statistics to users.

Although CEEMS was born out of a need to monitor energy and carbon footprint of compute workloads, it supports monitoring performance metrics as well. In addition, it leverages eBPF framework to monitor IO and network metrics in a resource manager agnostic way. It also supports eBPF based zero instrumentation continuous profiling of compute units.

🎯 Features

  • Monitors energy, performance, IO and network metrics for different types of resource managers (SLURM, Openstack, k8s)
  • Supports different energy sources like RAPL, HWMON, Cray's PM Counters and BMC via IPMI or Redfish
  • Supports NVIDIA (MIG, time sharing, MPS and vGPU) and AMD GPUs (Partition like CPX, QPX, TPX, DPX)
  • Supports zero instrumentation eBPF based continuous profiling using Grafana Pyroscope as backend
  • Realtime access to metrics via Grafana dashboards or a simple CLI tool
  • Access control to Prometheus and Pyroscope datasources in Grafana
  • Stores aggregated metrics in a separate DB that can be retained for long time
  • CEEMS apps are capability aware

⚙️ Install CEEMS

Warning

DO NOT USE pre-release versions as the API has changed quite a lot between the pre-release and stable versions.

Installation instructions of CEEMS components can be found in docs.

📽️ Demo

Access Demo

Openstack and SLURM have been deployed on a small cloud instance and monitored using CEEMS. As neither RAPL nor IPMI readings are available on cloud instances, energy consumption is estimated by assuming a Thermal Design Power (TDP) value and current usage of the instance. Several dashboards have been created in Grafana for visualizing metrics which are listed below.

Warning

All the dashboards provided in the demo instance are only meant to be for demonstrative purposes. They should not be used in production without properly protecting datasources.

Visualizing metrics with Grafana

Grafana can be used for visualization of metrics and below are some of the screenshots of dashboards.

Time series compute unit CPU metrics

Time series compute unit GPU metrics

List of compute units of user with aggregate metrics

Aggregate usage metrics of a user

Aggregate usage metrics of a project

Energy usage breakdown between project members

Usage metrics via CLI tool

CEEMS ships a CLI tool for presenting usage metrics to end users for the deployments where Grafana usage is not possible or prohibitive.

cacct  --starttime="2025-01-01" --endtime="2025-03-22"
┌─────────┬─────────┬──────────┬────────┬────────┬──────────┬──────────────────────────────────────┬────────┬────────┬──────────┬──────────────────────────────────────┐
│ JOB ID  │ ACCOUNT │ ELAPSED  │ CPU US │ CPU ME │ HOST ENE │             HOST EMISSIO             │ GPU US │ GPU ME │ GPU ENER │             GPU EMISSION             │
│         │         │          │ AGE(%) │ M. USA │ RGY(KWH) │                NS(GMS)               │ AGE(%) │ M. USA │ GY(KWH)  │                S(GMS)                │
│         │         │          │        │ GE(%)  │          │                                      │        │ GE(%)  │          │                                      │
│         │         │          │        │        │          │ EMAPS_TOTAL │ OWID_TOTAL │ RTE_TOTAL │        │        │          │ EMAPS_TOTAL │ OWID_TOTAL │ RTE_TOTAL │
├─────────┼─────────┼──────────┼────────┼────────┼──────────┼─────────────┼────────────┼───────────┼────────┼────────┼──────────┼─────────────┼────────────┼───────────┤
│ 106     │ bedrock │ 00:10:05 │ 99.32  │ 3.39   │ 0.053818 │ 4.725182    │ 5.648855   │ 3.860008  │        │        │          │             │            │           │
│ 108     │ bedrock │ 00:10:04 │ 99.60  │ 2.51   │ 0.055842 │ 5.091815    │ 5.840380   │ 4.197307  │        │        │          │             │            │           │
│ 118     │ bedrock │ 00:10:03 │ 99.65  │ 1.17   │ 0.061474 │ 4.450334    │ 6.512757   │ 3.683035  │        │        │          │             │            │           │
│ 131     │ bedrock │ 00:10:04 │ 99.71  │ 2.15   │ 0.055742 │ 1.835111    │ 5.562944   │ 1.245254  │        │        │          │             │            │           │
│ 134     │ bedrock │ 00:20:12 │ 0.53   │ 0.73   │ 0.004463 │ 0.030868    │ 0.100538   │ 0.021321  │        │        │          │             │            │           │
│ 138     │ bedrock │ 00:10:00 │ 99.61  │ 1.17   │ 0.056302 │ 2.595522    │ 5.570695   │ 1.837668  │        │        │          │             │            │           │
│ 150     │ bedrock │ 00:20:11 │ 0.54   │ 0.74   │ 0.003862 │ 0.076767    │ 0.086878   │ 0.058934  │        │        │          │             │            │           │
│ 154     │ bedrock │ 00:10:19 │ 99.48  │ 2.86   │ 0.055671 │ 4.906742    │ 6.610783   │ 4.127894  │        │        │          │             │            │           │
│ 162     │ bedrock │ 00:10:22 │ 96.51  │ 3.66   │ 0.055507 │ 3.274911    │ 4.711376   │ 2.497813  │        │        │          │             │            │           │
│ 163     │ bedrock │ 00:10:28 │ 99.71  │ 3.03   │ 0.051746 │ 3.673949    │ 4.392128   │ 2.780309  │        │        │          │             │            │           │
│ 169     │ bedrock │ 00:10:19 │ 99.71  │ 1.17   │          │             │            │           │        │        │          │             │            │           │
│ 181     │ bedrock │ 00:20:14 │ 0.56   │ 0.74   │ 0.001518 │ 0.115373    │ 0.085070   │ 0.081976  │ 36.31  │ 38.11  │ 0.184776 │ 14.042940   │ 10.354560  │ 9.977878  │
│ 183     │ bedrock │ 00:10:09 │ 99.68  │ 1.17   │ 0.049606 │ 3.676648    │ 2.779826   │ 2.926728  │ 37.87  │ 37.97  │ 0.187746 │ 13.919683   │ 10.521023  │ 11.077016 │
│ 229     │ bedrock │ 00:10:21 │ 99.57  │ 1.99   │ 0.048258 │ 1.930318    │ 2.704308   │ 1.109933  │ 38.71  │ 37.36  │ 0.197287 │ 7.891462    │ 11.055660  │ 4.537591  │
│ 232     │ bedrock │ 00:10:24 │ 99.63  │ 1.17   │ 0.050244 │ 1.385482    │ 2.815615   │ 0.954640  │ 31.90  │ 35.88  │ 0.131236 │ 3.618456    │ 7.354267   │ 2.493479  │
│ 269     │ bedrock │ 00:10:01 │ 99.69  │ 1.17   │ 0.048866 │ 2.738386    │ 2.123290   │ 22.18     │ 24.35  │ 0.0263 │ 1.477547 │ 1.141505    │            │           │
│         │         │          │        │        │          │             │            │           │        │ 67     │          │             │            │           │
│ 274     │ bedrock │ 00:10:16 │ 97.72  │ 3.49   │ 0.054060 │ 3.029430    │ 2.324568   │           │        │        │          │             │            │           │
├─────────┼─────────┴──────────┴────────┴────────┴──────────┴─────────────┴────────────┴───────────┴────────┴────────┴──────────┴─────────────┴────────────┴───────────┤
│ Summary │                                                                                                                                                            │
├─────────┼─────────┬──────────┬────────┬────────┬──────────┬─────────────┬────────────┬───────────┬────────┬────────┬──────────┬─────────────┬────────────┬───────────┤
│ 20      │ bedrock │ 03:23:27 │ 69.84  │ 1.73   │ 0.706980 │ 37.769023   │ 59.189969  │ 33.830679 │ 35.74  │ 35.32  │ 0.727410 │ 39.472541   │ 40.763058  │ 29.227470 │
└─────────┴─────────┴──────────┴────────┴────────┴──────────┴─────────────┴────────────┴───────────┴────────┴────────┴──────────┴─────────────┴────────────┴───────────┘

⚡️ Talks and Demos

🤝 Adopters

  • Currently CEEMS is running on Jean Zay HPC platform that has a daily job churn rate of around 25k jobs with a scrape interval of 10s.

👍 Contributing

We welcome contributions to this project, we hope to see this project grow and become a useful tool for people who are interested in the energy and carbon footprint of their workloads.

Please feel free to open issues and/or discussions for any potential ideas of improvement.

🙏 Acknowledgements

  • Grid5000 platform, supported by a scientific interest group hosted by Inria and including CNRS, RENATER and several Universities as well as other organizations, has been extensively used in the development of CEEMS.

  • The demo instance has been deployed on the CROCC which was kindly sponsored by ISDM MESO in Montpellier, France.

⭐️ Project assistance

If you want to say thank you or/and support active development of CEEMS: