API clients / Go

Monitoring API client

This client is new in v4 of the Go API clients.

The Monitoring API client is part of the algoliasearch-client-go package. To install it, run:

Copy 
1

go get github.com/algolia/algoliasearch-client-go

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

Copy 
1

import "github.com/algolia/algoliasearch-client-go/v4/algolia/monitoring"

To create an instance of the client:

Copy 
1
2
3
4
5

client, err := monitoring.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

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?