Observabilité Exa

VérifiéSûr

Configurez la surveillance, les métriques et les alertes pour les intégrations de recherche Exa.

Spar Skills Guide Bot
DevOpsIntermédiaire
25/07/2026
Claude CodeCodex
#exa#observability#metrics#alerting#typescript

Recommandé pour

Synthèse automatique

Cette skill fournit des patrons d'instrumentation pour surveiller les appels à l'API de recherche Exa : latence, nombre de résultats, erreurs, taux de cache et qualité des résultats.

Points forts

  • Propose un wrapper `trackedSearch` prêt à l'emploi qui étiquette chaque mesure par type de recherche et par méthode (search vs searchAndContents)
  • Couvre aussi la qualité des résultats via le suivi d'usage par position et la valeur du contenu extrait
  • Inclut un cache instrumenté qui expose les compteurs hits/misses
  • L'émetteur de métriques est volontairement agnostique (Prometheus, Datadog, OpenTelemetry) avec des exemples en commentaire

Limites

  • Le backend de métriques et les règles d'alerte ne sont pas réellement configurés : ce sont des commentaires à adapter soi-même
  • Suppose une intégration Exa en TypeScript avec le SDK exa-js ; aucun exemple dans un autre langage
  • Le code du cache surveillé est tronqué dans le document (getStats incomplet), il faut le compléter
Quand l'utiliser

À utiliser lorsqu'une intégration Exa existe déjà en production et qu'il faut ajouter des métriques, un suivi de qualité ou des alertes.

Quand l'éviter

À éviter si vous n'avez pas encore d'intégration Exa fonctionnelle ou si vous cherchez une configuration complète de tableaux de bord et de seuils d'alerte clés en main.

Analyse de sécurité

Sûr
Score qualité78/100

The skill is documentation-only with allowed-tools limited to Read, Write, and Edit. All code samples are benign monitoring instrumentation for a legitimate Exa search API client; there are no destructive shell commands, no credential exfiltration (the API key is read from an env var), no base64 payloads, and no attempts to disable safety mechanisms. Network/API calls appear solely in illustrative example code for the user's own application, so listing this poses no meaningful execution risk.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Instrument Exa search latency
Wrap my Exa search client so it emits latency and result-count metrics tagged by search type (neural vs keyword) and by method, using my Datadog statsd client instead of the console emitter.
Track result quality and cache
Add metrics to my Exa integration that track which result positions get used downstream, plus hit/miss counters for a cached search layer.
Alert on Exa errors
Help me instrument my Exa client to track error rates by HTTP status code and daily search volume so I can set up Slack alerts for budget and failures.

name: exa-observability description: | Set up monitoring, metrics, and alerting for Exa search integrations. Use when implementing monitoring for Exa operations, building dashboards, or configuring alerting for search quality and latency. Trigger with phrases like "exa monitoring", "exa metrics", "exa observability", "monitor exa", "exa alerts", "exa dashboard". allowed-tools: Read, Write, Edit version: 1.0.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io compatible-with: claude-code, codex, openclaw tags: [saas, exa, monitoring, observability]


Exa Observability

Overview

Monitor Exa search API performance, result quality, and cost efficiency. Key metrics: search latency by type (neural ~500-2000ms, keyword ~200-500ms), result count per query, cache hit rates, error rates by status code, and daily search volume for budget tracking.

Prerequisites

  • Exa API integration in production
  • Metrics backend (Prometheus, Datadog, or OpenTelemetry)
  • Alerting system (PagerDuty, Slack, or equivalent)

Instructions

Step 1: Instrument the Exa Client

import Exa from "exa-js";

const exa = new Exa(process.env.EXA_API_KEY);

// Generic metrics emitter (replace with your metrics library)
function emitMetric(name: string, value: number, tags: Record<string, string>) {
  // Prometheus: histogram/counter.observe(value, tags)
  // Datadog: dogstatsd.histogram(name, value, tags)
  // OpenTelemetry: meter.createHistogram(name).record(value, tags)
  console.log(`[metric] ${name}=${value}`, tags);
}

async function trackedSearch(query: string, options: any = {}) {
  const start = performance.now();
  const type = options.type || "auto";
  const hasContents = options.text || options.highlights || options.summary;

  try {
    const method = hasContents ? "searchAndContents" : "search";
    const results = hasContents
      ? await exa.searchAndContents(query, options)
      : await exa.search(query, options);

    const duration = performance.now() - start;

    emitMetric("exa.search.duration_ms", duration, { type, method });
    emitMetric("exa.search.result_count", results.results.length, { type });
    emitMetric("exa.search.success", 1, { type });

    return results;
  } catch (err: any) {
    const duration = performance.now() - start;
    const status = String(err.status || "unknown");

    emitMetric("exa.search.duration_ms", duration, { type, status });
    emitMetric("exa.search.error", 1, { type, status });

    throw err;
  }
}

Step 2: Track Result Quality

// Measure whether search results are actually used downstream
function trackResultUsage(
  searchId: string,
  resultIndex: number,
  action: "clicked" | "used_in_context" | "discarded"
) {
  emitMetric("exa.result.usage", 1, {
    action,
    position: String(resultIndex),
  });
  // Results at position 0-2 should have high usage
  // If top results are discarded, query needs tuning
}

