View Cluster Metrics

Get Metrics via Telemetry API

Metrics can be retrieved via the Telemetry API as described below:

Request

curl --get https://dcd.ionos.com/telemetry/api/v1/query_range \
--data-urlencode "query=ionos_dbaas_postgres_memory_available_bytes{postgres_cluster=\"498ae72f-411f-11eb-9d07-046c59cc737e\"}" \
--data-urlencode "start=2022-12-06T12:32:37.076Z" \
--data-urlencode "end=2022-12-06T12:47:37.076Z" \
--data-urlencode "step=60" \
--header 'Authorization: Bearer your_JWT_token'

Response

{
  "status": "success",
  "data": {
    "resultType": "matrix",
    "result": [
      {
        "metric": {
          "__name__": "ionos_dbaas_postgres_memory_available_bytes",
          "cloud_service": "default",
          "contract_number": "123456",
          "instance": "ionos-498ae72f-411f-11eb-9d07-046c59cc737e-4oymiqu-0",
          "postgres_cluster": "498ae72f-411f-11eb-9d07-046c59cc737e",
          "role": "master"
        },
        "values": [
          [
            1670329957.076,
            "1071443968"
          ],
          ...
        ]
      },
      {
        "metric": {
          "__name__": "ionos_dbaas_postgres_memory_available_bytes",
          "cloud_service": "default",
          "contract_number": "123456",
          "instance": "ionos-498ae72f-411f-11eb-9d07-046c59cc737e-4oymiqu-1",
          "postgres_cluster": "498ae72f-411f-11eb-9d07-046c59cc737e",
          "role": "replica"
        },
        "values": [
          [
            1670329957.076,
            "1086152704"
          ],
          ...
        ]
      }
    ]
  }
}

Follow MaaS documentation for more information on how to authenticate and available endpoints.

Metrics Overview

Name	Labels	Description
ionos_dbaas_postgres_connections_count	contract_number, instance, postgres_cluster, role, state	Number of connections per instance and state. The state is one of the following: active, disabled, fastpath function call, idle, idle in transaction, idle in transaction (aborted).
ionos_dbaas_postgres_cpu_rate5m	contract_number, instance, postgres_cluster, role	The average CPU utilization over the past 5 minutes.
ionos_dbaas_postgres_disk_io_time_weighted_seconds_rate5m	contract_number, instance, postgres_cluster, role	The rate of disk I/O time, in seconds, over a five-minute period. Provides insight into performance of a disk, as high values may indicate that the disk is being overused or is experiencing performance issues.
ionos_dbaas_postgres_instance_count	contract_number, instance, postgres_cluster, role	Desired number of instances. The number of currently ready and running instances may be different. ionos_dbaas_postgres_role provides information about running instances split by role.
ionos_dbaas_postgres_load5	contract_number, instance, postgres_cluster, role	Linux load average for the last 5 minutes. This metric is represented as a number between 0 and 1 (can be greater than 1 on multicore machines), where 0 indicates that the CPU core is idle and 1 indicates that the CPU core is fully utilized. Higher values may indicate that the system is experiencing performance issues or is approaching capacity.
ionos_dbaas_postgres_memory_available_bytes	contract_number, instance, postgres_cluster, role	Available memory in bytes.
ionos_dbaas_postgres_memory_total_bytes	contract_number, instance, postgres_cluster, role	Total memory of the underlying machine in bytes. Some of it is used for our management and monitoring tools and not available to PostgreSQL. During horizontal scaling you might see different values for each instance.
ionos_dbaas_postgres_role	contract_number, instance, postgres_cluster, role	Current role of the instance. Provides whether an instance is currently "master" or "replica".
ionos_dbaas_postgres_storage_available_bytes	contract_number, instance, postgres_cluster, role	Free available disk space per instance in bytes.
ionos_dbaas_postgres_storage_total_bytes	contract_number, instance, postgres_cluster, role	Total disk space per instance in bytes. During horizontal scaling you might see different values for each instance.
ionos_dbaas_postgres_transactions:rate2m	contract_number, datid, datname, instance, postgres_cluster, role	Per-second average rate of SQL transactions (that have been committed), calculated over the last 2 minutes.
ionos_dbaas_postgres_user_tables_idx_scan	contract_number, datname, instance, postgres_cluster, relname, role, schemaname	Number of index scans per table/schema.
ionos_dbaas_postgres_user_tables_seq_scan	contract_number, datname, instance, postgres_cluster, relname, role, schemaname	Number of sequential scans per table/schema. A high number of sequential scans may indicate that an index should be added to improve performance.