cisco-open / green-monitoring Goto Github PK

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.

License: Apache License 2.0

Shell 12.11% Dockerfile 5.78% Python 82.12%

co2-emissions energy power sustainability

green-monitoring's Introduction

Green Monitoring Stack

Green Monitoring Stack

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 CO₂-eq emissions (+ historical) cost
server	power utilization temperature CO₂-eq emissions cost
pdu	power
rack	power TBD: temperature

Technology stack

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

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 - DC - Nexus

Overview CO₂-eq emissions - DC - Nexus

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

Overview CO₂-eq emissions - NCS, ASR 9K, Cisco 8K

Historical overview of CO₂-eq emissions - Fretta

Power - DC - UCS

Temperature - DC - UCS

Utilization - DC - UCS

Rack view - DC - UCS 1/3

Rack view - DC - UCS 2/3

Rack view - DC - UCS 3/3

PDUs - Raritan

PDUs - Eaton

Cost - DC - Nexus and UCS

PCR (Power consumption ratio) versus Traffic

PCR (Power consumption ratio) versus Bandwidth utilization - concept

PCR (Power consumption ratio) versus Bandwidth utilization - NCS

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

Bandwidth utilization and distribution per interface

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 - [email protected]
Guillaume Ladhuie - [email protected]
Jean-Baptiste Lefeuvre - [email protected]
Oren Brigg - [email protected]
Patrice Nivaggioli - [email protected]
Philippe Tubello - [email protected]
Salvatore Faraone - [email protected]
Steven Barth - [email protected]

Acknowledgements

green-monitoring's People

Contributors

Stargazers

Watchers

Forkers

cisco-emea-cx-cto yuanzhongqiao asagod57

green-monitoring's Issues

Security Policy violation Branch Protection

This issue was automatically created by Allstar.

Security Policy Violation
Dismiss stale reviews not configured for branch main
PR Approvals below threshold 0 : 1 for branch main

⚠️ There is an updated version of this policy result! Click here to see the latest update

This issue will auto resolve when the policy is in compliance.

Issue created by Allstar. See https://github.com/ossf/allstar/ for more information. For questions specific to the repository, please contact the owner or maintainer.

Collector service fails to build - pyyaml - cause: release of Cython 3

Description

Collector service fails when resolving dependencies for Python module pyyaml==6.0 due to the release of Cython 3.
See this discussion for more context: yaml/pyyaml#724.

Expected Behavior

Collector resolves all dependencies and builds successfully.

Actual Behavior

Collector build process fails during step 5/6:

=> ERROR [5/6] RUN if [ -z "$HTTPS_PROXY" ] ;    then pip3 install --upgrade pip && pip3 install -r /requirements.txt;    else pip3 install  21.3s
------                                                                                                                                              
 > [5/6] RUN if [ -z "$HTTPS_PROXY" ] ;    then pip3 install --upgrade pip && pip3 install -r /requirements.txt;    else pip3 install --proxy $HTTPS_PROXY --upgrade pip && pip3 install --proxy $HTTPS_PROXY -r /requirements.txt;    fi:                                                              
#0 6.546 Requirement already satisfied: pip in /usr/lib/python3.10/site-packages (22.3.1)                                                           
#0 7.048 Collecting pip
#0 7.218   Downloading pip-23.2.1-py3-none-any.whl (2.1 MB)
#0 7.392      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 12.8 MB/s eta 0:00:00
#0 7.467 Installing collected packages: pip
#0 7.468   Attempting uninstall: pip
#0 7.472     Found existing installation: pip 22.3.1
#0 7.480     Uninstalling pip-22.3.1:
#0 9.179       Successfully uninstalled pip-22.3.1
#0 12.46 Successfully installed pip-23.2.1
#0 12.46 WARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv
#0 14.09 Collecting pytz==2023.3 (from -r /requirements.txt (line 1))
#0 14.23   Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB)
#0 14.33      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 5.5 MB/s eta 0:00:00
#0 14.37 Collecting raritan==20210223.0 (from -r /requirements.txt (line 2))
#0 14.40   Downloading raritan-20210223.0-py3-none-any.whl (126 kB)
#0 14.43      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 126.1/126.1 kB 7.8 MB/s eta 0:00:00
#0 14.53 Collecting pyyaml==6.0 (from -r /requirements.txt (line 3))
#0 14.56   Downloading PyYAML-6.0.tar.gz (124 kB)
#0 14.58      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 125.0/125.0 kB 13.7 MB/s eta 0:00:00
#0 15.13   Installing build dependencies: started
#0 20.65   Installing build dependencies: finished with status 'done'
#0 20.65   Getting requirements to build wheel: started
#0 21.05   Getting requirements to build wheel: finished with status 'error'
#0 21.07   error: subprocess-exited-with-error
#0 21.07   
#0 21.07   × Getting requirements to build wheel did not run successfully.
#0 21.07   │ exit code: 1
#0 21.07   ╰─> [48 lines of output]
[...]
#0 21.07       AttributeError: cython_sources
#0 21.07       [end of output]
[...]

Affected Version

Initial projct version with pyyaml==6.0.

Steps to Reproduce

Build collector

docker-compose build telegraf

Resolution

Enforce compatible version of PyYAML: pyyaml==6.0.1.

Checklist

I have read the contributing guidelines
I have verified this does not duplicate an existing issue

Migrate support from CO2 Signal to Electricity Maps API

Problem Statement

Support for CO2 Signal tokens becomes deprecated (see https://www.co2signal.com).

Proposed Solution

Add integration with Electricity Maps API. Tokens can be obtained at https://api-portal.electricitymaps.com.

Alternatives Considered

Removal of CO2 Signal API integration. This support is maintained for now for users that still have functional tokens.

Monitor power for Meraki switches

Problem Statement

Currently, the stack does not collect data from the Meraki Dashboard API for the PoE ports information for each switch.

Proposed Solution

Provide a metric per switch with this information. Provide the total switches' power per organization.

Alternatives Considered

Provide PoE per port.

Additional Context

References:

cisco-open / green-monitoring Goto Github PK

green-monitoring's Introduction

Green Monitoring Stack

Table of contents

About the project

KPIs

Technology stack

Getting started

Prerequisites

Configuration

Installation

Usage

Access

Dashboards

Specifications

FAQ

Contributing

License

Contact

Acknowledgements

green-monitoring's People

Contributors

Stargazers

Watchers

Forkers

green-monitoring's Issues

Description

Expected Behavior

Actual Behavior

Affected Version

Steps to Reproduce

Resolution

Checklist

Problem Statement

Proposed Solution

Alternatives Considered

Problem Statement

Proposed Solution

Alternatives Considered

Additional Context

Recommend Projects

Recommend Topics

Recommend Org