Przejdź do głównej treści
OpenClaw może udostępniać metryki diagnostyczne przez dołączony plugin diagnostics-prometheus. Nasłuchuje on zaufanej wewnętrznej diagnostyki i renderuje punkt końcowy tekstowy Prometheus pod adresem: 
GET /api/diagnostics/prometheus
Typ zawartości to text/plain; version=0.0.4; charset=utf-8, czyli standardowy format ekspozycji Prometheus.
Ta trasa używa auth Gateway (zakres operatora). Nie wystawiaj jej jako publicznego nieuwierzytelnionego punktu końcowego /metrics. Odczytuj ją przez tę samą ścieżkę auth, której używasz dla innych operatorowych API.
Informacje o śladach, logach, push OTLP i semantycznych atrybutach OpenTelemetry GenAI znajdziesz w Eksport OpenTelemetry.

​
Szybki start

1

Włącz plugin

{
  plugins: {
    allow: ["diagnostics-prometheus"],
    entries: {
      "diagnostics-prometheus": { enabled: true },
    },
  },
  diagnostics: {
    enabled: true,
  },
}
2

Uruchom ponownie Gateway

Trasa HTTP jest rejestrowana przy starcie pluginu, więc po włączeniu wykonaj przeładowanie.
3

Odczytaj chronioną trasę

Wyślij to samo auth Gateway, którego używają twoi klienci operatora:
curl -H "Authorization: Bearer $OPENCLAW_GATEWAY_TOKEN" \
  http://127.0.0.1:18789/api/diagnostics/prometheus
4

Podłącz Prometheus

# prometheus.yml
scrape_configs:
  - job_name: openclaw
    scrape_interval: 30s
    metrics_path: /api/diagnostics/prometheus
    authorization:
      credentials_file: /etc/prometheus/openclaw-gateway-token
    static_configs:
      - targets: ["openclaw-gateway:18789"]
Wymagane jest diagnostics.enabled: true. Bez tego plugin nadal rejestruje trasę HTTP, ale żadne zdarzenia diagnostyczne nie trafiają do eksportera, więc odpowiedź jest pusta.

​
Eksportowane metryki

MetrykaTypEtykiety
openclaw_run_completed_totalcounterchannel, model, outcome, provider, trigger
openclaw_run_duration_secondshistogramchannel, model, outcome, provider, trigger
openclaw_model_call_totalcounterapi, error_category, model, outcome, provider, transport
openclaw_model_call_duration_secondshistogramapi, error_category, model, outcome, provider, transport
openclaw_model_tokens_totalcounteragent, channel, model, provider, token_type
openclaw_gen_ai_client_token_usagehistogrammodel, provider, token_type
openclaw_model_cost_usd_totalcounteragent, channel, model, provider
openclaw_tool_execution_totalcountererror_category, outcome, params_kind, tool
openclaw_tool_execution_duration_secondshistogramerror_category, outcome, params_kind, tool
openclaw_harness_run_totalcounterchannel, error_category, harness, model, outcome, phase, plugin, provider
openclaw_harness_run_duration_secondshistogramchannel, error_category, harness, model, outcome, phase, plugin, provider
openclaw_message_processed_totalcounterchannel, outcome, reason
openclaw_message_processed_duration_secondshistogramchannel, outcome, reason
openclaw_message_delivery_totalcounterchannel, delivery_kind, error_category, outcome
openclaw_message_delivery_duration_secondshistogramchannel, delivery_kind, error_category, outcome
openclaw_queue_lane_sizegaugelane
openclaw_queue_lane_wait_secondshistogramlane
openclaw_session_state_totalcounterreason, state
openclaw_session_queue_depthgaugestate
openclaw_memory_bytesgaugekind
openclaw_memory_rss_byteshistogramnone
openclaw_memory_pressure_totalcounterlevel, reason
openclaw_telemetry_exporter_totalcounterexporter, reason, signal, status
openclaw_prometheus_series_dropped_totalcounternone

​
Polityka etykiet

