From c7e03f30d85abb91c69b172cc7119b5f537f48ea Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 3 Feb 2021 12:11:53 +0200 Subject: [PATCH] docs: mention about Graphite render API implementation --- README.md | 12 +++++++++--- docs/CHANGELOG.md | 1 + docs/Single-server-VictoriaMetrics.md | 12 +++++++++--- 3 files changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e32477a47..02c4afa76 100644 --- a/README.md +++ b/README.md @@ -449,13 +449,12 @@ The `/api/v1/export` endpoint should return the following response: Data sent to VictoriaMetrics via `Graphite plaintext protocol` may be read via the following APIs: +* [Graphite API](#graphite-api-usage) * [Prometheus querying API](#prometheus-querying-api-usage). Graphite metric names may special chars such as `-`, which may clash with [MetricsQL operations](https://victoriametrics.github.io/MetricsQL.html). Such metrics can be queries via `{__name__="foo-bar.baz"}`. VictoriaMetrics supports `__graphite__` pseudo-label for selecting time series with Graphite-compatible filters in [MetricsQL](https://victoriametrics.github.io/MetricsQL.html). For example, `{__graphite__="foo.*.bar"}` is equivalent to `{__name__=~"foo[.][^.]*[.]bar"}`, but it works faster and it is easier to use when migrating from Graphite to VictoriaMetrics. -* Metric names can be explored via [Graphite metrics API](#graphite-metrics-api-usage) -* Tags can be explored via [Graphite tags API](#graphite-tags-api-usage) * [go-graphite/carbonapi](https://github.com/go-graphite/carbonapi/blob/main/cmd/carbonapi/carbonapi.example.victoriametrics.yaml) ## How to send data from OpenTSDB-compatible agents @@ -587,8 +586,9 @@ Additionally VictoriaMetrics provides the following handlers: ## Graphite API usage -VictoriaMetrics supports the following Graphite APIs: +VictoriaMetrics supports the following Graphite APIs, which are needed for [Graphite datasource in Grafana](https://grafana.com/docs/grafana/latest/datasources/graphite/): +* Render API - see [these docs](#graphite-render-api-usage). * Metrics API - see [these docs](#graphite-metrics-api-usage). * Tags API - see [these docs](#graphite-tags-api-usage). @@ -597,6 +597,12 @@ For example, `{__graphite__="foo.*.bar"}` is equivalent to `{__name__=~"foo[.][^ and it is easier to use when migrating from Graphite to VictoriaMetrics. +### Graphite Render API usage + +[VictoriaMetrics Enterprise](https://victoriametrics.com/enterprise.html) supports [Graphite Render API](https://graphite.readthedocs.io/en/stable/render_api.html) subset, +which is needed for [Graphite datasource in Grafana](https://grafana.com/docs/grafana/latest/datasources/graphite/). + + ### Graphite Metrics API usage VictoriaMetrics supports the following handlers from [Graphite Metrics API](https://graphite-api.readthedocs.io/en/latest/api.html#the-metrics-api): diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 31e761774..9aea77dd9 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -22,6 +22,7 @@ in front of VictoriaMetrics. [Contact us](mailto:sales@victoriametrics.com) if y - `vm_promscrape_discovery_retries_total` - `vm_promscrape_scrape_retries_total` - `vm_promscrape_service_discovery_duration_seconds` +* FEATURE: vmselect: initial implementation for [Graphite Render API](#graphite-render-api-usage). * BUGFIX: vmagent: reduce HTTP reconnection rate for scrape targets. Previously vmagent could errorneusly close HTTP keep-alive connections more frequently than needed. * BUGFIX: vmagent: retry scrape and service discovery requests when the remote server closes HTTP keep-alive connection. Previously `disable_keepalive: true` option could be used under `scrape_configs` section when working with such servers. diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index e32477a47..02c4afa76 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -449,13 +449,12 @@ The `/api/v1/export` endpoint should return the following response: Data sent to VictoriaMetrics via `Graphite plaintext protocol` may be read via the following APIs: +* [Graphite API](#graphite-api-usage) * [Prometheus querying API](#prometheus-querying-api-usage). Graphite metric names may special chars such as `-`, which may clash with [MetricsQL operations](https://victoriametrics.github.io/MetricsQL.html). Such metrics can be queries via `{__name__="foo-bar.baz"}`. VictoriaMetrics supports `__graphite__` pseudo-label for selecting time series with Graphite-compatible filters in [MetricsQL](https://victoriametrics.github.io/MetricsQL.html). For example, `{__graphite__="foo.*.bar"}` is equivalent to `{__name__=~"foo[.][^.]*[.]bar"}`, but it works faster and it is easier to use when migrating from Graphite to VictoriaMetrics. -* Metric names can be explored via [Graphite metrics API](#graphite-metrics-api-usage) -* Tags can be explored via [Graphite tags API](#graphite-tags-api-usage) * [go-graphite/carbonapi](https://github.com/go-graphite/carbonapi/blob/main/cmd/carbonapi/carbonapi.example.victoriametrics.yaml) ## How to send data from OpenTSDB-compatible agents @@ -587,8 +586,9 @@ Additionally VictoriaMetrics provides the following handlers: ## Graphite API usage -VictoriaMetrics supports the following Graphite APIs: +VictoriaMetrics supports the following Graphite APIs, which are needed for [Graphite datasource in Grafana](https://grafana.com/docs/grafana/latest/datasources/graphite/): +* Render API - see [these docs](#graphite-render-api-usage). * Metrics API - see [these docs](#graphite-metrics-api-usage). * Tags API - see [these docs](#graphite-tags-api-usage). @@ -597,6 +597,12 @@ For example, `{__graphite__="foo.*.bar"}` is equivalent to `{__name__=~"foo[.][^ and it is easier to use when migrating from Graphite to VictoriaMetrics. +### Graphite Render API usage + +[VictoriaMetrics Enterprise](https://victoriametrics.com/enterprise.html) supports [Graphite Render API](https://graphite.readthedocs.io/en/stable/render_api.html) subset, +which is needed for [Graphite datasource in Grafana](https://grafana.com/docs/grafana/latest/datasources/graphite/). + + ### Graphite Metrics API usage VictoriaMetrics supports the following handlers from [Graphite Metrics API](https://graphite-api.readthedocs.io/en/latest/api.html#the-metrics-api):