From 488d300d8b781b574deb4779db26bb28881fe456 Mon Sep 17 00:00:00 2001 From: Yurii Kravets <30324382+YuriKravetc@users.noreply.github.com> Date: Tue, 12 Apr 2022 14:22:53 +0300 Subject: [PATCH] Update Quick-Start (#2422) * Update Quick-Start * Update docs/Quick-Start.md Co-authored-by: Roman Khavronenko * Update docs/Quick-Start.md Co-authored-by: Roman Khavronenko * Update docs/Quick-Start.md Co-authored-by: Roman Khavronenko * Update docs/Quick-Start.md Co-authored-by: Roman Khavronenko * update Quick-Start.md added "Starting VM-Cluster via Docker" + Anchor fixes * Apply suggestions from code review Co-authored-by: Roman Khavronenko Co-authored-by: Aliaksandr Valialkin --- docs/Quick-Start.md | 64 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 60 insertions(+), 4 deletions(-) diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index 2af44a756d..16fb659534 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -2,7 +2,25 @@ sort: 13 --- -# Quick Start +# Quick start + +## Installation + +Single-server-VictoriaMetrics VictoriaMetrics is available as: + +* [Managed VictoriaMetrics at AWS](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc) +* [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) +* [Snap packages](https://snapcraft.io/victoriametrics) +* [Helm Charts](https://github.com/VictoriaMetrics/helm-charts#list-of-charts) +* [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +* [Source code](https://github.com/VictoriaMetrics/VictoriaMetrics). See [How to build from sources](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-build-from-sources) +* [VictoriaMetrics on Linode](https://www.linode.com/marketplace/apps/victoriametrics/victoriametrics/) +* [VictoriaMetrics on DigitalOcean](https://marketplace.digitalocean.com/apps/victoriametrics-single) + +Just download VictoriaMetrics and follow [these instructions](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-start-victoriametrics). +Then read [Prometheus setup](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#prometheus-setup) and [Grafana setup](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#grafana-setup) docs. + +### Starting VM-Signle via Docker: The following commands download the latest available [Docker image of VictoriaMetrics](https://hub.docker.com/r/victoriametrics/victoria-metrics) and start it at port 8428, while storing the ingested data at `victoria-metrics-data` subdirectory under the current directory: @@ -13,9 +31,47 @@ docker run -it --rm -v `pwd`/victoria-metrics-data:/victoria-metrics-data -p 842 Open `http://localhost:8428` in web browser and read [these docs](https://docs.victoriametrics.com/#operation). -VictoriaMetrics is also available in binaries (see [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases)) and in source code (see [how to build VictoriaMetrics from sources](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-build-from-sources)). - There are also the following versions of VictoriaMetrics available: * [VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) - horizontally scalable VictoriaMetrics, which scales to multiple nodes. -* [Managed VictoriaMetrics at AWS](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc). + +### Starting VM-Cluster via Docker: + +The following commands clone the latest available [VictoriaMetrics cluster repository](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster) and start the docker container via 'docker-compose'. Further customization is possible by editing the [docker-compose.yaml](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/cluster/deployment/docker/docker-compose.yml) file. + +```bash +git clone https://github.com/VictoriaMetrics/VictoriaMetrics --branch cluster && cd VictoriaMetrics/deployment/docker && docker-compose up +``` + +* [Cluster setup](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#cluster-setup) + +## Writing data + +Data can be written to VictoriaMetrics in the following ways: + +* [DataDog agent](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-datadog-agent) +* [InfluxDB-compatible agents such as Telegraf](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) +* [Graphite-compatible agents such as StatsD](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-graphite-compatible-agents-such-as-statsd) +* [OpenTSDB-compatible agents](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-opentsdb-compatible-agents) +* [Prometheus remote_write API](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) +* [In JSON line format](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-import-data-in-json-line-format) +* [Imported in CSV format](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-import-csv-data) +* [Imported in Prometheus exposition format](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-import-data-in-prometheus-exposition-format) +* `/api/v1/import` for importing data obtained from [/api/v1/export](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-export-data-in-json-line-format). + See [these docs](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-import-data-in-json-line-format) for details. + +## Reading data + +VictoriaMetrics various APIs for reading the data. [This document briefly describes these APIs](https://docs.victoriametrics.com/url-examples.html). + +### Grafana setup: + +Create [Prometheus datasource](http://docs.grafana.org/features/datasources/prometheus/) in Grafana with the following url: + +```url +http://:8428 +``` + +Substitute `` with the hostname or IP address of VictoriaMetrics. + +Then build graphs and dashboards for the created datasource using [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) or [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html).