Etykiety Prometheus pozostają ograniczone i mają niską kardynalność. Eksporter nie emituje surowych identyfikatorów diagnostycznych, takich jak runId, sessionKey, sessionId, callId, toolCallId, identyfikatory wiadomości, identyfikatory czatów ani identyfikatory żądań providera.Wartości etykiet są redagowane i muszą być zgodne z polityką znaków niskiej kardynalności OpenClaw. Wartości, które nie spełniają tej polityki, są zastępowane przez unknown, other lub none, zależnie od metryki.
Eksporter ogranicza liczbę utrzymywanych serii czasowych w pamięci do 2048 serii łącznie dla counterów, gauge’y i histogramów. Nowe serie ponad ten limit są odrzucane, a openclaw_prometheus_series_dropped_total zwiększa się o jeden przy każdym takim przypadku.Traktuj ten counter jako twardy sygnał, że jakiś atrybut wyżej w stosie przecieka wartości o wysokiej kardynalności. Eksporter nigdy nie podnosi limitu automatycznie; jeśli wartość rośnie, napraw źródło zamiast wyłączać limit.
  • tekst promptu, tekst odpowiedzi, wejścia narzędzi, wyjścia narzędzi, prompty systemowe
  • surowe identyfikatory żądań providera (tylko ograniczone hashe, tam gdzie dotyczy, na spanach — nigdy w metrykach)
  • klucze sesji i identyfikatory sesji
  • nazwy hostów, ścieżki plików, wartości sekretów

​
Receptury PromQL

# Tokens per minute, split by provider
sum by (provider) (rate(openclaw_model_tokens_total[1m]))

# Spend (USD) over the last hour, by model
sum by (model) (increase(openclaw_model_cost_usd_total[1h]))

# 95th percentile model run duration
histogram_quantile(
  0.95,
  sum by (le, provider, model)
    (rate(openclaw_run_duration_seconds_bucket[5m]))
)

# Queue wait time SLO (95p under 2s)
histogram_quantile(
  0.95,
  sum by (le, lane) (rate(openclaw_queue_lane_wait_seconds_bucket[5m]))
) < 2

# Dropped Prometheus series (cardinality alarm)
increase(openclaw_prometheus_series_dropped_total[15m]) > 0
Dla dashboardów między providerami preferuj gen_ai_client_token_usage: jest zgodne z konwencjami semantycznymi OpenTelemetry GenAI i spójne z metrykami z usług GenAI spoza OpenClaw.

​
Wybór między Prometheus a eksportem OpenTelemetry

OpenClaw obsługuje obie powierzchnie niezależnie. Możesz używać jednej, obu albo żadnej.
  • Model pull: Prometheus odczytuje /api/diagnostics/prometheus.
  • Nie wymaga zewnętrznego collectora.
  • Uwierzytelnianie przez zwykłe auth Gateway.
  • Powierzchnia obejmuje tylko metryki (bez śladów i logów).
  • Najlepsze dla stosów już opartych na Prometheus + Grafana.

​
Rozwiązywanie problemów

  • Sprawdź diagnostics.enabled: true w konfiguracji.
  • Potwierdź, że plugin jest włączony i załadowany, używając openclaw plugins list --enabled.
  • Wygeneruj trochę ruchu; countery i histogramy emitują linie dopiero po co najmniej jednym zdarzeniu.
Endpoint wymaga zakresu operatora Gateway (auth: "gateway" z gatewayRuntimeScopeSurface: "trusted-operator"). Użyj tego samego tokenu lub hasła, którego Prometheus używa do każdej innej trasy operatora Gateway. Nie ma publicznego trybu nieuwierzytelnionego.
Nowy atrybut przekracza limit 2048 serii. Sprawdź ostatnie metryki pod kątem etykiety o nieoczekiwanie wysokiej kardynalności i napraw źródło. Eksporter celowo odrzuca nowe serie zamiast po cichu przepisywać etykiety.
Plugin przechowuje stan wyłącznie w pamięci. Po restarcie Gateway countery resetują się do zera, a gauge’e startują od następnej zgłoszonej wartości. Używaj w PromQL rate() i increase(), aby poprawnie obsługiwać resety.

​
Powiązane