Monitoring API

The monitoring API currently provides the following monitoring information:

  • Long-term cluster health indicators
  • Metrics for:
    • Cassandra status
    • reads and writes operations per second
    • CPU utilization
    • disk utilization
    • pending compactions

Metrics information is provided with either for an individual node or for all nodes in a cluster and cluster data centre.

The API also provides key statistics for each table in the cluster (similar to what is available through “nodetool tablehistograms”):

  • read & write counts (mean, distribution)
  • read & write latency (mean, distribution)
  • live cells & tombstones per read (mean, max)
  • number of sstables read for each read operation (mean, max)

The set of available metrics will expand as we build out this API. Descriptions of each of the metrics can be found in the monitoring section of this support site:
https://www.instaclustr.com/support/documentation/monitoring-information/

Visit https://developer.instaclustr.com/#tag/Monitoring-API for all Monitoring API operations.

Table of Contents

Authentication

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

All available metrics are updated every 20 seconds (i.e. requesting the same metric twice in 20 seconds will always return the same response).

Availability

Our APIs are engineered and operated for high levels of availability. However, you should not expect that our APIs have the same level of availability as a managed cluster and you should not build any dependency on the APIs into availability of your service. While we do not provide formal SLAs for the APIs, we aim for 99.95% availability (ie up to ~20 mins downtime per month). Longer maintenance outages may be schedule with appropriate notice. Consequently, any service dependent on the APIs should be able to cope gracefully with periods of unavailability of up to a few minutes. Planned and unplanned outages are communicated via https://status.instaclustr.com/.

Get Metrics

Metrics can be retrieved via API requests for either an individual node, or for all nodes in a cluster and cluster data centre. Send a request to https://api.instaclustr.com/monitoring/v1/clusters/{clusterId} with a metrics parameter to retrieve metrics.

Example: Get CPU Utilization metric and Network Out Delta Metric

Send a GET request to https://api.instaclustr.com/monitoring/v1/clusters/{clusterId}?metrics=n::cpuUtilization,n::networkoutdelta
The API will respond with status 200 OK and a JSON packet containing the following information:

Visit https://developer.instaclustr.com/#operation/getClusterBundle for a full list of available metrics.

Need Support
Learn More

Already have an account?
Login to the Console

Experiencing difficulties on the website or console?
Status page for known incidents


Don’t have an account yet?
Sign up for a free trial

Why sign up?
To experience the ease of creating and managing clusters via the Instaclustr Console.