Get Database Insights

This endpoint returns the Insights series of a database: service latency percentiles, read, write, engine, replication, lock-wait and Lua latency, expired entries, replication lag, throughput, bandwidth and disk size, for the whole database, one replica or every region, with each series’ latest window compared to the one before it, and how much the limit, security and Lua counters grew over the period. Latencies are in milliseconds. Available for databases on a Pro plan or with the Production Pack.

1 min read

get/redis/insights/{id}

Request example

curl --request GET \
  --url https://api.upstash.com/v2/redis/insights/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/redis/insights/{id}"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.upstash.com/v2/redis/insights/{id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);

Response

{
  "groups": [
    {
      "key": "<string>",
      "label": "<string>",
      "kind": "all"
    }
  ],
  "metrics": {},
  "comparison_window": "3h",
  "comparison": {},
  "counters": {},
  "anomalies": {}
}

get/redis/insights/{id}

Authorization

Authorizationstringheaderrequired#

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded username:password.

Path parameters

idstringrequired#

The ID of the database

Query parameters

periodstring#

The period of the series: 1h, 3h, 12h, 1d, 3d, 7d or 30d. Defaults to 3h.

Default: "3h"

replicastring#

Restrict the series to one replica, by the key of a group whose kind is replica. Other keys are rejected with 400.

byenum<string>#

Set to region to receive one series per region next to the total.

Options:region

Responses

application/json

200

Database insights retrieved successfully

groupsobject[]#

Every group the database has, regardless of the scope requested

Show child attributes

keystring#

Key of the group in metrics and comparison for the all and region groups; pass a replica group's key as the replica parameter

labelstring#

kindenum<string>#

Options:allregionreplica

metricsobject#

Metric name to group key to data points. The all group is always present; region groups are added with by=region. Metrics: latency_p50, latency_p90, latency_p99, read_latency_99, write_latency_99, command_latency_99, replication_latency_999, wait_latency_99, lua_latency_p50, lua_latency_99, expired_entries (per minute), replication_lag (entries), throughput, bandwidth (bytes per second) and diskusage.

Show child attributes

{key}object#

Show child attributes

{key}object[]#

Show child attributes

xstring#

Timestamp of the point

ynumber#

comparison_windowstring#

Length of the latest window the comparison averages: the whole period up to three hours, the last three hours for longer periods.

comparisonobject#

Metric name to group key to the mean over the latest window and over the equal window right before it. previous is absent when that earlier window has no data.

Show child attributes

{key}object#

Show child attributes

{key}object#

Show child attributes

currentnumber#

previousnumber#

countersobject#

Growth of each counter over the period, for the whole database: over_size_requests (TCP and REST), over_size_record_accesses, throttled_commands (writes delayed by persistence backpressure), undeliverable (requests and connections the proxies could not hand to any replica), auth_failures (TCP and REST, including commands sent before authenticating and REST requests over the rate limit), keyspace_notifications, connections_opened, bandwidth_ingress, bandwidth_egress (bytes), rest_commands, lua_executions, lua_commands (commands run inside scripts), lua_failures, lua_timeouts and lua_memory_limits.

Show child attributes

{key}object#

Show child attributes

totalnumber#

last_atstring#

End of the last bucket the counter grew in, absent when it did not grow

seriesobject[]#

Growth inside each bucket of the period

Show child attributes

xstring#

Timestamp of the point

ynumber#

anomaliesobject#

Metric name to up to three anomalies of its all series, largest first: stretches where the value stayed above both the period's median plus three standard deviations, estimated as 1.4826 times the median absolute deviation, and 30% over the median. A series with fewer than 8 points after its first positive value reports none. The median is raised to a small per-metric floor, so a nearly idle series does not report huge changes. An empty stretch at the start of the series is ignored, and a stretch longer than a third of the analyzed points is a level change, not an anomaly. Every metric is present; diskusage is never checked and always has an empty list.

Show child attributes

{key}object[]#

Show child attributes

startstring#

x of the first point above the threshold

endstring#

x of the last point above the threshold

peakstring#

x of the highest point

peak_valuenumber#

baselinenumber#

Typical level of the period, the median raised to the metric's floor

changenumber#

peak_value / baseline - 1, where 1 means +100%

Get Database Traffic Create Redis Database