> ## 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.

# Gesundheit & Bereitschaft

> Überwachung der API-Integrität, Bereitschafts-Endpunkte und Statusseite.

Überwachen Sie die Integrität der Truthlocks-API, prüfen Sie die Bereitschaft für Abhängigkeiten und integrieren Sie sie in Ihren Observability-Stack.

## Health-Endpunkte

### Liveness-Probe

Prüfen, ob die API läuft. Für Kubernetes Liveness-Probes verwenden:

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

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

### Bereitschaftsprüfung

Prüfen, ob die API bereit ist, Traffic zu bedienen (alle Abhängigkeiten fehlerfrei):

```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"
  }
}
```

## Kubernetes-Konfiguration

Wenn Sie Anwendungen entwickeln, die von Truthlocks abhängen, konfigurieren Sie Ihre Probes so, dass sie sowohl Ihre App als auch die Truthlocks API überprüfen:

```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
```

### Beispiel Bereitschaftsprüfung (App)

```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';
  }
}
```

## Statusseite

Überprüfen Sie den Echtzeit-Dienstzustand und die Verfügbarkeit unter [status.truthlocks.com](https://status.truthlocks.com). Die Statusseite wird alle 60 Sekunden automatisch aktualisiert und erfordert keine Authentifizierung.

### Überwachte Dienste

Die Statusseite verfolgt den Zustand jedes Kerndienstes unabhängig:

| Dienst | Beschreibung |
| - | - |
| API Gateway | Haupt-API-Endpunkt für alle Anfragen |
| Trust Registry | Ausstellerverwaltung und -governance |
| Abrechnung | Abonnement- und Zahlungsabwicklung |
| Signieren | Kryptografische Signaturvorgänge |
| Attestierungen | Attestierungserstellung und -verwaltung |
| Audit-Protokolle | Aktivitätsprotokollierung und Compliance |
| Transparenzprotokoll | Kryptografisches, nur anhängendes Protokoll |
| Verifizierung | Überprüfung des Proof-Bundles |
| Maschinenidentität | Agentenregistrierung, Sitzungen und Vertrauensbewertung |
| AI CMO | KI-Inhaltsmoderation und -Orchestrierung |

Jeder Dienst meldet einen von vier Status: **betriebsbereit**, **eingeschränkt**, **Ausfall** oder **unbekannt**. Die Seite zeigt eine dienstspezifische Antwortzeit und ein Banner für den allgemeinen Systemzustand an.

### Verfügbarkeitsverlauf

Eine 90-Tage-Uptime-Leiste zeigt die tägliche Verfügbarkeit für jeden Dienst an. Fahren Sie mit der Maus über einen beliebigen Tag, um das Datum und den Uptime-Prozentsatz anzuzeigen. Ein Gesamt-Uptime-Prozentsatz wird neben jedem Dienst angezeigt.

### Vorfallhistorie

Besuchen Sie die Seite **Vorfallhistorie**, um vergangene Vorfälle in einem Zeitachsenformat anzuzeigen. Jeder Eintrag enthält den Schweregrad, die betroffenen Dienste und zeitgestempelte Aktualisierungen von der Untersuchung bis zur Lösung.

### Benachrichtigungen abonnieren

Geben Sie Ihre E-Mail-Adresse unten auf der Statusseite ein, um Benachrichtigungen über Vorfälle zu erhalten. Sie werden benachrichtigt, wenn Vorfälle erstellt, aktualisiert oder gelöst werden.

Unternehmenskunden können auch Webhook-Callbacks konfigurieren, um Statusänderungsereignisse automatisch zu empfangen.

### Programmatische Status-API

Die Status-API für maschinenlesbare Dienstzustandsinformationen abfragen. Verwenden Sie dies, um die Verfügbarkeit von Truthlocks in Ihre eigenen Dashboards, Alarmierungs-Pipelines oder Vorabprüfungen zu integrieren. Keine Authentifizierung erforderlich.

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

Der Endpunkt gibt den gesamten Systemstatus, einen Zeitstempel und ein Array von Gesundheitsprüfungen pro Dienst zurück:

```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"
    }
  ]
}
```

**Antwortfelder:**

| Feld | Typ | Beschreibung |
| - | - | - |
| `status` | string | Gesamtsystemzustand: `operational`, `degraded` oder `outage`. |
| `timestamp` | string | ISO 8601 Zeitstempel der Prüfung. |
| `services` | array | Gesundheitsergebnisse pro Dienst. |
| `services[].id` | string | Maschinenlesbare Dienstkennung (z. B. `api-gateway`, `signing-service`). |
| `services[].name` | string | Menschenlesbarer Dienstname. |
| `services[].status` | string | Dienstzustand: `operational`, `degraded` oder `outage`. |
| `services[].responseTime` | number or null | Antwortzeit in Millisekunden, oder `null`, wenn unerreichbar. |
| `services[].error` | string | Nur vorhanden, wenn der Dienst nicht betriebsbereit ist. |

Der Gesamtstatus ist `outage`, wenn ein Dienst ausgefallen ist, `degraded`, wenn ein Dienst langsam ist oder Fehler zurückgibt, und `operational`, wenn alle Dienste fehlerfrei sind.

**Beispiel: Statusabfrage aus Ihrer App**

```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;
}
```

**Beispiel: Vorabprüfung vor dem Prägen**

Überprüfen Sie, ob die Signatur- und Attestierungsdienste fehlerfrei sind, bevor Sie einen Mint-Vorgang versuchen. Dies vermeidet unnötige Wiederholungsversuche, wenn Sie bereits wissen, dass die erforderlichen Dienste ausgefallen sind.

```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]
>
> Die Status-API ist ratenbegrenzt, um Missbrauch zu verhindern. Für die kontinuierliche Überwachung,
> nicht häufiger als einmal alle 30 Sekunden abfragen.

Das vollständige Antwortschema, die IDs der überwachten Dienste und weitere Beispiele finden Sie in der [Status-API-Referenz](https://docs.truthlocks.com/de/api-reference/health/status.md).

> [card] [Statusseite](https://status.truthlocks.com)
>
> Echtzeit-Dienstzustand und Vorfallhistorie.

> [card] Webhook-Benachrichtigungen
>
> Unternehmen können Webhook-Callbacks für Statusänderungen konfigurieren.

> [card] [Status API-Referenz](https://docs.truthlocks.com/api-reference/health/status.md)
>
> Vollständige API-Referenz für den programmatischen Status-Endpunkt.

> [card] E-Mail-Benachrichtigungen
>
> Abonnieren Sie die Statusseite für Benachrichtigungen über Vorfälle.

## Service-Level-Verpflichtungen

Verfügbarkeitsziele, Supportabdeckung, Reaktionszeiten und Service-Gutschriften gelten nur, wenn dies im anwendbaren Vertrag explizit vereinbart wurde. Öffentliche Gesundheitsprüfungen melden den beobachteten Dienstzustand; sie begründen keine garantierte Betriebszeit in Prozent, End-to-End-Wiederherstellungsfähigkeit oder einen besetzten Supportplan. Bestätigen Sie die aktuelle Bereitstellung und die Wiederherstellungsnachweise, bevor Sie sich auf eine Zusage verlassen.

## Überwachungsintegration

Integrieren Sie Truthlocks-Gesundheitsprüfungen in Ihre Observability-Tools:

```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,
};
```

## Gateway-Resilienz

Das API-Gateway umfasst automatische Panikwiederherstellung und Zero-Downtime-Bereitstellungsunterstützung:

* **Panikwiederherstellung** – Wenn das Gateway einen unerwarteten internen Fehler feststellt, stellt es sich automatisch wieder her und gibt eine strukturierte Fehlermeldung zurück, anstatt Ihre Verbindung zu trennen. Sie müssen keine Verbindungsabbrüche behandeln, die durch Panik auf Gateway-Ebene verursacht werden.
* **Graceful Shutdown** – Während der Bereitstellung leiten der Gateway- und der Signaturdienst laufende Anfragen über ein 15-Sekunden-Fenster ab, anstatt sie sofort zu beenden. Wenn Sie zuvor gelegentlich Anfragenfehler während Wartungsfenstern erlebt haben, sollten diese nicht mehr auftreten.

Diese Schutzmaßnahmen funktionieren automatisch und erfordern keine Änderungen an Ihrer Integration.

## Reaktion auf Vorfälle

Wenn Truthlocks Probleme hat:

1. **Statusseite prüfen:** [status.truthlocks.com](https://status.truthlocks.com)
2. **Leistungsschalter aktivieren:** Fehlerbehandlung in Ihrer App
3. **Warteschlangenoperationen:** Attestierungsprägung später wiederholen
4. **Support kontaktieren:** Für Enterprise SLA-Eskalation

### Schutzschalter-Muster

```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 };
});
```

## Nächste Schritte

> [card] [Beobachtbarkeits-Dashboard](https://docs.truthlocks.com/guides/observability.md)
>
> Überwachen Sie den Dienstzustand, die Latenz und die Nutzung über die Konsole.

> [card] [Fehlerreferenz](https://docs.truthlocks.com/ops/errors.md)
>
> Vollständige Liste der Fehlercodes und deren Behandlung.

> [card] [Ratenbegrenzungen](https://docs.truthlocks.com/ops/limits.md)
>
> Ratenbegrenzung elegant handhaben.


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