> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Santé et préparation

> Surveillance de la santé de l'API, des points de terminaison de disponibilité et de la page d'état.

Surveillez la santé de l'API Truthlocks, vérifiez la disponibilité des dépendances et intégrez-vous à votre pile d'observabilité.

## Points de terminaison de santé

### Sonde de vivacité

Vérifie si l'API est en cours d'exécution. À utiliser pour les sondes de vivacité Kubernetes :

```http theme={null}
GET https://api.truthlocks.com/health/live

# Response (200 OK)
{
  "status": "ok",
  "timestamp": "2026-01-13T12:00:00Z"
}
```

### Sonde de préparation

Vérifie si l'API est prête à servir le trafic (toutes les dépendances sont saines) :

```http theme={null}
GET https://api.truthlocks.com/health/ready

# Response (200 OK - All systems operational)
{
  "status": "ok",
  "timestamp": "2026-01-13T12:00:00Z",
  "checks": {
    "database": "ok",
    "redis": "ok",
    "signing_service": "ok",
    "transparency_log": "ok"
  }
}
```

```http theme={null}
# Response (503 Service Unavailable - Degraded)
{
  "status": "degraded",
  "timestamp": "2026-01-13T12:00:00Z",
  "checks": {
    "database": "ok",
    "redis": "timeout",
    "signing_service": "ok",
    "transparency_log": "ok"
  }
}
```

## Configuration Kubernetes

Si vous développez des applications qui dépendent de Truthlocks, configurez vos sondes pour vérifier à la fois votre application et l'API Truthlocks :

```yaml theme={null}
apiVersion: v1
kind: Deployment
metadata:
  name: my-app
spec:
  template:
    spec:
      containers:
        - name: app
          livenessProbe:
            httpGet:
              path: /health/live
              port: 8080
            initialDelaySeconds: 5
            periodSeconds: 10
          readinessProbe:
            httpGet:
              path: /health/ready
              port: 8080
            initialDelaySeconds: 10
            periodSeconds: 5
            failureThreshold: 3
```

### Exemple de vérification de l'état de préparation (application)

```javascript theme={null}
// Include Truthlocks health in your app's readiness
app.get('/health/ready', async (req, res) => {
  const checks = {
    database: await checkDatabase(),
    truthlock: await checkTruthlock(),
  };

  const allHealthy = Object.values(checks).every(c => c === 'ok');

  res.status(allHealthy ? 200 : 503).json({
    status: allHealthy ? 'ok' : 'degraded',
    checks,
  });
});

async function checkTruthlock(): Promise<string> {
  try {
    const res = await fetch('https://api.truthlocks.com/health/ready', {
      timeout: 5000,
    });
    return res.ok ? 'ok' : 'degraded';
  } catch {
    return 'unreachable';
  }
}
```

## Page d'état

Vérifiez l'état de santé et la disponibilité du service en temps réel sur [status.truthlocks.com](https://status.truthlocks.com). La page d'état se rafraîchit automatiquement toutes les 60 secondes et ne nécessite aucune authentification.

### Services surveillés

La page d'état suit la santé de chaque service principal indépendamment :

| Service | Description |
| - | - |
| Passerelle API | Point d'accès API principal pour toutes les requêtes |
| Registre de confiance | Gestion et gouvernance des émetteurs |
| Facturation | Traitement des abonnements et des paiements |
| Signature | Opérations de signature cryptographique |
| Attestations | Frappe et gestion des attestations |
| Journaux d'audit | Journalisation des activités et conformité |
| Journal de transparence | Journal cryptographique en ajout seulement |
| Vérification | Vérification du paquet de preuves |
| Identité machine | Enregistrement d'agent, sessions et score de confiance |
| IA CMO | Modération et orchestration de contenu IA |

Chaque service signale l'un des quatre statuts : **operational**, **degraded**, **outage**, ou **unknown**. La page affiche un temps de réponse par service et une bannière d'état de santé globale du système.

### Historique de disponibilité

Une barre de disponibilité de 90 jours indique la disponibilité quotidienne de chaque service. Passez la souris sur n'importe quel jour pour voir la date et le pourcentage de disponibilité. Un pourcentage de disponibilité global est affiché à côté de chaque service.

