aboutsummaryrefslogtreecommitdiffstats
path: root/docs/prometheus.md
diff options
context:
space:
mode:
authorPalash Oswal <oswalpalash@gmail.com>2021-05-26 15:49:00 +0530
committerGitHub <noreply@github.com>2021-05-26 12:19:00 +0200
commit1f4e6ed95868861aae449b3630e6cfe5a2b96c93 (patch)
treeded977da86c36bdb3d07a03fa6341ed067645eef /docs/prometheus.md
parent750ce1649cc6e2b51bc65b574f6a71399980af4c (diff)
syz-manager: add prometheus metrics
* syz-manager: add prometheus metrics Add prometheus metrics client to syz-manager. Expose metrics on a new port defined in mgrconfig. Allows for prometheus to scrape metrics from syz-manager. * syz-manager: expose metrics endpoint in http server .gitignore : remove local .img path * mgrconfig: remove unnecessary config option * syz-manager: update stats to use gaugefunc added docs for prometheus exported metrics added more gaugefunc metrics Signed-off-by: Palash Oswal <oswalpalash@gmail.com> * syz-manager: minor changes for CI tests added periods to comments and renamed go variables Signed-off-by: Palash Oswal <oswalpalash@gmail.com> * syz-manager: re-position prometheus counter declaration docs updated with PR comments Signed-off-by: Palash Oswal <oswalpalash@gmail.com>
Diffstat (limited to 'docs/prometheus.md')
-rw-r--r--docs/prometheus.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/prometheus.md b/docs/prometheus.md
new file mode 100644
index 000000000..d92621972
--- /dev/null
+++ b/docs/prometheus.md
@@ -0,0 +1,16 @@
+# Prometheus metrics
+
+syz-manager metrics are exposed at the URI `/metrics` on the http endpoint.
+Currently exported prometheus metrics from the manager are `syz_exec_total`, `syz_corpus_cover` and `syz_crash_total`.
+
+These metrics can be ingested using following prometheus client configuration:
+```
+scrape_configs:
+- job_name: syzkaller
+ scrape_interval: 10s
+ static_configs:
+ - targets:
+ - localhost:56741
+```
+
+Values are reset to zero at syz-manager restart and only reflect for current execution of syz-manager.