This commit is contained in:
Aliaksandr Valialkin 2020-01-27 18:35:39 +02:00
parent 3e304890a6
commit 2bb9b089d5

View file

@ -78,7 +78,6 @@ Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaM
- [Building docker images](#building-docker-images) - [Building docker images](#building-docker-images)
- [Start with docker-compose](#start-with-docker-compose) - [Start with docker-compose](#start-with-docker-compose)
- [Setting up service](#setting-up-service) - [Setting up service](#setting-up-service)
- [Third-party contributions](#third-party-contributions)
- [How to work with snapshots?](#how-to-work-with-snapshots) - [How to work with snapshots?](#how-to-work-with-snapshots)
- [How to delete time series?](#how-to-delete-time-series) - [How to delete time series?](#how-to-delete-time-series)
- [How to export time series?](#how-to-export-time-series) - [How to export time series?](#how-to-export-time-series)
@ -101,6 +100,7 @@ Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaM
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
- [Contacts](#contacts) - [Contacts](#contacts)
- [Community and contributions](#community-and-contributions) - [Community and contributions](#community-and-contributions)
- [Third-party contributions](#third-party-contributions)
- [Reporting bugs](#reporting-bugs) - [Reporting bugs](#reporting-bugs)
- [Victoria Metrics Logo](#victoria-metrics-logo) - [Victoria Metrics Logo](#victoria-metrics-logo)
- [Logo Usage Guidelines](#logo-usage-guidelines) - [Logo Usage Guidelines](#logo-usage-guidelines)
@ -477,12 +477,6 @@ More details may be found [here](https://github.com/VictoriaMetrics/VictoriaMetr
Read [these instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) on how to set up VictoriaMetrics as a service in your OS. Read [these instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) on how to set up VictoriaMetrics as a service in your OS.
### Third-party contributions
* [Unofficial yum repository](https://copr.fedorainfracloud.org/coprs/antonpatsev/VictoriaMetrics/) ([source code](https://github.com/patsevanton/victoriametrics-rpm))
* [Prometheus -> VictoriaMetrics exporter](https://github.com/ryotarai/prometheus-tsdb-dump)
### How to work with snapshots? ### How to work with snapshots?
VictoriaMetrics can create [instant snapshots](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282) VictoriaMetrics can create [instant snapshots](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282)
@ -740,8 +734,11 @@ mkfs.ext4 ... -O 64bit,huge_file,extent -T huge
### Monitoring ### Monitoring
VictoriaMetrics exports internal metrics in Prometheus format on the `/metrics` page. VictoriaMetrics exports internal metrics in Prometheus format at `/metrics` page.
Add this page to Prometheus' scrape config in order to collect VictoriaMetrics metrics. These metrics may be collected either via Prometheus by adding the corresponding scrape config to it.
Alternatively they can be self-scraped by setting `-selfScrapeInterval` command-line flag to duration greater than 0.
For example, `-scrapeInterval=10s` would enable self-scraping of `/metrics` page with 10 seconds interval.
There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176). There are officials Grafana dashboards for [single-node VictoriaMetrics](https://grafana.com/dashboards/10229) and [clustered VictoriaMetrics](https://grafana.com/grafana/dashboards/11176).
The most interesting metrics are: The most interesting metrics are:
@ -864,6 +861,13 @@ We are open to third-party pull requests provided they follow [KISS design princ
Adhering `KISS` principle simplifies the resulting code and architecture, so it can be reviewed, understood and verified by many people. Adhering `KISS` principle simplifies the resulting code and architecture, so it can be reviewed, understood and verified by many people.
### Third-party contributions
* [Unofficial yum repository](https://copr.fedorainfracloud.org/coprs/antonpatsev/VictoriaMetrics/) ([source code](https://github.com/patsevanton/victoriametrics-rpm))
* [Prometheus -> VictoriaMetrics exporter #1](https://github.com/ryotarai/prometheus-tsdb-dump)
* [Prometheus -> VictoriaMetrics exporter #2](https://github.com/AnchorFree/tsdb-remote-write)
## Reporting bugs ## Reporting bugs
Report bugs and propose new features [here](https://github.com/VictoriaMetrics/VictoriaMetrics/issues). Report bugs and propose new features [here](https://github.com/VictoriaMetrics/VictoriaMetrics/issues).