All pages
Powered by GitBook
1 of 1

Loading...

Metric template

Metrics are defined using a YAML manifest with the following structure:

and properties:

Field
Type
Value restrictions
Is required
Default Value
Description

name

string

Supported units of measure

The supported units of measure for metrics are:

Type
Units

Notice that supported units of measure are automatically scaled for visualization purposes. In particular, for units of information, Akamas uses a base 2 scaling for bytes, i.e., 1 kilobyte = 1024 bytes, 1 megabyte = 1024 kilobytes, and so on. Other units of measure are only scaled up using millions or billions (e.g., 124000000 custom units become 124 Mln custom units).

metrics:
  - name: "cpu_util"
    description: "cpu utilization"
    unit: "percent"
  - name: "mem_util"
    description: "memory utilization"
    unit: "percent"

no spaces are allowed

TRUE

The name of the metric

unit

string

A supported unit or a custom unit (see supported units of measure)

The unit of measure of the metric

description

string

TRUE

A description characterizing the metric

Temporal units

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

Units of infomation

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

Others

percent

terabytes

petabytes