VictoriaMetrics/README.md

71 lines
4.9 KiB
Markdown
Raw Normal View History

2018-11-29 20:24:19 +00:00
<img text-align="center" alt="Victoria Metrics" src="logo.png">
2018-11-29 19:47:17 +00:00
2018-11-02 21:29:00 +00:00
## VictoriaMetrics - the best long-term remote storage for Prometheus
2018-10-06 19:48:12 +00:00
2018-12-06 21:23:20 +00:00
[![Latest Release](https://img.shields.io/github/release/VictoriaMetrics/VictoriaMetrics.svg?style=flat-square)](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
2018-10-12 22:33:14 +00:00
### VictoriaMetrics features
- Native [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) support. Additionally, VictoriaMetrics extends PromQL with useful features. See [Extended PromQL](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/ExtendedPromQL) for more details.
2018-10-12 22:42:30 +00:00
- Simple configuration. Just copy-n-paste remote storage URL to Prometheus config and that's it! See [Quick Start](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/Quick-Start) for more info.
- Reduced operational overhead. Offload operational burden - configuration, capacity planning, scalability, backups, retention, durability - from Prometheus local storage to VictoriaMetrics.
2019-01-31 01:19:38 +00:00
- Insertion rate scales to [millions of metric values per second](https://medium.com/@valyala/insert-benchmarks-with-inch-influxdb-vs-victoriametrics-e31a41ae2893).
- Storage scales to [millions of metrics](https://medium.com/@valyala/high-cardinality-tsdb-benchmarks-victoriametrics-vs-timescaledb-vs-influxdb-13e6ee64dd6b) with trillions of metric values.
2018-10-12 22:33:14 +00:00
- Wide range of retention periods - from 1 month to 5 years. Users may create different projects (aka `storage namespaces`) with different retention periods.
2019-01-31 01:19:38 +00:00
- [Fast query engine](https://medium.com/@valyala/when-size-matters-benchmarking-victoriametrics-vs-timescale-and-influxdb-6035811952d4). It excels on heavy queries over thousands of metrics with millions of metric values.
2018-10-12 22:33:14 +00:00
- The same remote storage URL may be used by multiple Prometheus instances collecting distinct metric sets, so all these metrics may be used in a single query (aka `global querying view`). This works ideally for multiple Prometheus instances located in different subnetworks / datacenters.
- Accepts data in [InfluxDB line protocol](https://docs.influxdata.com/influxdb/v1.7/write_protocols/line_protocol_reference/), so [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) and other influx-compatible agents may send data to VictoriaMetrics.
- [Single-server VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) accepts data in [Graphite plaintext protocol](https://graphite.readthedocs.io/en/latest/feeding-carbon.html#the-plaintext-protocol) if `-graphiteListenAddr` is set and in [OpenTSDB format](http://opentsdb.net/docs/build/html/api_telnet/put.html) if `-opentsdbListenAddr` is set.
2019-01-31 01:18:09 +00:00
- VictoriaMetrics supports backfilling, i.e. data points from the past may be inserted into the DB.
- Time series data may be exported via `/api/v1/export?match=<metric_selector>`. Optional `start` and `end` timestamps may be added for exporting time series in the given time range.
- Time series may be deleted via `/api/v1/admin/tsdb/delete_series?match[]=<metric_selector>`.
- [Instant snapshots](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282) are supported.
2018-10-12 22:33:14 +00:00
### Useful links
2019-02-07 17:00:38 +00:00
* [Free single-node VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/Single-server-VictoriaMetrics)
2018-10-06 19:55:45 +00:00
* [Site](https://victoriametrics.com/)
* [`WITH` templates playground](https://play.victoriametrics.com/promql/expand-with-exprs)
* [Grafana playground](http://play-grafana.victoriametrics.com:3000/d/4ome8yJmz/node-exporter-on-victoriametrics-demo)
2018-10-06 19:48:12 +00:00
* [Docs](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki)
2018-10-10 14:30:52 +00:00
* [FAQ](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/FAQ)
2018-10-06 19:48:12 +00:00
* [Issues](https://github.com/VictoriaMetrics/VictoriaMetrics/issues)
2018-10-22 15:18:31 +00:00
* [Google group](https://groups.google.com/forum/#!forum/victoriametrics)
2018-11-01 17:47:20 +00:00
* [Creating the best remote storage for Prometheus](https://medium.com/devopslinks/victoriametrics-creating-the-best-remote-storage-for-prometheus-5d92d66787ac) - an article with technical details about VictoriaMetrics.
2019-05-20 12:45:14 +00:00
* [Official Grafana Dashboard](https://grafana.com/dashboards/10229)
2018-11-29 20:47:31 +00:00
### Victoria Metrics Logo
[Zip](VM_logo.zip) contains three folders with different image orientation (main color and inverted version).
Files included in each folder:
* 2 JPEG Preview files
* 2 PNG Preview files with transparent background
* 2 EPS Adobe Illustrator EPS10 files
#### Logo Usage Guidelines
##### Font used:
* Lato Black
* Lato Regular
##### Color Palette:
* HEX [#110f0f](https://www.color-hex.com/color/110f0f)
* HEX [#ffffff](https://www.color-hex.com/color/ffffff)
#### We kindly ask:
- Please don't use any other font instead of suggested.
- There should be sufficient clear space around the logo.
- Do not change spacing, alignment, or relative locations of the design elements.
- Do not change the proportions of any of the design elements or the design itself. You may resize as needed but must retain all proportions.