Metrics
Включение метрик
Для включения метрик запустите сервер Svacer с переменной окружения SVACER_TRACE_OPTIONS=prom_metrics_on
SVACER_TRACE_OPTIONS=prom_metrics_on svacer-server run
После этого метрики будут доступны по URL вашего сервера на /api/metrics
http://localhost:8080/api/metrics
Список метрик
| Название | Описание |
|---|---|
| svacer_active_imports | Number of active imports of svace/sarif results |
| svacer_active_snapshot_exports | Number of active snapshot exports |
| svacer_active_snapshot_imports | Number of active snapshot imports |
| svacer_comment_changes_since_start | The total number of comment additions/deletions/modifications since start |
| svacer_import_results_since_start | The total number of imported results since last server start |
| svacer_import_snapshots_since_start | The total number of imported snapshots since last server start |
| svacer_rest_import_svace_dirs | The total number of import svace dir requests via REST endpoint |
| svacer_rest_import_svace_dirs_failed | The total number of failed import svace dir requests via REST endpoint |
| svacer_rest_import_svace_dirs_success | The total number of success import svace dir requests via REST endpoint |
| svacer_review_changes_since_start | The total number of review modifications since start |
| svacer_wsocket_sessions_counter | The total number of active web socket connections |
Добавление в Prometheus
Для сбора метрик Прометеусом добавьте в его конфиг-файл /etc/prometheus/prometheus.yml подобную запись, поменяв название, хост и порт на те что у вас
- job_name: svacer-metrics-example
metrics_path: /api/metrics
static_configs:
- targets: ['svacer.ispras.ru:8080']
Grafana dashboard
Для визуализации метрик в Grafana импортируете dashboard из файла grafana-dashboard-svacer.json. В диалоге импорта выберите собирающий метрики Prometheus в качестве data source.