Skip to main content
OpenClaw може надавати діагностичні метрики через офіційний Plugin diagnostics-prometheus. Він прослуховує довірену діагностику, а також внутрішньо позначені діагностичні події, якими керує диспетчер (сигнали черги, пам’яті та відновлення сеансів), і надає текстову кінцеву точку Prometheus за адресою:
Тип вмісту — text/plain; version=0.0.4; charset=utf-8, стандартний формат представлення Prometheus.
Маршрут використовує автентифікацію Gateway (область оператора, інтерфейс довіреного оператора). Не надавайте його як загальнодоступну неавтентифіковану кінцеву точку /metrics. Збирайте з нього метрики через той самий шлях автентифікації, який ви використовуєте для інших API оператора.
Відомості про трасування, журнали, надсилання через OTLP та семантичні атрибути OpenTelemetry GenAI див. у розділі Експорт OpenTelemetry.

Швидкий початок

1

Установіть Plugin

2

Увімкніть Plugin

3

Перезапустіть Gateway

HTTP-маршрут реєструється під час запуску Plugin, тому після ввімкнення перезавантажте Gateway.
4

Збирайте метрики із захищеного маршруту

Надсилайте ті самі дані автентифікації Gateway, які використовують ваші клієнти оператора:
5

Підключіть Prometheus

Значенням diagnostics.enabled за замовчуванням є true; установлюйте його в false лише в середовищах із жорсткими обмеженнями. Якщо воно має значення false, Plugin усе одно реєструє HTTP-маршрут, але діагностичні події не надходять до експортера, тому відповідь порожня.

Експортовані метрики

Політика міток

Мітки Prometheus залишаються обмеженими та мають низьку кардинальність. Експортер не виводить необроблені діагностичні ідентифікатори, як-от runId, sessionKey, sessionId, callId, toolCallId, ідентифікатори повідомлень, чатів або запитів до постачальника.Значення міток редагуються та мають відповідати політиці OpenClaw щодо символів із низькою кардинальністю. Значення, які не відповідають політиці, замінюються на unknown, other або none залежно від метрики. Мітки, схожі на ключі сеансів агентів з областю видимості, також замінюються на unknown.
Експортер обмежує кількість часових рядів, що зберігаються в пам’яті, до 2048 для лічильників, індикаторів і гістограм разом. Нові ряди понад це обмеження відкидаються, а openclaw_prometheus_series_dropped_total щоразу збільшується на одиницю.Відстежуйте цей лічильник як однозначний сигнал того, що атрибут вище за потоком пропускає значення з високою кардинальністю. Експортер ніколи не підвищує обмеження автоматично; якщо значення лічильника зростає, виправте джерело, а не вимикайте обмеження.
  • текст запиту, текст відповіді, вхідні дані інструментів, вихідні дані інструментів, системні запити
  • транскрипти Talk, аудіодані, ідентифікатори викликів, ідентифікатори кімнат, токени передавання, ідентифікатори ходів і необроблені ідентифікатори сеансів
  • необроблені ідентифікатори запитів постачальника (лише обмежені хеші, де це застосовно, у span — ніколи в метриках)
  • ключі та ідентифікатори сеансів
  • імена хостів, шляхи до файлів, значення секретів

Рецепти PromQL

Для інформаційних панелей із кількома постачальниками віддавайте перевагу gen_ai_client_token_usage: ця метрика відповідає семантичним угодам OpenTelemetry GenAI та узгоджується з метриками служб GenAI, що не належать до OpenClaw.

Вибір між експортом Prometheus і OpenTelemetry

OpenClaw підтримує обидва інтерфейси незалежно. Можна використовувати будь-який із них, обидва або жодного.
  • Модель отримання: Prometheus опитує /api/diagnostics/prometheus.
  • Зовнішній збирач не потрібен.
  • Автентифікація виконується через звичайний механізм автентифікації Gateway.
  • Інтерфейс містить лише метрики (без трасувань і журналів).
  • Найкраще підходить для стеків, уже стандартизованих на Prometheus + Grafana.

Усунення несправностей

  • Переконайтеся, що для diagnostics.enabled у конфігурації не встановлено значення false (типове значення — true).
  • Переконайтеся, що Plugin увімкнено та завантажено, за допомогою openclaw plugins list --enabled.
  • Створіть певний трафік; лічильники та гістограми виводять рядки лише після принаймні однієї події.
Кінцева точка потребує області дії оператора Gateway (auth: "gateway" із gatewayRuntimeScopeSurface: "trusted-operator"). Використовуйте той самий токен або пароль, який Prometheus використовує для будь-якого іншого маршруту оператора Gateway. Загальнодоступного режиму без автентифікації немає.
Новий атрибут перевищує обмеження в 2048 рядів. Перевірте останні метрики на наявність мітки з неочікувано високою кардинальністю та виправте її в джерелі. Експортер навмисно відкидає нові ряди замість непомітного переписування міток.
Plugin зберігає стан лише в пам’яті. Після перезапуску Gateway лічильники скидаються до нуля, а індикатори відновлюються з наступного переданого значення. Використовуйте функції PromQL rate() та increase(), щоб коректно обробляти скидання.

Пов’язані матеріали