Sep 20, 2024
Monitoring API client
This client is new in v4 of the Python API clients.
The Monitoring API client is part of the algoliasearch
package.
You can install this package with pip
:
Copy
1
pip install 'algoliasearch>=4,<5'
To use the Monitoring client, add this import to your files:
Copy
1
from algoliasearch.monitoring.client import MonitoringClientSync
To create an instance of the client:
Copy
1
2
# In an asynchronous context, you can use MonitoringClient instead, which exposes the exact same methods.
client = MonitoringClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
Async code
To use the Monitoring client in async environments, add these imports instead:
Copy
1
2
import asyncio
from algoliasearch.monitoring.client import MonitoringClient
The client supports the async with
statement to automatically close open connections.
Copy
1
2
3
async def run():
async with MonitoringClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
# client.search(...)
The method names are the same for synchronous and asynchronous methods.
List of methods
Each method makes one request to the Monitoring API.
Status
client.get_status | Retrieve status of all clusters |
client.get_cluster_status | Retrieve cluster status |
Incidents
client.get_incidents | Retrieve all incidents |
client.get_cluster_incidents | Retrieve cluster incidents |
Monitoring
client.get_servers | Retrieve servers |
client.get_latency | Retrieve search latency times |
client.get_indexing_time | Retrieve indexing times |
client.get_reachability | Test the reachability of clusters |
Infrastructure
client.get_metrics | Retrieve metrics |
Did you find this page helpful?