Monitoring API client

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

The Monitoring API client is part of the algoliasearch-scala package. You can add this package to your build.gradle.kts file:

Copy
implementation("com.algolia:algoliasearch-client-kotlin:3.18.4")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")

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

Copy

1
2
3
import com.algolia.client.api.MonitoringClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*

To create an instance of the client:

Copy

1
val client = MonitoringClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "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