Metric template

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

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

and properties:

FieldTypeValue restrictionsIs requiredDefault ValueDescription

name

string

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

Supported units of measure

The supported units of measure for metrics are:

TypeUnits

Temporal units

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

nanoseconds

microseconds

milliseconds

seconds

minutes

hours

Units of infomation

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

bits

kilobits

megabits

gigabit

terabit

petabit

bytes

kilobytes

megabytes

gigabytes

terabytes

petabytes

Others

percent

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).

Last updated