### Historique des incidents

Visitez la page **Historique des incidents** pour voir les incidents passés sous forme de chronologie. Chaque entrée comprend le niveau de gravité, les services affectés et les mises à jour horodatées de l'enquête à la résolution.

### S'abonner aux notifications

Entrez votre e-mail en bas de la page d'état pour recevoir les notifications d'incident. Vous serez informé lorsque des incidents sont créés, mis à jour ou résolus.

Les clients d'entreprise peuvent également configurer des rappels de webhook pour recevoir automatiquement les événements de changement de statut.

### API de statut programmatique

Interroger l'API de statut pour la santé du service lisible par machine. Utilisez ceci pour intégrer la disponibilité de Truthlocks dans vos propres tableaux de bord, pipelines d'alerte ou vérifications préliminaires. Aucune authentification n'est requise.

```http theme={null}
GET https://status.truthlocks.com/api/health
```

Le point de terminaison renvoie l'état global du système, un horodatage et un tableau de vérifications de santé par service :

```json theme={null}
{
  "status": "operational",
  "timestamp": "2026-03-26T14:30:00Z",
  "services": [
    {
      "id": "api-gateway",
      "name": "API Gateway",
      "status": "operational",
      "responseTime": 42
    },
    {
      "id": "signing-service",
      "name": "Signing",
      "status": "degraded",
      "responseTime": 1200,
      "error": "HTTP 503"
    }
  ]
}
```

**Champs de réponse :**

| Champ | Type | Description |
| - | - | - |
| `status` | chaîne | État général du système : `operational`, `degraded`, ou `outage`. |
| `timestamp` | string | Horodatage ISO 8601 de la vérification. |
| `services` | array | Résultats de santé par service. |
| `services[].id` | chaîne | Identifiant de service lisible par machine (par exemple, `api-gateway`, `signing-service`). |
| `services[].name` | string | Nom de service lisible par l'homme. |
| `services[].status` | chaîne | État du service : `operational`, `degraded`, ou `outage`. |
| `services[].responseTime` | number or null | Temps de réponse en millisecondes, ou `null` si inaccessible. |
| `services[].error` | chaîne | Présent uniquement lorsque le service n'est pas opérationnel. |

Le statut global est `outage` si un service est en panne, `degraded` si un service est lent ou renvoie des erreurs, et `operational` lorsque tous les services sont sains.

**Exemple : interroger le statut depuis votre application**

```javascript theme={null}
async function checkTruthlockStatus() {
  const res = await fetch("https://status.truthlocks.com/api/health");
  const data = await res.json();

  if (data.status !== "operational") {
    console.warn(`Truthlocks is ${data.status}`);
    const issues = data.services.filter((s) => s.status !== "operational");
    issues.forEach((s) => console.warn(`  ${s.name}: ${s.status} — ${s.error}`));
  }

  return data;
}
```

**Exemple : vérification préalable avant la frappe**

Vérifiez que les services de signature et d'attestation sont sains avant de tenter une opération de frappe. Cela évite les tentatives inutiles lorsque vous savez déjà que les services requis sont en panne.

```javascript theme={null}
async function mintWithStatusCheck(attestation) {
  const status = await fetch("https://status.truthlocks.com/api/health");
  const health = await status.json();

  const signing = health.services.find((s) => s.id === "signing-service");
  const attestations = health.services.find(
    (s) => s.id === "attestation-service"
  );

  if (
    signing?.status !== "operational" ||
    attestations?.status !== "operational"
  ) {
    throw new Error("Required services are not operational — retry later");
  }

  return client.attestations.mint(attestation);
}
```

> [!NOTE]
>
> L'API d'état est soumise à des limites de débit pour éviter les abus. Pour une surveillance continue,
> interroger pas plus fréquemment qu'une fois toutes les 30 secondes.

