Sep 20, 2024
Monitoring API client
This client is new in v3 of the PHP API clients.
The Monitoring API client is part of the algoliasearch-client-php
package.
To install this package, run:
Copy
1
composer require algolia/algoliasearch-client-php
To use the Monitoring client, add this import to your files:
Copy
1
use Algolia\AlgoliaSearch\Api\MonitoringClient;
To create an instance of the client:
Copy
1
$client = MonitoringClient::create('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?