Monitoring API client

This client is new in v5 of the JavaScript API clients.

The Monitoring API client is part of the @algolia/monitoring package. To install it, run:

Copy

1
npm install @algolia/monitoring

To use this client, run:

Copy
import { monitoringClient } from "@algolia/monitoring";

const client = monitoringClient(
    "ALGOLIA_APPLICATION_ID",
    "ALGOLIA_API_KEY",
);

List of methods

Each method makes one request to the Monitoring API.

Status

client.getStatus	Retrieve status of all clusters
client.getClusterStatus	Retrieve cluster status

Incidents

client.getIncidents	Retrieve all incidents
client.getClusterIncidents	Retrieve cluster incidents

Monitoring

client.getServers	Retrieve servers
client.getLatency	Retrieve search latency times
client.getIndexingTime	Retrieve indexing times
client.getReachability	Test the reachability of clusters

Infrastructure

client.getMetrics

Retrieve metrics