github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/Quick-Start.md

36 lines
2.2 KiB
Markdown
Raw Normal View History

docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
---
updates per-tenant stats docs changes docs order changes per-tenant-stats pic
2021-04-14 09:14:51 +00:00
sort: 11
docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
---
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
# Quick Start
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
1. If you run Ubuntu please run the `snap install victoriametrics` command to install and start VictoriaMetrics. Then read [these docs](https://snapcraft.io/victoriametrics).
Otherwise you can download the latest VictoriaMetrics release from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases),
or [Docker hub](https://hub.docker.com/r/victoriametrics/victoria-metrics/)
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 17:16:17 +00:00
or [build it from sources](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-build-from-sources).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs: make `snap install victoriametrics` more prominent in docs
2020-11-18 17:44:40 +00:00
2. This step isn't needed if you run VictoriaMetrics via `snap install victoriametrics` as described above.
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
Otherwise, please run the binary or Docker image with your desired command-line flags. You can look at `-help` to see descriptions of all available flags
and their default values. The default flag values should fit the majority of cases. The minimum required flags that must be configured are:
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
* `-storageDataPath` - the path to directory where VictoriaMetrics stores your data.
app/vmstorage: support for `-retentionPeriod` smaller than one month Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/173 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/17
2020-10-20 11:29:26 +00:00
* `-retentionPeriod` - data retention.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
For example:
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
`./victoria-metrics-prod -storageDataPath=/var/lib/victoria-metrics-data -retentionPeriod=3`
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
Check [these instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) to configure VictoriaMetrics as an OS service.
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 17:16:17 +00:00
We recommended setting up [VictoriaMetrics monitoring](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#monitoring).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 17:16:17 +00:00
3. Configure either [vmagent](https://docs.victoriametrics.com/vmagent.html) or Prometheus to write data to VictoriaMetrics.
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
We recommended using `vmagent` instead of Prometheus because it is more resource efficient. If you still prefer Prometheus
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 17:16:17 +00:00
see [these instructions](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#prometheus-setup)
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
for details on how it may be properly configured.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Native speaker edits. (#1088) I made an effort to not change anything substantive.
2021-02-25 13:57:09 +00:00
4. To configure Grafana to query VictoriaMetrics instead of Prometheus
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 17:16:17 +00:00
please see [these instructions](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#grafana-setup).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
There is also [cluster version](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster) and [SaaS playground](https://play.victoriametrics.com/signIn).
Reference in a new issue Copy permalink