// Track content extraction value
function trackContentValue(result: any) {
  if (result.text) {
    emitMetric("exa.content.text_length", result.text.length, {});
  }
  if (result.highlights) {
    emitMetric("exa.content.highlight_count", result.highlights.length, {});
  }
}

Step 3: Cache Monitoring

class MonitoredCache {
  private hits = 0;
  private misses = 0;
  private cache: Map<string, { data: any; expiry: number }> = new Map();

  async search(exa: Exa, query: string, opts: any) {
    const key = `${query}:${opts.type}:${opts.numResults}`;
    const cached = this.cache.get(key);

    if (cached && cached.expiry > Date.now()) {
      this.hits++;
      emitMetric("exa.cache.hit", 1, {});
      return cached.data;
    }

    this.misses++;
    emitMetric("exa.cache.miss", 1, {});

    const results = await exa.searchAndContents(query, opts);
    this.cache.set(key, { data: results, expiry: Date.now() + 3600 * 1000 });
    return results;
  }

  getStats() {
    const total = this.hits + this.misses;
    return {
      hits: this.hits,
      misses: this.misses,
      hitRate: total > 0 ? `${((this.hits / total) * 100).toFixed(1)}%` : "N/A",
    };
  }
}

Step 4: Prometheus Alert Rules

groups:
  - name: exa_alerts
    rules:
      - alert: ExaHighLatency
        expr: histogram_quantile(0.95, rate(exa_search_duration_ms_bucket[5m])) > 3000
        for: 5m
        annotations:
          summary: "Exa search P95 latency exceeds 3 seconds"

      - alert: ExaHighErrorRate
        expr: rate(exa_search_error[5m]) / rate(exa_search_success[5m]) > 0.05
        for: 5m
        annotations:
          summary: "Exa API error rate exceeds 5%"

      - alert: ExaEmptyResults
        expr: rate(exa_search_result_count{result_count="0"}[15m]) > 0.2
        for: 10m
        annotations:
          summary: "Over 20% of Exa searches returning empty results"

      - alert: ExaCacheHitRateLow
        expr: rate(exa_cache_hit[5m]) / (rate(exa_cache_hit[5m]) + rate(exa_cache_miss[5m])) < 0.3
        for: 15m
        annotations:
          summary: "Exa cache hit rate below 30% — check query patterns"

Step 5: Health Check Endpoint

app.get("/health/exa", async (_req, res) => {
  const start = performance.now();
  try {
    const result = await exa.search("health check", { numResults: 1 });
    const latencyMs = Math.round(performance.now() - start);
    res.json({
      status: "healthy",
      latencyMs,
      resultCount: result.results.length,
    });
  } catch (err: any) {
    res.status(503).json({
      status: "unhealthy",
      error: err.message,
      latencyMs: Math.round(performance.now() - start),
    });
  }
});

Dashboard Panels

| Panel | Metric | Purpose | |-------|--------|---------| | Search Volume | rate(exa.search.success) | Traffic trends | | Latency P50/P95 | histogram_quantile(exa.search.duration_ms) | Performance SLO | | Error Rate | exa.search.error / exa.search.success | Reliability | | Result Quality | exa.result.usage{action="discarded"} | Query tuning signal | | Cache Hit Rate | exa.cache.hit / (hit + miss) | Cost efficiency | | Daily Cost | sum(exa.search.success) | Budget tracking |

Error Handling

| Issue | Cause | Solution | |-------|-------|----------| | 429 Too Many Requests | Rate limit exceeded | Implement backoff + request queue | | Zero results returned | Query too narrow | Broaden query, remove domain filter | | Latency spike to 5s+ | Deep/neural on complex query | Switch to fast or auto type | | Budget exhausted | Uncapped search volume | Add application-level budget tracking |

Resources

Next Steps

For incident response, see exa-incident-runbook. For cost optimization, see exa-cost-tuning.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/exa-observability-mrzxur0p/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/exa-observability-mrzxur0p' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/exa-observability-mrzxur0p/download' --output '.skill-downloads/exa-observability-mrzxur0p/SKILL.md.part' && mv '.skill-downloads/exa-observability-mrzxur0p/SKILL.md.part' '.skill-downloads/exa-observability-mrzxur0p/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit

Extrait original : Prerequisites
  • Exa API integration in production
  • Metrics backend (Prometheus, Datadog, or OpenTelemetry)
  • Alerting system (PagerDuty, Slack, or equivalent)

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/exa-observability-mrzxur0p/SKILL.md' && test -s '.skill-downloads/exa-observability-mrzxur0p/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/exa-observability' && cp -R '.skill-downloads/exa-observability-mrzxur0p' '.claude/skills/exa-observability'

Codex
test -f '.skill-downloads/exa-observability-mrzxur0p/SKILL.md' && test -s '.skill-downloads/exa-observability-mrzxur0p/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/exa-observability' && cp -R '.skill-downloads/exa-observability-mrzxur0p' '.agents/skills/exa-observability'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/exa-observability-mrzxur0p'

openskills read 'exa-observability-mrzxur0p'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/exa-observability-mrzxur0p/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires