MCPcopy Index your code
hub / github.com/Boavizta/cloud-scanner

github.com/Boavizta/cloud-scanner @v3.2.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v3.2.1 ↗ · + Follow
2,467 symbols 6,064 edges 16 files 48 documented · 2%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
<img src="https://github.com/da-ekchajzer/cloud-scanner/blob/main/cloudscanner_color.svg" height="100">

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


  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 📡

Extension points exported contracts — how you extend this code

Inventoriable (Interface)
(no doc) [1 implementers]
cloud-scanner-cli/src/cloud_provider.rs
ImpactProvider (Interface)
(no doc) [1 implementers]
cloud-scanner-cli/src/impact_provider.rs

Core symbols most depended-on inside this repo

get_version
called by 5
cloud-scanner-cli/src/lib.rs
estimate_impacts
called by 4
cloud-scanner-cli/src/lib.rs
get_average_cpu
called by 4
cloud-scanner-cli/src/aws_cloud_provider.rs
get_average_cpu_usage_of_last_10_minutes
called by 4
cloud-scanner-cli/src/aws_cloud_provider.rs
get_raws_impacts
called by 4
cloud-scanner-cli/src/boavizta_api_v1.rs
get_impacts
called by 4
cloud-scanner-cli/src/boavizta_api_v1.rs
get_impacts_as_metrics
called by 3
cloud-scanner-cli/src/lib.rs
boa_impacts_to_cloud_resource_with_impacts
called by 3
cloud-scanner-cli/src/boavizta_api_v1.rs

Shape

Function 2,246
Method 146
Class 66
Enum 7
Interface 2

Languages

TypeScript95%
Rust5%

Modules by API surface

docs/mermaid.min.js2,336 symbols
cloud-scanner-cli/src/model.rs29 symbols
cloud-scanner-cli/src/aws_cloud_provider.rs22 symbols
cloud-scanner-cli/src/boavizta_api_v1.rs16 symbols
cloud-scanner-cli/src/metric_exporter.rs13 symbols
cloud-scanner-cli/src/lib.rs8 symbols
cloud-scanner-cli/src/usage_location.rs7 symbols
cloud-scanner-cli/src/standalone_server.rs7 symbols
cloud-scanner-lambda/src/main.rs6 symbols
cloud-scanner-lambda/src/metrics.rs5 symbols
cloud-scanner-cli/src/main.rs5 symbols
cloud-scanner-cli/src/inventory_exporter.rs5 symbols

For agents

$ claude mcp add cloud-scanner \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact