Data

Tools

Indexes

Applications

Experiments

Open Source Science

cloud-scanner

📡 Get Boavizta impact data for your AWS usage.

https://github.com/Boavizta/cloud-scanner

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary

Keywords

aws cli ec2 emissions-co2 grafana-dashboard greenops greensoftware serverless sustainability

Keywords from Contributors

carbon-footprint
Last synced: 6 months ago · JSON representation

Repository

📡 Get Boavizta impact data for your AWS usage.

Basic Info
Statistics
  • Stars: 40
  • Watchers: 5
  • Forks: 9
  • Open Issues: 71
  • Releases: 28
Topics
aws cli ec2 emissions-co2 grafana-dashboard greenops greensoftware serverless sustainability
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License

README.md

Boavizta's Cloud-scanner returns environmental impacts of your AWS Instances (EC2) usage.

mermaid graph LR; inventory[ Account inventory] api[Impacts from BoaviztaAPI] metrics[Prometheus metrics] json[JSON output] inventory --> api api --> metrics api --> json

Cloud scanner combines real time inventory and usage data from your AWS account with Boavizta API to offer a view of your impacts on a given region.

  • multi criteria: Primary Energy consumption (PE), Abiotic resource depletion potential (ADP), and Global Warming Potential (GWP)
  • multi stage: separate impacts of resources Usage and Manufacture

This is similar to what you can get from Datavizta but with automated inventory.

Estimations can be filtered by tags. It eases attribution to a specific server, environment, application or service.

Cloud-scanner can be used:

  • from command line, to get an immediate view of your impacts 💻
  • as a metric server . You can use it to monitor and display real time impacts in a dashboard 📊

A example dashboard rendering cloud scanner metrics

How it works:

Cloud scanner follows Boavizta approach.

Thibault Simon, David Ekchajzer, Adrien Berthelot, Eric Fourboul, Samuel Rince, et al.. BoaviztAPI: a bottom-up model to assess the environmental impacts of cloud services. HotCarbon'24. Workshop on Sustainable Computer Systems, Jul 2024, Santa Cruz, United States. ⟨hal-04621947v1⟩

System in context diagram of cloud scanner

Usage and documentation

The complete documentation: Introduction - Boavizta cloud scanner 📡.

Getting started 🚀

Deployment as a serverless app (aws lambda) ⚡

Cloud scanner can also be deployed as a serverless application for aws.

Output formats

Cloud scanner returns data as json or Open Metrics (Prometheus) format.

See Output data - Boavizta cloud scanner 📡

⚠ Perimeter / scope and limits

Cloud scanner only estimates the impacts of your AWS EC2 instances and optionally block storage.

The limitations of cloud-scanner are documented in Limitations - Boavizta cloud scanner 📡

Owner

  • Name: Boavizta
  • Login: Boavizta
  • Kind: organization
  • Email: contact@boavizta.org

GitHub Events

Total
  • Fork event: 1
  • Create event: 114
  • Release event: 4
  • Issues event: 49
  • Watch event: 9
  • Delete event: 152
  • Member event: 1
  • Issue comment event: 133
  • Push event: 146
  • Gollum event: 6
  • Pull request review comment event: 4
  • Pull request review event: 16
  • Pull request event: 219
Last Year
  • Fork event: 1
  • Create event: 114
  • Release event: 4
  • Issues event: 49
  • Watch event: 9
  • Delete event: 152
  • Member event: 1
  • Issue comment event: 133
  • Push event: 146
  • Gollum event: 6
  • Pull request review comment event: 4
  • Pull request review event: 16
  • Pull request event: 219

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 505
  • Total Committers: 13
  • Avg Commits per committer: 38.846
  • Development Distribution Score (DDS): 0.202
Past Year
  • Commits: 71
  • Committers: 5
  • Avg Commits per committer: 14.2
  • Development Distribution Score (DDS): 0.521
