Sep 20, 2024
Monitoring API client
This client is new in v2 of the Scala API clients.
The Monitoring API client is part of the algoliasearch-scala
package.
You can add this package to your build.sbt
file:
Copy
1
2
3
4
// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.7.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.7.0"
To use the Monitoring client, add these imports to your files:
Copy
1
import algoliasearch.api.MonitoringClient
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 |
Did you find this page helpful?