metalmetrics 4.3.1

Metal Metrics

metalmetrics

Introduction

metalmetrics is a worker of metalflow written in Python.

Requirement

• Python >= 3.7

Run

• Local mode

  git clone https://github.com/craftslab/metalmetrics-py.git
  
  cd metalmetrics-py
  pip install -Ur requirements.txt
  python metrics.py --config-file="config.yml" --inxi-file="inxi" --output-file="output.json"
  

• Service mode

  git clone https://github.com/craftslab/metalmetrics-py.git
  
  cd metalmetrics-py
  pip install -Ur requirements.txt
  python metrics.py --config-file="config.yml" --inxi-file="inxi" --listen-url="127.0.0.1:9090"
  

Docker

• Local mode

  git clone https://github.com/craftslab/metalmetrics-py.git
  
  cd metalmetrics-py
  docker build --no-cache -f Dockerfile -t craftslab/metalmetrics-py:latest .
  docker run -it -v /tmp:/tmp craftslab/metalmetrics-py:latest ./metalmetrics --config-file="config.yml" --output-file="/tmp/output.json"
  

• Service mode

  git clone https://github.com/craftslab/metalmetrics-py.git
  
  cd metalmetrics-py
  docker build --no-cache -f Dockerfile -t craftslab/metalmetrics-py:latest .
  docker run -it -p 9090:9090 craftslab/metalmetrics-py:latest ./metalmetrics --config-file="config.yml" --listen-url="127.0.0.1:9090"
  

Usage

usage: metrics.py [-h] --config-file CONFIG_FILE [--inxi-file INXI_FILE]
                  [--listen-url LISTEN_URL | --output-file OUTPUT_FILE] [-v]

Metal Metrics

optional arguments:
  -h, --help            show this help message and exit
  --config-file CONFIG_FILE
                        config file (.yml)
  --inxi-file INXI_FILE
                        inxi file (/path/to/inxi)
  --listen-url LISTEN_URL
                        listen url (host:port)
  --output-file OUTPUT_FILE
                        output file (.json|.txt|.xlsx)
  -v, --version         show program's version number and exit

Settings

metalmetrics parameters can be set in the directory config.

An example of configuration in config.yml:

apiVersion: v1
kind: worker
metadata:
  name: metalmetrics
spec:
  bare:
    - cpu
    - disk
    - io
    - ip
    - kernel
    - mac
    - network
    - os
    - ram
    - system
  container:
  kubernetes:

Design

License

Project License can be found here.

Reference

• gRPC
• health-check-script
• inxi
• python-diamond
• sysperf