Pour le schéma de réponse complet, les ID de service surveillés et des exemples supplémentaires, consultez la [référence de l'API de statut](https://docs.truthlocks.com/fr/api-reference/health/status.md).

> [card] [Page de statut](https://status.truthlocks.com)
>
> État du service en temps réel et historique des incidents.

> [card] Notifications de webhook
>
> Les clients d'entreprise peuvent configurer des rappels de webhook pour les changements de statut.

> [card] [Référence de l'API de statut](https://docs.truthlocks.com/api-reference/health/status.md)
>
> Référence API complète pour le point de terminaison de statut programmatique.

> [card] Alertes par e-mail
>
> Abonnez-vous sur la page d'état pour les notifications d'incidents.

## Engagements de niveau de service

Les objectifs de disponibilité, la couverture du support, les temps de réponse et les crédits de service ne s'appliquent que s'ils sont explicitement convenus dans le contrat applicable. Les contrôles de santé publics signalent l'état du service observé ; ils n'établissent pas un pourcentage de disponibilité garanti, une capacité de récupération de bout en bout ou un calendrier de support doté en personnel. Confirmez le déploiement actuel et les preuves de récupération avant de vous fier à un engagement.

## Intégration de la surveillance

Intégrez les vérifications de santé de Truthlocks à vos outils d'observabilité:

```yaml Prometheus theme={null}
# prometheus.yml
scrape_configs:
  - job_name: "truthlock-health"
    scrape_interval: 30s
    metrics_path: /metrics
    static_configs:
      - targets: ["api.truthlocks.com"]
```

```yaml Datadog theme={null}
# datadog.yaml
init_config:

instances:
  - name: truthlock_api
    url: https://api.truthlocks.com/health/ready
    timeout: 5
    content_match: '"status":"ok"'
    http_response_status_code: 200
    tags:
      - service:truthlock
      - env:production
```

```javascript Custom Dashboard Metrics theme={null}
// Export key metrics for dashboards
const metrics = {
  "truthlock.availability": isHealthy ? 1 : 0,
  "truthlock.latency_ms": responseTime,
  "truthlock.ratelimit_remaining": rateLimitRemaining,
  "truthlock.attestations_today": dailyCount,
};
```

## Résilience de la passerelle

La passerelle API inclut une récupération automatique en cas de panne et un support de déploiement sans interruption :

* **Récupération après panique** — Si la passerelle rencontre une erreur interne inattendue, elle se rétablit automatiquement et renvoie une réponse d'erreur structurée au lieu de couper votre connexion. Vous n'avez pas besoin de gérer les connexions interrompues causées par des paniques au niveau de la passerelle.
* **Arrêt gracieux** — Lors des déploiements, la passerelle et le service de signature traitent les requêtes en cours sur une fenêtre de 15 secondes au lieu de les terminer immédiatement. Si vous avez précédemment rencontré des échecs de requêtes occasionnels pendant les fenêtres de maintenance, ceux-ci ne devraient plus se produire.

Ces protections fonctionnent automatiquement et ne nécessitent aucune modification de votre intégration.

## Réponse aux incidents

Si Truthlocks rencontre des problèmes :

1. **Consulter la page d'état :** [status.truthlocks.com](https://status.truthlocks.com)
2. **Activer le disjoncteur :** Échouez gracieusement dans votre application
3. **Opérations de file d'attente** : Réessayez la frappe d'attestation plus tard
4. **Contacter le support** : Pour l'escalade SLA Entreprise

### Modèle de disjoncteur

```javascript theme={null}
import CircuitBreaker from "opossum";

const breaker = new CircuitBreaker(
  async (attestation) => client.attestations.mint(attestation),
  {
    timeout: 5000, // Fail if no response in 5s
    errorThresholdPercentage: 50, // Open if 50% fail
    resetTimeout: 30000, // Try again after 30s
  },
);

breaker.fallback(() => {
  // Queue for retry later
  queue.add("retry-attestation", attestation);
  return { queued: true };
});
```

## Prochaines étapes

> [card] [Tableau de bord d'observabilité](https://docs.truthlocks.com/guides/observability.md)
>
> Surveillez la santé du service, la latence et l'utilisation depuis la console.

> [card] [Référence des erreurs](https://docs.truthlocks.com/ops/errors.md)
>
> Liste complète des codes d'erreur et de leur gestion.

> [card] [Limites de débit](https://docs.truthlocks.com/ops/limits.md)
>
> Gérer la limitation de débit avec élégance.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.