WeOS
5.29.0

# Metrics

## Introduction

The metrics provides the time sensitive data about the system cpu(s), memory and port(s) at regular interval.

## Sample rate

The sample rate in seconds determines the interval at which the metrics is collected and updated. The default sample rate is 20 seconds

### CPU

The system provides the current cpu utilization (load) for each cpu core and summary of utilisation in total.

### Memory

The system provides the following memory metrics

- Memory Metrics:
- Total Memory (kB)
- Used Memory (kB) and in percentage of total memory
- Free Memory (kB) and in percentage of total memory
- Available Memory (kB) and in percentage of total memory

### Ports

The system provides the following memory metrics

- Port Metrics:
- Speed (Mbit/s) and duplex full or half
- Inbound bitrate per second
- Outbound bitrate per second
- Utilisation

## Port-utilisation

By default the port metrics are not enabled and it needs to be enabled to collect and present port metrics

## Web

The metrics can be viewed in open metrics format by enabling the web option. The default port is 9100. It is possible to configure ports between 1024 and 65535.

Warning

Metrics data available on the Web works only if https is enabled in the management

## SNMP

Enables metrics data to be available via SNMP request

## Configuration

    example:/#> configure
    example:/config/#> metrics

### Syntax

`[no] enable`

  Enable/Disable metrics.

  no
    Disable.
`[no] port-utilization PORT`

  Enable collection and presentation metrics on the PORT

  no
    disable metrics on the PORT
  PORT
    The port that metrics data will be collected and presented.
`[no] sample-rate SAMPLE-RATE`

  Set the interval at which metrics data are collected and updated

  no
    set the sample rate to default
  SAMPLE-RATE
    The interval in seconds
`[no] web PORT-NO`

  Enable metrics data to be available via PORT-NO

  no
    Disable metrics data on web
  PORT-NO
    The port number the metrics data is available
`[no] SNMP`

  Enable metrics data to be available via SNMP request

  no
    Metrics data will not be available via SNMP request

## Status Cpu Utilisation

    example:/#> show metrics cpu-utilisation
    CPU utilisation
        cpu     0.28 %
        cpu0    0.28 %

## Status Memory Utilisation

    example:/#> show metrics memory-utilisation
    Memory
        MemoryTotal       103192.00 kB
        MemoryUsed         95168.00 kB  (92.00 %)
        MemoryFree          8024.00 kB  (7.00 %)
        MemoryAvailable    37452.00 kB  (36.00 %)

## Status Port Utilisation

    example:/#> show metrics port-utilisation
    Port    Speed       Inbound         Outbound       Utilisation
    Eth1    100M-Full   n/a             n/a            n/a
    Eth2    ---------   n/a             n/a            n/a
    Eth3    100M-Full   36.3 Mbit/s     2697.6 kbit/s  18%
    Eth4    100M-Full   6051.0 kbit/s   2697.6 kbit/s  3%

« Previous Next »