OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Gateway

Prometheus मेट्रिक्स

OpenClaw आधिकारिक diagnostics-prometheus Plugin के माध्यम से निदान मेट्रिक्स उपलब्ध करा सकता है। यह विश्वसनीय निदान के साथ-साथ आंतरिक रूप से टैग किए गए, डिस्पैचर-स्वामित्व वाले निदान इवेंट (क्यू, मेमोरी और सत्र-पुनर्प्राप्ति संकेत) सुनता है और यहाँ Prometheus टेक्स्ट एंडपॉइंट प्रस्तुत करता है:

text
GET /api/diagnostics/prometheus

कंटेंट टाइप text/plain; version=0.0.4; charset=utf-8, मानक Prometheus एक्सपोज़िशन फ़ॉर्मेट है।

ट्रेस, लॉग, OTLP पुश और OpenTelemetry GenAI सिमैंटिक एट्रिब्यूट के लिए, OpenTelemetry एक्सपोर्ट देखें।

त्वरित शुरुआत

  • Plugin इंस्टॉल करें

    bash
    openclaw plugins install clawhub:@openclaw/diagnostics-prometheus

  • Plugin सक्षम करें

    कॉन्फ़िगरेशन

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

    CLI

    bash
    openclaw plugins enable diagnostics-prometheus

  • Gateway पुनः आरंभ करें

    HTTP रूट Plugin के आरंभ होने पर पंजीकृत होता है, इसलिए इसे सक्षम करने के बाद पुनः लोड करें।

  • संरक्षित रूट स्क्रैप करें

    वही Gateway प्रमाणीकरण भेजें जिसका उपयोग आपके ऑपरेटर क्लाइंट करते हैं:

    bash
    curl -H "Authorization: Bearer $OPENCLAW_GATEWAY_TOKEN" \  http://127.0.0.1:18789/api/diagnostics/prometheus

  • Prometheus कनेक्ट करें

    yaml
    # prometheus.ymlscrape_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"]

    • एक्सपोर्ट किए गए मेट्रिक्स

    मेट्रिक प्रकार लेबल
    openclaw_run_completed_total काउंटर channel, model, outcome, provider, trigger
    openclaw_run_duration_seconds हिस्टोग्राम channel, model, outcome, provider, trigger
    openclaw_model_call_total काउंटर api, error_category, model, observation_unit, outcome, provider, transport
    openclaw_model_call_duration_seconds हिस्टोग्राम api, error_category, model, observation_unit, outcome, provider, transport
    openclaw_model_failover_total काउंटर from_model, from_provider, lane, reason, suspended, to_model, to_provider
    openclaw_model_tokens_total काउंटर agent, channel, model, provider, token_type
    openclaw_gen_ai_client_token_usage हिस्टोग्राम model, provider, token_type
    openclaw_model_cost_usd_total काउंटर agent, channel, model, provider
    openclaw_model_usage_duration_seconds हिस्टोग्राम agent, channel, model, provider
    openclaw_skill_used_total काउंटर activation, agent, skill, source
    openclaw_tool_execution_total काउंटर error_category, outcome, params_kind, tool, tool_owner, tool_source
    openclaw_tool_execution_duration_seconds हिस्टोग्राम error_category, outcome, params_kind, tool, tool_owner, tool_source
    openclaw_tool_execution_blocked_total काउंटर denied_reason, params_kind, tool, tool_owner, tool_source
    openclaw_harness_run_total काउंटर channel, error_category, harness, model, outcome, phase, plugin, provider
    openclaw_harness_run_duration_seconds हिस्टोग्राम channel, error_category, harness, model, outcome, phase, plugin, provider
    openclaw_webhook_received_total काउंटर channel, webhook
    openclaw_webhook_error_total काउंटर channel, webhook
    openclaw_webhook_duration_seconds हिस्टोग्राम channel, webhook
    openclaw_message_received_total काउंटर channel, source
    openclaw_message_dispatch_started_total काउंटर channel, source
    openclaw_message_dispatch_completed_total काउंटर channel, outcome, reason, source
    openclaw_message_dispatch_duration_seconds हिस्टोग्राम channel, outcome, reason, source
    openclaw_message_processed_total काउंटर channel, outcome, reason
    openclaw_message_processed_duration_seconds हिस्टोग्राम channel, outcome, reason
    openclaw_message_delivery_started_total काउंटर channel, delivery_kind
    openclaw_message_delivery_total काउंटर channel, delivery_kind, error_category, outcome
    openclaw_message_delivery_duration_seconds हिस्टोग्राम channel, delivery_kind, error_category, outcome
    openclaw_talk_event_total काउंटर brain, event_type, mode, provider, transport
    openclaw_talk_event_duration_seconds हिस्टोग्राम brain, event_type, mode, provider, transport
    openclaw_talk_audio_bytes हिस्टोग्राम brain, event_type, mode, provider, transport
    openclaw_queue_lane_size गेज lane
    openclaw_queue_lane_wait_seconds हिस्टोग्राम lane
    openclaw_session_state_total काउंटर reason, state
    openclaw_session_queue_depth गेज state
    openclaw_session_turn_created_total काउंटर agent, channel, trigger
    openclaw_session_stuck_total काउंटर reason, state
    openclaw_session_stuck_age_seconds हिस्टोग्राम reason, state
    openclaw_session_recovery_total काउंटर action, active_work_kind, state, status
    openclaw_session_recovery_age_seconds हिस्टोग्राम action, active_work_kind, state, status
    openclaw_liveness_warning_total काउंटर reason
    openclaw_liveness_sessions गेज state
    openclaw_liveness_event_loop_delay_p99_seconds हिस्टोग्राम reason
    openclaw_liveness_event_loop_delay_max_seconds हिस्टोग्राम reason
    openclaw_liveness_event_loop_utilization_ratio हिस्टोग्राम reason
    openclaw_liveness_cpu_core_ratio हिस्टोग्राम reason
    openclaw_payload_large_total काउंटर action, channel, plugin, reason, surface
    openclaw_payload_large_bytes हिस्टोग्राम action, channel, plugin, reason, surface
    openclaw_memory_bytes गेज kind
    openclaw_memory_rss_bytes हिस्टोग्राम कोई नहीं
    openclaw_memory_pressure_total काउंटर level, reason
    openclaw_telemetry_exporter_total काउंटर exporter, reason, signal, status
    openclaw_prometheus_series_dropped_total काउंटर कोई नहीं
    openclaw_diagnostic_async_queue_dropped_total काउंटर drop_class
    openclaw_diagnostic_async_queue_length गेज कोई नहीं

    मॉडल-कॉल मेट्रिक्स के लिए, observation_unit="request" एक अवलोकनीय प्रदाता अनुरोध मापता है। observation_unit="turn" एक सिंथेटिक Claude Code या Codex CLI एजेंट टर्न मापता है, जिसमें कई छिपे हुए प्रदाता अनुरोध हो सकते हैं। लेटेंसी की तुलना करते समय इन शृंखलाओं को अलग रखें।

    लेबल नीति

    सीमित, कम-कार्डिनैलिटी वाले लेबल

    Prometheus लेबल सीमित और कम-कार्डिनैलिटी वाले रहते हैं। एक्सपोर्टर runId, sessionKey, sessionId, callId, toolCallId, संदेश ID, चैट ID या प्रदाता अनुरोध ID जैसे अपरिष्कृत डायग्नोस्टिक पहचानकर्ता उत्सर्जित नहीं करता।

    लेबल मानों से संवेदनशील जानकारी हटा दी जाती है और उनका OpenClaw की कम-कार्डिनैलिटी वर्ण नीति से मेल खाना आवश्यक है। नीति में विफल मानों को मेट्रिक के आधार पर unknown, other या none से बदल दिया जाता है। स्कोप किए गए एजेंट सत्र कुंजियों जैसे दिखने वाले लेबल भी unknown से बदल दिए जाते हैं।

    शृंखला सीमा और ओवरफ़्लो लेखांकन

    एक्सपोर्टर काउंटर, गेज और हिस्टोग्राम को मिलाकर मेमोरी में रखी गई समय शृंखलाओं की सीमा 2048 शृंखलाओं पर निर्धारित करता है। इस सीमा से आगे की नई शृंखलाएँ छोड़ दी जाती हैं और हर बार openclaw_prometheus_series_dropped_total में एक की वृद्धि होती है।

    इस काउंटर को इस स्पष्ट संकेत के रूप में देखें कि अपस्ट्रीम का कोई एट्रिब्यूट उच्च-कार्डिनैलिटी वाले मान लीक कर रहा है। एक्सपोर्टर कभी भी सीमा को अपने-आप नहीं बढ़ाता; यदि यह काउंटर बढ़ता है, तो सीमा अक्षम करने के बजाय स्रोत को ठीक करें।

    Prometheus आउटपुट में क्या कभी दिखाई नहीं देता
    • प्रॉम्प्ट टेक्स्ट, प्रतिक्रिया टेक्स्ट, टूल इनपुट, टूल आउटपुट, सिस्टम प्रॉम्प्ट
    • Talk ट्रांसक्रिप्ट, ऑडियो पेलोड, कॉल ID, रूम ID, हैंडऑफ़ टोकन, टर्न ID और अपरिष्कृत सत्र ID
    • अपरिष्कृत प्रदाता अनुरोध ID (केवल सीमित हैश, जहाँ लागू हों, स्पैन पर — मेट्रिक्स पर कभी नहीं)
    • सत्र कुंजियाँ और सत्र ID
    • होस्टनेम, फ़ाइल पथ, गुप्त मान

    PromQL विधियाँ

    promql
    # प्रति मिनट टोकन, प्रदाता के अनुसार विभाजितsum by (provider) (rate(openclaw_model_tokens_total[1m])) # पिछले एक घंटे का खर्च (USD), मॉडल के अनुसारsum by (model) (increase(openclaw_model_cost_usd_total[1h])) # मॉडल रन अवधि का 95वाँ पर्सेंटाइलhistogram_quantile(  0.95,  sum by (le, provider, model)    (rate(openclaw_run_duration_seconds_bucket[5m]))) # क्यू प्रतीक्षा समय SLO (95p, 2s से कम)histogram_quantile(  0.95,  sum by (le, lane) (rate(openclaw_queue_lane_wait_seconds_bucket[5m]))) < 2 # Skill उपयोग, सीमित स्रोत के अनुसार विभाजितsum by (skill, source) (increase(openclaw_skill_used_total[24h])) # छोड़ी गई Prometheus शृंखलाएँ (कार्डिनैलिटी चेतावनी)increase(openclaw_prometheus_series_dropped_total[15m]) > 0

    Prometheus और OpenTelemetry एक्सपोर्ट के बीच चयन

    OpenClaw दोनों सतहों का स्वतंत्र रूप से समर्थन करता है। आप किसी एक को, दोनों को या किसी को भी नहीं चला सकते हैं।

    diagnostics-prometheus

    • पुल मॉडल: Prometheus /api/diagnostics/prometheus को स्क्रैप करता है।
    • किसी बाहरी कलेक्टर की आवश्यकता नहीं है।
    • सामान्य Gateway प्रमाणीकरण के माध्यम से प्रमाणित।
    • इस सतह पर केवल मेट्रिक्स उपलब्ध हैं (ट्रेस या लॉग नहीं)।
    • उन स्टैक के लिए सर्वोत्तम, जो पहले से Prometheus + Grafana पर मानकीकृत हैं।

    diagnostics-otel

    • पुश मॉडल: OpenClaw किसी कलेक्टर या OTLP-संगत बैकएंड को OTLP/HTTP भेजता है।
    • इस सतह में मेट्रिक्स, ट्रेस और लॉग शामिल हैं।
    • जब दोनों की आवश्यकता हो, तो OpenTelemetry Collector (prometheus या prometheusremotewrite एक्सपोर्टर) के माध्यम से Prometheus से जोड़ता है।
    • पूरी सूची के लिए OpenTelemetry एक्सपोर्ट देखें।

    समस्या निवारण

    खाली प्रतिक्रिया बॉडी
    • जाँचें कि कॉन्फ़िगरेशन में diagnostics.enabled, false पर सेट न हो (इसका डिफ़ॉल्ट true है)।
    • पुष्टि करें कि Plugin सक्षम है और openclaw plugins list --enabled के साथ लोड हुआ है।
    • कुछ ट्रैफ़िक उत्पन्न करें; काउंटर और हिस्टोग्राम कम-से-कम एक घटना के बाद ही पंक्तियाँ उत्सर्जित करते हैं।
    401 / अनधिकृत

    एंडपॉइंट को Gateway ऑपरेटर स्कोप (auth: "gateway" के साथ gatewayRuntimeScopeSurface: "trusted-operator") की आवश्यकता होती है। वही टोकन या पासवर्ड उपयोग करें जिसका उपयोग Prometheus किसी अन्य Gateway ऑपरेटर रूट के लिए करता है। कोई सार्वजनिक अप्रमाणित मोड नहीं है।

    `openclaw_prometheus_series_dropped_total` बढ़ रहा है

    कोई नया एट्रिब्यूट 2048-शृंखला सीमा पार कर रहा है। हाल के मेट्रिक्स में अप्रत्याशित रूप से उच्च-कार्डिनैलिटी वाले लेबल की जाँच करें और उसे स्रोत पर ठीक करें। एक्सपोर्टर लेबल को चुपचाप फिर से लिखने के बजाय जानबूझकर नई शृंखलाएँ छोड़ता है।

    पुनः आरंभ के बाद Prometheus पुरानी शृंखलाएँ दिखाता है

    Plugin केवल मेमोरी में स्थिति बनाए रखता है। Gateway पुनः आरंभ होने के बाद काउंटर शून्य पर रीसेट हो जाते हैं और गेज अपने अगले रिपोर्ट किए गए मान से पुनः आरंभ होते हैं। रीसेट को सही ढंग से संभालने के लिए PromQL rate() और increase() का उपयोग करें।

    संबंधित

    Was this useful?
    On this page

    On this page