Metrics: Difference between revisions

From Svacer Wiki
(create prometheus metrics page)
 
(add setup part and prometheus config example)
Line 1: Line 1:
Метрики следующие:
=== Включение метрик ===
Для включения метрик запустите сервер Svacer с переменной окружения '''SVACER_TRACE_OPTIONS=prom_metrics_on'''
 
SVACER_TRACE_OPTIONS=prom_metrics_on svacer-server run
 
После этого метрики будут доступны по URL вашего сервера на '''/api/metrics'''
<pre>http://localhost:8080/api/metrics</pre>
 
=== Добавление в Prometheus ===
Для сбора метрик Прометеусом добавьте в его конфиг-файл '''/etc/prometheus/prometheus.yml''' подобную запись, поменяв название, хост и порт на те что у вас
 
- job_name: svacer-metrics-example
  metrics_path: /api/metrics
  static_configs:
    - targets: ['svacer.ispras.ru:8080']
 
=== Список метрик ===


{| class="wikitable"
{| class="wikitable"

Revision as of 18:39, 26 June 2024

Включение метрик

Для включения метрик запустите сервер Svacer с переменной окружения SVACER_TRACE_OPTIONS=prom_metrics_on

SVACER_TRACE_OPTIONS=prom_metrics_on svacer-server run

После этого метрики будут доступны по URL вашего сервера на /api/metrics

http://localhost:8080/api/metrics

Добавление в Prometheus

Для сбора метрик Прометеусом добавьте в его конфиг-файл /etc/prometheus/prometheus.yml подобную запись, поменяв название, хост и порт на те что у вас

- job_name: svacer-metrics-example
  metrics_path: /api/metrics
  static_configs:
    - targets: ['svacer.ispras.ru:8080']

Список метрик

Название Описание
import_results_since_start The total number of imported results since last server start
import_snapshots_since_start The total number of imported snapshots since last server start
review_changes_since_start The total number of review modifications since start
comment_changes_since_start The total number of comment additions/deletions/modifications since start
wsocket_sessions_counter The total number of active web socket connections
rest_import_svace_dirs The total number of import svace dir requests via REST endpoint
rest_import_svace_dirs_success The total number of success import svace dir requests via REST endpoint
rest_import_svace_dirs_failed The total number of failed import svace dir requests via REST endpoint
active_imports Number of active imports of svace/sarif results
active_snapshot_imports Number of active snapshot imports
active_snapshot_exports Number of active snapshot exports