# Metric template

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

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

and properties:

| Field         | Type   | Value restrictions                                                                                | Is required | Default Value   | Description                             |
| ------------- | ------ | ------------------------------------------------------------------------------------------------- | ----------- | --------------- | --------------------------------------- |
| `name`        | string | No spaces are allowed                                                                             | TRUE        | <p><br><br></p> | The name of the metric                  |
| `unit`        | string | A supported unit or a custom unit (see [supported units of measure](#supported-units-of-measure)) |             |                 | The unit of measure of the metric       |
| `description` | string |                                                                                                   | TRUE        | <p><br><br></p> | A description characterizing the metric |

### Supported units of measure

The supported units of measure for metrics are:

| Type                | Units                            |
| ------------------- | -------------------------------- |
| Temporal units      | 8d1e30b8411b4a09b8a45557bfcc72eb |
|                     |                                  |
| 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 | 44061697f4d74301a09b08da2e337b32 |
|                     |                                  |
| 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).