# Metrics v1.2.0

Edera metrics are currently in **Alpha**. New metrics are expected to be added, and existing metrics are subject to change.

Edera exposes a set of metrics to provide an overview of the health and performance of Edera and the infrastructure it runs on.

## Available metrics

The following metrics are exposed by Edera:

### Zone metrics

Zone metrics encapsulates metrics obtained from an Edera Zone.

| Metric                       | Description                                                                 | Type   | Labels                                            |
|------------------------------|-----------------------------------------------------------------------------|--------|--------------------------------------------------|
| `zone_cpu_usage_percent`     | CPU usage in percent, in the range 0-100.                                  | `gauge`| `cpu`, `zone_id`, `k8s_namespace`, `k8s_pod`   |
| `zone_create_time`          | Time when zone was created as a Unix timestamp with millisecond resolution. | `gauge`| `zone_id`, `k8s_namespace`, `k8s_pod`           |
| `zone_memory_bytes_total`    | Total number of bytes of memory allocated to the zone.                     | `gauge`| `zone_id`, `k8s_namespace`                       |
| `zone_memory_free_bytes`     | Number of bytes of memory allocated to the zone and currently unused.      | `gauge`| `zone_id`, `k8s_namespace`                       |
| `zone_memory_used_bytes`     | Number of bytes of memory allocated to the zone and currently in use.      | `gauge`| `zone_id`, `k8s_namespace`                       |
| `zone_ready_time`           | Time when a zone is ready for use as a Unix timestamp with millisecond resolution. | `gauge`| `zone_id`, `k8s_namespace`, `k8s_pod`           |
| `zones`                      | Current number of zones, per state.                                       | `gauge`| `state`                                         |

### Host metrics

Host metrics encapsulates metrics obtained from the host of Edera, also referred to as `dom0`.

| Metric                        | Description                                                 | Type   | Labels |
|-------------------------------|-------------------------------------------------------------|--------|--------|
| `host_cpu_usage_percent`      | CPU usage in percent, in the range 0-100.                   | `gauge`| `cpu`  |
| `host_memory_bytes_total`     | Total number of bytes of memory allocated to the host.      | `gauge`|        |
| `host_memory_free_bytes`      | Number of bytes of memory allocated to the host and currently unused. | `gauge`|        |
| `host_memory_used_bytes`      | Number of bytes of memory allocated to the host and currently in use. | `gauge`|        |

### Label examples

Exposed metrics may contain labels, which provides additional context, such as the zone a metric is being populated from, and allows for more detailed querying and filtering.

| Label         | Description                                   | Example                                      |
|---------------|-----------------------------------------------|----------------------------------------------|
| `cpu`        | Name of the CPU.                             | `cpu="cpu1"` or `cpu="1"`               |
| `k8s_namespace` | Name of the Kubernetes namespace the zone is in. | `k8s_namespace="default"`                  |
| `k8s_pod`   | Kubernetes pod ID the zone is related to.   | `k8s_pod="nginx-deployment-7d6c54b4c6-g84cl"` |
| `state`     | State of the Edera zone.                     | `state="ready"` or `state="failed"`     |
| `zone_id`   | ID of the Edera zone.                        | `zone_id="7568edad-3a34-47e3-b605-36ede54a9aab"` |

## Collect metrics

Edera metrics are exposed by in the Prometheus format, by default on `http://127.0.0.1:3035/metrics`. If an alternative address is preferred, it can be provided to the `metrics-http-listen-addr` flag on the `protect-orchestrator` service. Metrics can be viewed directly via the `/metrics` endpoint, or scraped by third-party tooling.

Last updated on 2026-01-08.
