Scaphandre
An open source software agent to track energy consumption of ICT services from the servers.
https://github.com/hubblo-org/scaphandre
Category: Consumption
Sub Category: Computation and Communication
Keywords
carbon-footprint electricity electricity-consumption electricity-meter energy energy-consumption energy-efficiency energy-monitor greenit hacktoberfest measure prometheus qemu rust rust-lang sustainability virtual-machine virtual-machines wattmeter watts
Keywords from Contributors
climate climate-change carbon-emissions cloud-native sustainable-software energy-data carbon testing-tools green-ai green-computing
Last synced: about 17 hours ago
JSON representation
Repository metadata
⚡ Energy consumption metrology agent. Let "scaph" dive and bring back the metrics that will help you make your systems and applications more sustainable !
- Host: GitHub
- URL: https://github.com/hubblo-org/scaphandre
- Owner: hubblo-org
- License: apache-2.0
- Created: 2020-10-16T14:10:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T11:12:09.000Z (2 months ago)
- Last Synced: 2025-04-24T12:43:31.824Z (3 days ago)
- Topics: carbon-footprint, electricity, electricity-consumption, electricity-meter, energy, energy-consumption, energy-efficiency, energy-monitor, greenit, hacktoberfest, measure, prometheus, qemu, rust, rust-lang, sustainability, virtual-machine, virtual-machines, wattmeter, watts
- Language: Rust
- Homepage:
- Size: 8.07 MB
- Stars: 1,718
- Watchers: 23
- Forks: 111
- Open Issues: 90
- Releases: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION
README.md
Scaphandre [skafɑ̃dʁ] is a metrology agent dedicated to electric power and energy consumption metrics. The goal of the project is to permit to any company or individual to measure the power consumption of its tech services and get this data in a convenient form, sending it through any monitoring or data analysis toolchain.
Scaphandre means heavy diving suit in 🇫🇷. It comes from the idea that tech related services often don't track their power consumption and thus don't expose it to their clients. Most of the time the reason is a presumed bad ROI. Scaphandre makes, for tech providers and tech users, easier and cheaper to go under the surface to bring back the desired power consumption metrics, take better sustainability focused decisions, and then show the metrics to their clients to allow them to do the same.
This project was born from a deep sense of duty from tech workers. Please refer to the why section to know more about its goals.
Warning: this is still a very early stage project. Any feedback or contribution will be highly appreciated. Please refer to the contribution section.
✨ Features
- measuring power/energy consumed on bare metal hosts
- measuring power/energy consumed of qemu/kvm virtual machines from the host
- exposing power/energy metrics of a virtual machine, to allow manipulating those metrics in the VM as if it was a bare metal machine (relies on hypervisor features)
- exposing metrics as a prometheus (HTTP) exporter
- sending metrics in push mode to a prometheus Push Gateway
- sending metrics to riemann
- sending metrics to Warp10
- works on kubernetes
- storing power consumption metrics in a JSON file
- showing basic power consumption metrics in the terminal
- operating systems supported so far : Gnu/Linux, Windows 10, 11 and Server 2016/2019/2022
- packages available for RHEL 8 and 9, Debian 11 and 12 and Windows, also NixOS (community support)
Here is an example dashboard built thanks to scaphandre: https://metrics.hubblo.org.
📄 How to ... ?
You'll find everything you may want to know about scaphandre in the documentation, like:
- 🏁 Getting started
- 💻 Installation & compilation on GNU/Linux or on Windows
- 👁️ Give a virtual machine access to its power consumption metrics, and break the opacity of being on the computer of someone else
- 🎉 Contributing guide
- And much more
If you are only interested in the code documentation here it is.
📅 Roadmap
The ongoing roadmap can be seen here. Feature requests are welcome, please join us.
⚖️ Footprint
In opposition to its name, scaphandre aims to be as light and clean as possible. One of the main focus areas of the project is to come as close as possible to a 0 overhead, both about resources consumption and power consumption.
🙏 Sponsoring
If you like this project and would like to provide financial help, here's our sponsoring page.
Thanks a lot for considering it !
Citation (CITATION)
@software{scaphandre, author = {Benoit Petit}, title = {scaphandre}, year = 2023, version = {v1.0}, url = {https://github.com/hubblo-org/scaphandre} }
Owner metadata
- Name: Hubblo
- Login: hubblo-org
- Email: [email protected]
- Kind: organization
- Description: Supports organizations in the socio-ecological transformation of digital technologies.
- Website: https://hubblo.org
- Location: France
- Twitter: HubbloOrg
- Company:
- Icon url: https://avatars.githubusercontent.com/u/71067866?v=4
- Repositories: 13
- Last ynced at: 2025-04-24T07:09:46.544Z
- Profile URL: https://github.com/hubblo-org
GitHub Events
Total
- Create event: 4
- Release event: 1
- Issues event: 9
- Watch event: 133
- Issue comment event: 32
- Push event: 15
- Pull request event: 7
- Fork event: 8
Last Year
- Create event: 4
- Release event: 1
- Issues event: 9
- Watch event: 133
- Issue comment event: 32
- Push event: 15
- Pull request event: 7
- Fork event: 8
Committers metadata
Last synced: 4 days ago
Total Commits: 1,007
Total Committers: 25
Avg Commits per committer: 40.28
Development Distribution Score (DDS): 0.153
Commits in past year: 310
Committers in past year: 7
Avg Commits per committer in past year: 44.286
Development Distribution Score (DDS) in past year: 0.065
Name | Commits | |
---|---|---|
Benoit Petit | b****t@h****g | 853 |
Uggla | u****a@f****r | 74 |
Ross Fairbanks | r****s@r****m | 17 |
olivier de Meringo | d****o@g****m | 11 |
Pierre Rust | p****t@g****m | 8 |
repair | b****d@g****m | 7 |
wallet77 | w****7@g****m | 7 |
Guillaume Raffin | t****l@g****m | 4 |
Ludovic Rousseau | l****b@g****m | 3 |
fvaleye | f****e@g****m | 3 |
Chris Adams | c****s@p****k | 2 |
Chris Laprun | m****m@g****m | 2 |
Jérémie Drouet | j****t | 2 |
Benoit Petit | b****t@b****n | 2 |
Raffin, Guillaume | g****n@a****t | 2 |
Joel Takvorian | j****i@r****m | 1 |
Arthur Lutz | a****z@l****r | 1 |
Mike Russell | m****l@g****m | 1 |
Olivier Levitt | o****t@g****m | 1 |
Pierre Ozoux | p****e@o****t | 1 |
codesee-maps[bot] | 8****] | 1 |
florimondmanca | f****a@g****m | 1 |
homersimpsons | g****e@g****m | 1 |
Nicolas Trangosi | n****i@d****m | 1 |
Sebastian Werner | w****r@t****e | 1 |
Committer domains:
- tu-berlin.de: 1
- dcbrain.com: 1
- ozoux.net: 1
- logilab.fr: 1
- redhat.com: 1
- atos.net: 1
- b0rk.in: 1
- productscience.co.uk: 1
- rossfairbanks.com: 1
- free.fr: 1
- hubblo.org: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 193
Total pull requests: 190
Average time to close issues: 5 months
Average time to close pull requests: about 2 months
Total issue authors: 95
Total pull request authors: 42
Average comments per issue: 3.7
Average comments per pull request: 1.49
Merged pull request: 101
Bot issues: 0
Bot pull requests: 47
Past year issues: 12
Past year pull requests: 8
Past year average time to close issues: 6 months
Past year average time to close pull requests: about 1 month
Past year issue authors: 11
Past year pull request authors: 8
Past year average comments per issue: 1.33
Past year average comments per pull request: 2.0
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- bpetit (64)
- Louan-Robert (5)
- uggla (4)
- demeringo (4)
- TheElectronWill (4)
- arthurzenika (3)
- malinvaudpaul (3)
- wanecek (3)
- hrexha28 (3)
- ancoron (2)
- maethor (2)
- mrchrisadams (2)
- FranciscoSedeno (2)
- olepbr (2)
- PierreRust (2)
Top Pull Request Authors
- dependabot[bot] (47)
- bpetit (46)
- uggla (24)
- rossf7 (16)
- demeringo (5)
- jdrouet (4)
- PierreRust (3)
- LarsSven (3)
- TheElectronWill (3)
- fvaleye (2)
- bdromard (2)
- olepbr (2)
- mmadoo (2)
- papey (2)
- LudovicRousseau (2)
Top Issue Labels
- enhancement (83)
- bug (81)
- help wanted (30)
- documentation (17)
- good first issue (13)
- Hacktoberfest (5)
- Epic (3)
- CI (2)
Top Pull Request Labels
- dependencies (47)
- enhancement (5)
- documentation (2)
- help wanted (1)
Package metadata
- Total packages: 2
-
Total downloads:
- cargo: 9,478 total
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 18
- Total maintainers: 1
proxy.golang.org: github.com/hubblo-org/scaphandre
- Homepage:
- Documentation: https://pkg.go.dev/github.com/hubblo-org/scaphandre#section-documentation
- Licenses: apache-2.0
- Latest release: v1.0.2 (published 2 months ago)
- Last Synced: 2025-04-25T13:05:31.804Z (1 day ago)
- Versions: 10
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 6.521%
- Average: 6.74%
- Dependent repos count: 6.959%
crates.io: scaphandre
Electric power/energy consumption monitoring agent.
- Homepage: https://scaphandre.hubblo.org
- Documentation: https://docs.rs/scaphandre/
- Licenses: Apache-2.0
- Latest release: 1.0.0 (published about 1 year ago)
- Last Synced: 2025-04-25T13:05:32.010Z (1 day ago)
- Versions: 8
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 9,478 Total
-
Rankings:
- Stargazers count: 4.871%
- Forks count: 7.641%
- Average: 23.622%
- Dependent repos count: 29.318%
- Dependent packages count: 33.812%
- Downloads: 42.469%
- Maintainers (1)
Dependencies
- actions-rs/cargo v1 composite
- actions-rs/toolchain v1 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- ambimax/action-cancel-previous-runs v1 composite
- crazy-max/ghaction-chocolatey v2 composite
- Codesee-io/codesee-detect-languages-action latest composite
- Codesee-io/codesee-map-action latest composite
- actions-rs/toolchain v1 composite
- actions/checkout v2 composite
- actions/setup-java v2 composite
- actions/setup-node v2 composite
- actions/setup-python v2 composite
- ruby/setup-ruby v1 composite
- actions/checkout v3 composite
- docker/build-push-action v2 composite
- docker/login-action v1 composite
- docker/metadata-action v3 composite
- docker/setup-buildx-action v1 composite
- docker/setup-qemu-action v1 composite
- 210 dependencies
- rust 1.59 build
- ubuntu 20.04 build
- grafana/grafana latest build
- prom/prometheus latest build
- prom/prometheus latest build
- JamesIves/github-pages-deploy-action v4.4.1 composite
- actions/checkout v3 composite
- dtolnay/rust-toolchain stable composite
- swatinem/rust-cache v2 composite
- Swatinem/rust-cache v1 composite
- actions-rs/toolchain v1 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/setup-python v3 composite
- 203 dependencies
Score: 19.875686470273365