Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Algolia Monitoring

Scalekit connector
Open markdown

The Algolia Monitoring connector lets your AI agent act in each user's Algolia Monitoring account. Each user connects their own Algolia Monitoring API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 9 tools.

Tools
9
What they doRead · write · destructive
9 · 0 · 09 read0 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Algolia Monitoring connection

    In AgentKit > Connections, create an Algolia Monitoring connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'algoliamonitoring'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Algolia Monitoring:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'algoliamonitoring_get_status',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Algolia Monitoring credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • algoliamonitoring_get_cluster_statusGet the current operational status of one or more specific Algolia clusters.Read-only

    Get Status of Selected Clusters

    Get the current operational status of one or more specific Algolia clusters. Returns a status map keyed by cluster name, where each value is operational, degraded_performance, partial_outage, or major_outage. Use this to check clusters you already know by name. Use get_status for every cluster, and list_cluster_incidents for incident history on these clusters.

    Inputs

    clustersstringrequired
    Comma-separated list of Algolia cluster names to query, with no spaces. Use the cluster names returned by get_status or list_servers. Example: c1-de,c2-de,c3-de.
  • algoliamonitoring_get_indexing_timeGet indexing latency metrics for one or more Algolia clusters.Read-only

    Get Indexing Time

    Get indexing latency metrics for one or more Algolia clusters. Returns time series per cluster name, where each point has a millisecond Unix timestamp and a latency value in milliseconds, measured on Algolia's internal monitoring index. Use this for infrastructure-level monitoring, not for the indexing performance of your own index. Use get_latency for search latency.

    Inputs

    clustersstringrequired
    Comma-separated list of Algolia cluster names to query, with no spaces. Use the cluster names returned by get_status or list_servers. Example: c1-de,c2-de,c3-de. These are infrastructure-level metrics, not a measure of a single application's indexing.
  • algoliamonitoring_get_infrastructure_metricsGet infrastructure metrics for your Algolia application, aggregated over a chosen time window.Read-only

    Get Infrastructure Metrics

    Get infrastructure metrics for your Algolia application, aggregated over a chosen time window. Returns time series keyed by metric and then by server name, where each point has a millisecond Unix timestamp and a value. Metrics cover CPU idleness, SSD usage, RAM used for search and indexing, and average build time. Use this for resource usage trends. Requires an Algolia Premium or Elevate plan. Use get_latency for search latency and get_cluster_status for current health.

    Inputs

    metricstringrequired
    Infrastructure metric to report. One of avg_build_time (average index build time in seconds), ssd_usage (SSD usage as a percentage of RAM), ram_search_usage (RAM used for search in MB), ram_indexing_usage (RAM used for indexing in MB), cpu_usage (CPU idleness in percent), or * to return all metrics. Example: cpu_usage.one of avg_build_timessd_usageram_search_usageram_indexing_usagecpu_usage*
    periodstringrequired
    Time window over which to aggregate the metrics. One of minute (last minute, 1 data point per 10 seconds), hour (last hour, 1 per minute), day (last day, 1 per 10 minutes), week (last week, 1 per hour), or month (last month, 1 per day). Example: week.one of minutehourdayweekmonth
  • algoliamonitoring_get_latencyGet the average search request latency for one or more Algolia clusters.Read-only

    Get Search Latency

    Get the average search request latency for one or more Algolia clusters. Returns time series per cluster name, where each point has a millisecond Unix timestamp and a latency value in milliseconds. Use this to measure search speed. Use get_indexing_time for indexing latency, and get_cluster_status for current health.

    Inputs

    clustersstringrequired
    Comma-separated list of Algolia cluster names to query, with no spaces. Use the cluster names returned by get_status or list_servers. Example: c1-de,c2-de,c3-de.
  • algoliamonitoring_get_reachabilityTest whether one or more Algolia clusters are reachable from Algolia's monitoring probes.Read-only

    Get Cluster Reachability

    Test whether one or more Algolia clusters are reachable from Algolia's monitoring probes. Returns a map keyed by cluster name, where each value maps a probe name to true when reachable or false when not. Use this to diagnose connectivity problems. Use get_cluster_status for the reported operational status.

    Inputs

    clustersstringrequired
    Comma-separated list of Algolia cluster names to query, with no spaces. Use the cluster names returned by get_status or list_servers. Example: c1-de,c2-de,c3-de.
  • algoliamonitoring_get_statusGet the current operational status of all Algolia clusters and instances.Read-only

    Get Status of All Clusters

    Get the current operational status of all Algolia clusters and instances. Returns a status map keyed by cluster name, where each value is operational, degraded_performance, partial_outage, or major_outage. Use this for a fleet-wide health overview. Use get_cluster_status to check specific clusters, and list_incidents for known incidents.

    Inputs

    This tool takes no inputs.

  • algoliamonitoring_list_cluster_incidentsList known incidents for one or more specific Algolia clusters.Read-only

    List Incidents for Selected Clusters

    List known incidents for one or more specific Algolia clusters. Returns incidents grouped by cluster name; each entry has a millisecond Unix timestamp and a details object with a title and a status (operational, degraded_performance, partial_outage, or major_outage). Use this when you know the cluster names. Use list_incidents for all clusters, and get_cluster_status for current health only.

    Inputs

    clustersstringrequired
    Comma-separated list of Algolia cluster names to query, with no spaces. Use the cluster names returned by get_status or list_servers. Example: c1-de,c2-de,c3-de.
  • algoliamonitoring_list_incidentsList known incidents across all Algolia clusters.Read-only

    List All Incidents

    List known incidents across all Algolia clusters. Returns incidents grouped by cluster name; each entry has a millisecond Unix timestamp and a details object with a title and a status (operational, degraded_performance, partial_outage, or major_outage). Use this for a fleet-wide incident history. Use list_cluster_incidents to limit results to specific clusters, and get_status for current health only.

    Inputs

    This tool takes no inputs.