Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahendrapaipuri/ceems
A Prometheus exporter and a REST API server to export metrics of compute units of resource managers like SLURM, Openstack, k8s, _etc_
https://github.com/mahendrapaipuri/ceems
cloud containers dashboards ebpf emissions energy-monitor grafana green-computing hpc json-api kubernetes metrics-server metrics-visualization monitoring observability openstack performance-monitoring prometheus prometheus-exporter slurm
Last synced: about 2 months ago
JSON representation
A Prometheus exporter and a REST API server to export metrics of compute units of resource managers like SLURM, Openstack, k8s, _etc_
- Host: GitHub
- URL: https://github.com/mahendrapaipuri/ceems
- Owner: mahendrapaipuri
- License: gpl-3.0
- Created: 2023-11-15T10:40:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:32:58.000Z (about 2 months ago)
- Last Synced: 2024-10-29T16:07:21.149Z (about 2 months ago)
- Topics: cloud, containers, dashboards, ebpf, emissions, energy-monitor, grafana, green-computing, hpc, json-api, kubernetes, metrics-server, metrics-visualization, monitoring, observability, openstack, performance-monitoring, prometheus, prometheus-exporter, slurm
- Language: C
- Homepage: https://mahendrapaipuri.github.io/ceems/
- Size: 8.02 MB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Compute Energy & Emissions Monitoring Stack (CEEMS)
| | |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CI/CD | [](https://github.com/mahendrapaipuri/ceems/actions/workflows/ci.yml?query=branch%3Amain) [](https://dl.circleci.com/status-badge/redirect/circleci/8jSYT1wyKY8mKQRTqNLThX/TzM1Mr3AEAqmehnoCde19R/tree/main) [](https://github.com/mahendrapaipuri/ceems/actions/workflows/ci.yml?query=branch%3Amain) |
| Docs | [](https://mahendrapaipuri.github.io/ceems/) |
| Package | [](https://github.com/mahendrapaipuri/ceems/releases/latest) |
| Meta | [](https://github.com/mahendrapaipuri/ceems) [](https://goreportcard.com/report/github.com/mahendrapaipuri/ceems) [](https://pkg.go.dev/cmd/gofmt) |
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](https://ebpf.io/what-is-ebpf/) framework to monitor IO and network metrics
in a resource manager agnostic way.
## Features
- Monitor energy, performance, IO and network metrics for different types of resource
managers (SLURM, Openstack, k8s)
- Support NVIDIA (MIG and vGPU) and AMD GPUs
- Provides targets using [HTTP Discovery Component](https://grafana.com/docs/alloy/latest/reference/components/discovery/discovery.http/)
to [Grafana Alloy](https://grafana.com/docs/alloy/latest) to continuously profile compute units
- Realtime access to metrics *via* Grafana dashboards
- Access control to Prometheus datasource in Grafana
- Stores aggregated metrics in a separate DB that can be retained for long time
- CEEMS apps are [capability aware](https://tbhaxor.com/understanding-linux-capabilities/)
## 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](https://mahendrapaipuri.github.io/ceems/docs/category/installation).
## Visualizing metrics with Grafana
CEEMS is meant to be used with Grafana for visualization 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
## Talks and Demos
- [An Introduction to CEEMS at ISC 2024](https://drive.google.com/file/d/1kUbD3GgDKwzgIuxjrTY95YJN5aSuIejQ/view?usp=drive_link)
- [CEEMS Architecture and Usage](https://docs.google.com/presentation/d/1xNQTCsmPUz37KDb2BLrpWExuQWxk49NpVN9VDbxSe6Y/edit#slide=id.p)
## 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.