Monitoring API client

This client is new in v3 of the Ruby API clients.

The Monitoring API client is part of the algolia gem. To install this gem, run:

Copy

1
gem install algolia

To use the Monitoring client, add this import to your files:

Copy

1
require "algolia"

To create an instance of the client:

Copy

1
client = Algolia::MonitoringClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

List of methods

Each method makes one request to the Monitoring API.

client.get_status	Retrieve status of all clusters
client.get_cluster_status	Retrieve cluster status

client.get_incidents	Retrieve all incidents
client.get_cluster_incidents	Retrieve cluster incidents

client.get_servers	Retrieve servers
client.get_latency	Retrieve search latency times
client.get_indexing_time	Retrieve indexing times
client.get_reachability	Test the reachability of clusters

Retrieve metrics

Did you find this page helpful?