Apr 30, 2025
Monitoring API client
This client is new in v4 of the Java API clients.
The Monitoring API client is part of the algoliasearch package.
You can add this package to your pom.xml file for Maven:
Copy
1
2
3
4
5
<dependency>
<groupId>com.algolia</groupId>
<artifactId>algoliasearch</artifactId>
<version>4.23.0</version>
</dependency>
or to your build.gradle file for Gradle:
Copy
1
implementation 'com.algolia:algoliasearch:4.23.0'
To use the Monitoring client, add these imports to your files:
Copy
1
2
import com.algolia.api.MonitoringClient;
import com.algolia.config.*;
To create an instance of the client:
Copy
1
MonitoringClient client = new 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 |
Did you find this page helpful?