Top Committers
Name Email Commits
olivier de Meringo d****o@g****m 403
Julien Nioche j****n@d****m 42
dependabot[bot] 4****]@u****m 32
olivier de Meringo o****r@d****m 10
DE MERINGO Olivier o****o@c****m 7
David Ekchajzer d****r@h****g 2
NevinDry n****6@h****r 2
Valentin Le Tallec v****c@h****r 2
Damien Fernandes c****5@g****m 1
Louis Delyon l****i@g****m 1
Louis Delyon l****n@s****m 1
OBIN Jean Francois j****n@s****m 1
damien.fernandes d****s@s****m 1
Committer Domains (Top 20 + Academic)
soprabanking.com: 2 soprasteria.com: 1 hubblo.org: 1 cimpa.com: 1 demeringo.com: 1 digitalpebble.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 142
  • Total pull requests: 544
  • Average time to close issues: 2 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 5
  • Total pull request authors: 8
  • Average comments per issue: 0.73
  • Average comments per pull request: 0.75
  • Merged pull requests: 201
  • Bot issues: 0
  • Bot pull requests: 363
Past Year
  • Issues: 32
  • Pull requests: 239
  • Average time to close issues: 6 days
  • Average time to close pull requests: 8 days
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 0.53
  • Average comments per pull request: 0.72
  • Merged pull requests: 72
  • Bot issues: 0
  • Bot pull requests: 177
View more stats
Top Authors
Issue Authors
  • demeringo (115)
  • jnioche (19)
  • damienfernandes (6)
  • NevinDry (1)
  • ValentinLeTallec (1)
Pull Request Authors
  • dependabot[bot] (363)
  • demeringo (121)
  • jnioche (41)
  • ValentinLeTallec (6)
  • damienfernandes (5)
  • NevinDry (5)
  • notCamelCaseName (2)
  • da-ekchajzer (1)
Top Labels
Issue Labels
enhancement (62) documentation (31) draft feature (28) bug (23) good first issue (18) help wanted (8) dependencies (5) question (4) ci (3) grafana (2) rust (1) duplicate (1) wontfix (1)
Pull Request Labels
dependencies (370) rust (224) javascript (139) enhancement (19) bug (9) documentation (6) grafana (4)

Packages

  • Total packages: 3
  • Total downloads:
    • cargo 757 total
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 55
  • Total maintainers: 1
proxy.golang.org: github.com/Boavizta/cloud-scanner
  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/boavizta/cloud-scanner
  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
crates.io: cloud-scanner-cli

Boavizta's Cloud-scanner estimates the environmental impacts of your AWS EC2 usage

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 757 Total
Rankings
Dependent repos count: 23.6%
Dependent packages count: 31.3%
Average: 50.1%
Downloads: 95.4%
Maintainers (1)
jnioche
Last synced: 6 months ago

Dependencies

Cargo.lock cargo
  • 203 dependencies
cloud-scanner-cli/Cargo.toml cargo
  • aws-config 0.15.0
  • aws-sdk-cloudwatch 0.15.0
  • aws-sdk-ec2 0.15.0
  • aws-smithy-types-convert 0.45
  • aws-types 0.15.0
  • chrono ^0.4
  • clap 3.2.5
  • isocountry ^0.3
  • log 0.4
  • loggerv 0.7
  • pkg-version *
  • prometheus-client *
  • serde ^1.0
  • serde_derive ^1.0
  • serde_json ^1.0
  • tokio 1
cloud-scanner-lambda/Cargo.toml cargo
  • envy *
  • lambda_http 0.5
  • lambda_runtime 0.5.1
  • log 0.4
  • pkg-version *
  • serde 1.0
  • serde_json 1.0
  • tokio 1.19.2
package-lock.json npm
  • 752 dependencies
package.json npm
  • serverless ^3.19.0 development
  • serverless-rust ^0.3.8 development
.github/workflows/docker-build-and-publish.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
Dockerfile docker
  • alpine latest build
  • chef latest build
  • rust 1.65 build
docker-compose.yml docker
  • docker.io/grafana/grafana latest
  • docker.io/prom/prometheus latest
  • ghcr.io/boavizta/boaviztapi 0.2.0
  • ghcr.io/boavizta/cloud-scanner-cli 0.2.1
.github/workflows/rust-test.yml actions
  • actions/checkout v3 composite
  • dtolnay/rust-toolchain stable composite
Cargo.toml cargo
.github/workflows/publish-doc.yml actions
  • actions/checkout v3 composite
  • jontze/action-mdbook v2 composite