green-monitoring

Tracks an open-source stack of services that monitor the energy and CO2-eq emissions of IOS-XR, NX-OS devices, Meraki switches, UCSs, ACI APIC nodes, Eaton and Raritan PDUs.

https://github.com/cisco-open/green-monitoring

Science Score: 13.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
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.9%) to scientific vocabulary

Keywords

co2-emissions energy power sustainability
Last synced: 6 months ago · JSON representation

Repository

Tracks an open-source stack of services that monitor the energy and CO2-eq emissions of IOS-XR, NX-OS devices, Meraki switches, UCSs, ACI APIC nodes, Eaton and Raritan PDUs.

Basic Info
  • Host: GitHub
  • Owner: cisco-open
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 6.07 MB
Statistics
  • Stars: 25
  • Watchers: 4
  • Forks: 8
  • Open Issues: 2
  • Releases: 0
Topics
co2-emissions energy power sustainability
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Code of conduct Security Authors

README.md

Green Monitoring Stack

Project Status: Active – The project has reached a stable, usable state and is being actively developed. License Build For Better 2024 Winner

Table of contents

About the project

A monitoring stack with samples for collection and data exploration for sustainability purposes.

The data is collected from Network, DC (compute / storage) infrastructure, third-party devices and external sources to be able to understand the energy consumption and its relation to traffic and bandwidth, the cost and the carbon footprint of the environment at various levels of granularity.

KPIs

| Element | KPI | | :---------- | :------------ | | network device | power
power supply load
power supply efficiency

traffic
bandwidth utilization
power consumption ratio (PCR) - reference

CO2-eq emissions (+ historical)
cost| | server | power
utilization
temperature

CO2-eq emissions
cost | | pdu | power | | rack | power
TBD: temperature|

Technology stack

Architecture Architecture

Captures data from: - IOS-XR routers - NX-OS switches - Meraki switches - UCS servers - ACI APIC - Raritan PDUs - Eaton PDUs

Stores data in: - InfluxDB v2

Exposes data in: - Grafana

Data Flow:

IOS-XR
NX-OS
Meraki
ACI APIC                   -> Telegraf     ->     InfluxDB     -> Grafana
UCS: REDFISH/CIMC/UCSM
Raritan PDUs
Eaton PDUs

Getting started

Prerequisites

Use these instructions.

Configuration

Use these instructions.

Installation

Use these instructions.

Usage

Access

Access the two following WebUIs by replacing the HOST_IP placeholder with the reachable IP address of the host that runs the stack:

  • Grafana - hosts custom visualizations.
  • Influx (credentials based on .env) - for exploration of raw data.

Dashboards

Overview power - Meraki - organization/switches Overview power - Meraki - organization/switches

Overview power - DC - Nexus Overview power - DC - Nexus

Overview CO2-eq emissions - DC - Nexus Overview CO2-eq emissions - DC - Nexus

Overview power - NCS, ASR 9K, Cisco 8K Overview power - NCS, ASR 9K, Cisco 8K

Overview CO2-eq emissions - NCS, ASR 9K, Cisco 8K Overview CO2-eq emissions - NCS, ASR 9K, Cisco 8K

Historical overview of CO2-eq emissions - Fretta Historical overview of CO2-eq emissions - Fretta

Power - DC - UCS Power - DC - UCS

Temperature - DC - UCS Temperature - DC - UCS

Utilization - DC - UCS Utilization - DC - UCS

Rack view - DC - UCS 1/3 Rack view - DC - UCS 1/3

Rack view - DC - UCS 2/3 Rack view - DC - UCS 2/3

Rack view - DC - UCS 3/3 Rack view - DC - UCS 3/3

PDUs - Raritan PDUs - Raritan

PDUs - Eaton PDUs - Eaton

Cost - DC - Nexus and UCS Cost - DC - Nexus and UCS

PCR (Power consumption ratio) versus Traffic PCR versus traffic - Cisco 8201

PCR (Power consumption ratio) versus Bandwidth utilization - concept PCR versus bandwidth utilization

PCR (Power consumption ratio) versus Bandwidth utilization - NCS PCR versus bandwidth utilization

PCR (Power consumption ratio) versus Bandwidth utilization - ASR 9K and Cisco 8K PCR versus bandwidth utilization

Bandwidth utilization and distribution per interface PCR versus bandwidth utilization

Specifications

The collections available are documented in SPECS.md.

FAQ

See FAQ.md.

Contributing

Contributions are highly appreciated. Please follow the guidelines documented in CONTRIBUTING.md.

License

Distributed under the Apache License Version 2.0. See the LICENSE for more information.

Contact

  • Cristina Precup - cprecup@cisco.com
  • Guillaume Ladhuie - gladhuie@cisco.com
  • Jean-Baptiste Lefeuvre - jlefeuvr@cisco.com
  • Oren Brigg - obrigg@cisco.com
  • Patrice Nivaggioli - pnivaggi@cisco.com
  • Philippe Tubello - ptubello@cisco.com
  • Salvatore Faraone - sfaraone@cisco.com
  • Steven Barth - stbarth@cisco.com

Acknowledgements

Owner

  • Name: Cisco
  • Login: cisco-open
  • Kind: organization
  • Email: oss-github@cisco.com

GitHub Events

Total
  • Watch event: 5
  • Issue comment event: 1
  • Fork event: 3
Last Year
  • Watch event: 5
  • Issue comment event: 1
  • Fork event: 3

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 13
  • Total Committers: 4
  • Avg Commits per committer: 3.25
  • Development Distribution Score (DDS): 0.385
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
cprecup c****p@c****m 8
lelia l****a@m****m 3
Oleksii Borisenko b****i@g****m 1
dependabot[bot] 4****]@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 10
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 9 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 21.2
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 1
  • Bot pull requests: 2
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 3 months
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • cprecup (3)
  • allstar-app[bot] (1)
Pull Request Authors
  • cprecup (7)
  • dependabot[bot] (3)
  • oborys (2)
  • lelia (2)
Top Labels
Issue Labels
enhancement (2) bug (1) allstar (1)
Pull Request Labels
dependencies (3) enhancement (2) bug (1) documentation (1)

Dependencies

stack/docker-compose.yml docker
  • grafana/grafana 9.2.0
  • influxdb 2.0.4-alpine
stack/telegraf/Dockerfile docker
  • telegraf 1.24-alpine build
stack/telegraf/requirements.txt pypi
  • imcsdk ==0.9.12
  • pytz ==2023.3
  • pyyaml ==6.0
  • raritan ==20210223.0
  • requests ==2.31.0
  • ucsmsdk ==0.9.13
stack/telegraf/telegraf.d/raritan-power/requirements.txt pypi
  • pytz ==2022.1
  • pyyaml ==6.0
  • raritan ==20210223.0
stack/telegraf/telegraf.d/ucs-power-temp-util/requirements.txt pypi
  • imcsdk ==0.9.12
  • pyyaml ==6.0
  • ucsmsdk ==0.9.13