Health and maintenance

Get instance metrics

Returns instance-wide counters, how much memory, CPU and disk this server uses, and process uptime. The counters are counted when you ask. Requires instance.read; the counters include records outside your content permissions.

GET
/metrics

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Response body

About errors

Server metrics

application/json
  1. response
items*

Instance-wide item counts.

blobs*

Stored blob counts and size.

types*

Built-in and registered type counts.

keys*

Number of keys that haven't been revoked or expired.

webhooks*

Number of webhook registrations.

uptime_seconds*number

Seconds since this server process started.

process*

What this server process costs, since it started.

storage*

Database size and row counts.

  • validation_error: the query has a parameter this endpoint doesn't take.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

forbidden: your credential lacks instance.read.

application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/metrics'
About errors
{  "items": {    "total": 9,    "by_state": {      "active": 9    }  },  "blobs": {    "count": 1,    "total_bytes": 42  },  "types": {    "core": 29,    "registered": 3  },  "keys": {    "total": 1  },  "webhooks": {    "total": 1  },  "uptime_seconds": 3,  "process": {    "version": "0.0.0",    "memory_rss_bytes": 37257216,    "memory_rss_peak_bytes": 48201728,    "cpu_user_seconds": 0.139065,    "cpu_system_seconds": 0.065418  },  "storage": {    "database_bytes": 909312,    "wal_bytes": 5051152,    "rows": {      "items": 9,      "versions": 4,      "event_log": 37,      "audit_log": 67    }  }}