From a7d80f62be05eb10e1d6aa59f8490f37d232f84f Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 9 Dec 2019 23:26:50 +0200 Subject: [PATCH] README.md: add a chapter about Prometheus querying API usage Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/253 --- README.md | 14 ++++++++++++++ docs/Single-server-VictoriaMetrics.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/README.md b/README.md index a4f2b4bff..b3f3220e6 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,7 @@ Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaM - [How to send data from Graphite-compatible agents such as StatsD?](#how-to-send-data-from-graphite-compatible-agents-such-as-statsd) - [Querying Graphite data](#querying-graphite-data) - [How to send data from OpenTSDB-compatible agents?](#how-to-send-data-from-opentsdb-compatible-agents) + - [Prometheus querying API usage](prometheus-querying-api-usage) - [How to build from sources](#how-to-build-from-sources) - [Development build](#development-build) - [Production build](#production-build) @@ -390,6 +391,19 @@ The `/api/v1/export` endpoint should return the following response: ``` +### Prometheus querying API usage + +VictoriaMetrics supports the following handlers from [Prometheus querying API](https://prometheus.io/docs/prometheus/latest/querying/api/): + +* [/api/v1/query](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries) +* [/api/v1/query_range](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) +* [/api/v1/series](https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers) +* [/api/v1/labels](https://prometheus.io/docs/prometheus/latest/querying/api/#getting-label-names) +* [/api/v1/label/.../values](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) + +These handlers can be queried from Prometheus-compatible clients such as Grafana. + + ### How to build from sources We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 73ba6afce..8cd867649 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -64,6 +64,7 @@ Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaM - [How to send data from Graphite-compatible agents such as StatsD?](#how-to-send-data-from-graphite-compatible-agents-such-as-statsd) - [Querying Graphite data](#querying-graphite-data) - [How to send data from OpenTSDB-compatible agents?](#how-to-send-data-from-opentsdb-compatible-agents) + - [Prometheus querying API usage](prometheus-querying-api-usage) - [How to build from sources](#how-to-build-from-sources) - [Development build](#development-build) - [Production build](#production-build) @@ -381,6 +382,19 @@ The `/api/v1/export` endpoint should return the following response: ``` +### Prometheus querying API usage + +VictoriaMetrics supports the following handlers from [Prometheus querying API](https://prometheus.io/docs/prometheus/latest/querying/api/): + +* [/api/v1/query](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries) +* [/api/v1/query_range](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) +* [/api/v1/series](https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers) +* [/api/v1/labels](https://prometheus.io/docs/prometheus/latest/querying/api/#getting-label-names) +* [/api/v1/label/.../values](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) + +These handlers can be queried from Prometheus-compatible clients such as Grafana. + + ### How to build from sources We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or