From 194bcb13eafb0fdd114262522c49f67e738413d8 Mon Sep 17 00:00:00 2001 From: vultj <113467936+vultj@users.noreply.github.com> Date: Thu, 11 Jul 2024 12:36:47 -0500 Subject: [PATCH] update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b9f93d90..8223d4cf 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ ## Overview `v-agent` is a daemon that gathers metrics and writes them to a compatible [remote_write](https://prometheus.io/docs/specs/remote_write_spec/) endpoint. +It acts like prometheus (scraping metrics), re-labeling metrics, then pushing them off to a remote_write compatible endpoint. Internally, we use mimir and write our metrics there but other implementations _should_ work. + ### Metrics All metrics that are specifically created with `v-agent` are prefixed with `v_`. Scraped metrics are not modified other than the addition of labels.