Redis Metrics

Menu

Authentication

All requests to the API must use Basic Authentication and contain a valid username and monitoring API key. API keys are created per user account and can be retrieved via the Instaclustr Console from the Account > API Key tab.

Requests

Metrics are requested by constructing a GET request, consisting of:

  • Type: Either ‘clusters’, ‘datacentres’ or ‘nodes’.
    • ‘clusters’ returns the metrics for each node in the cluster.
    • ‘datacentres’ returns the metrics for each node belonging to the datacenter.
    • ‘nodes’ returns the metrics for a specific node.
  • UUID or public IP: If the type is set to ‘clusters’ or ‘datacentres’, then the UUID of cluster or datacentre must be specified. However, if the type is set to ‘nodes’, then either the nodes’ UUID or public IP may be specified.
  • metrics: The metrics to return are specified as a comma-delimited query string parameter. Up to 20 metrics may be specified.
  • reportNaN: (true|false) If a metric value is NaN or null, reportNaN determines whether API should report it as NaN. The default behaviour is false and NaN and null will be reported as 0. Setting ‘reportNaN=true’ will return NaN values in the API response.

Metrics

Redis specific metrics in the monitoring API begin with the r:: prefix, ie. r::masterSlotsCount.

The currently available metrics are:

r::masterSlotsCount – The number of hash slots a master node has been assigned.  The number of hash slots of all master nodes should add to 16384.

r::clusterUnassignedSlotsCount – Number of slots which are NOT associated to some node (unbound). This number should be 0 for the cluster to work properly, which means that each hash slot should be mapped to a master node.

r::clusterSlotsNotOkCount – Number of hash slots mapping to a node in FAIL or PFAIL state.  This number should be 0 for a working cluster.

Example

Response:

FREE TRIAL

Spin up a cluster in less
than 5 minutes.
(No credit card required)

Sign Up Now
Close

Site by Swell Design Group