RArafftechnologies
Managed Databases

Get metrics

Changed on

Latest usage snapshot: CPU, memory, storage, connections, and replication lag. Metrics refresh about every 60 seconds; zero values mean not measured yet, and -1 means the engine does not report that number.

get/api/v1/databases/{database_id}/metrics

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/databases/{database_id}/metrics
  • Auth
    API key in header X-API-Key

Path parameters

database_idstring required

Database ID (UUID) or short id (the database_id field, e.g. a1b2c3d4)

Response

Latest metrics snapshot

successboolean
cpu_used_millicoresinteger

CPU in use, millicores

cpu_capacity_millicoresinteger

CPU capacity, millicores

mem_used_bytesinteger

Memory in use, bytes

mem_capacity_bytesinteger

Memory capacity, bytes

storage_used_bytesinteger

Storage in use, bytes

storage_capacity_bytesinteger

Storage capacity, bytes

connections_activeinteger

Active client connections

connections_maxinteger

Connection limit

replication_lag_bytesinteger

Standby/replica lag in bytes (0 without HA or replicas)

archive_lag_bytesinteger

WAL archiving lag in bytes (PostgreSQL)

metrics_updated_atstring

When this snapshot was taken, RFC 3339 (empty before the first sample)

pooled_connections_activeinteger

Client connections on the pooler (PostgreSQL)

pooled_connections_maxinteger

Pooler connection limit (PostgreSQL)

ops_per_secnumber

Transactions (PostgreSQL), queries (MySQL, ClickHouse) or commands (Valkey) per second. -1 when not measured

cache_hit_pctnumber

Share of reads served from memory, percent. -1 when not measured

evictions_per_minnumber

Keys removed because memory was full, per minute (Valkey). -1 for other engines

merges_runninginteger

Background merges running (ClickHouse). -1 for other engines

compression_rationumber

Data size before compression divided by size on disk (ClickHouse). -1 for other engines

pooler_server_activeinteger

Server connections the pooler is using (PostgreSQL). -1 without a pooler

pooler_server_idleinteger

Idle server connections in the pool (PostgreSQL). -1 without a pooler

pooler_cl_waitinginteger

Client connections waiting for a server connection (PostgreSQL). Above 0 for long means the pool is too small for the load

pooler_maxwait_usinteger

Longest current wait for a server connection, microseconds (PostgreSQL)

pooler_versionstring

Pooler version (PostgreSQL)

conn_rejected_totalinteger

Connections refused because the limit was reached, since the database started. -1 when not measured

conn_idle_timeout_secsinteger

Seconds after which idle connections are closed. -1 when not set

storage_data_bytesinteger

Part of storage_used_bytes taken by data. -1 when not measured

storage_log_bytesinteger

Part of storage_used_bytes taken by the write-ahead or binary log. -1 when not measured

storage_read_onlyboolean

True while storage is at 95% or more and PostgreSQL or MySQL accept reads only. Writes come back below 90%

Changes

  • 89ec42a2108bRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 26292956c4b3Revision changes
    • breaking

      the //// response's property format changed from date-time to no format for status