From b51d16e74c1be9c07ee78bde0a6cacbd3c444501 Mon Sep 17 00:00:00 2001 From: Artem Navoiev Date: Tue, 7 Nov 2023 09:54:32 +0100 Subject: [PATCH] docs: url example change the title h2->h3 h3->h4 for better indexing in search Signed-off-by: Artem Navoiev --- docs/url-examples.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/url-examples.md b/docs/url-examples.md index d20177a08..93e6396f9 100644 --- a/docs/url-examples.md +++ b/docs/url-examples.md @@ -10,7 +10,7 @@ menu: # VictoriaMetrics API examples -## /api/v1/admin/tsdb/delete_series +### /api/v1/admin/tsdb/delete_series **Deletes time series from VictoriaMetrics** @@ -81,7 +81,7 @@ Additional information: * [How to delete time series](https://docs.victoriametrics.com/#how-to-delete-time-series) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/export +### /api/v1/export **Exports raw samples from VictoriaMetrics in JSON line format** @@ -110,7 +110,7 @@ Additional information: * [How to export data in JSON line format](https://docs.victoriametrics.com/#how-to-export-data-in-json-line-format) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/export/csv +### /api/v1/export/csv **Exports raw samples from VictoriaMetrics in CSV format** @@ -138,7 +138,7 @@ Additional information: * [How to import time series](https://docs.victoriametrics.com/#how-to-import-time-series-data) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/export/native +### /api/v1/export/native **Exports raw samples from VictoriaMetrics in native format** @@ -166,7 +166,7 @@ More information: * [How to import time series](https://docs.victoriametrics.com/#how-to-import-time-series-data) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/import +### /api/v1/import **Imports data to VictoriaMetrics in JSON line format** @@ -194,7 +194,7 @@ More information: * [How to export time series](https://docs.victoriametrics.com/#how-to-export-time-series) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/import/csv +### /api/v1/import/csv **Imports CSV data to VictoriaMetrics** @@ -222,7 +222,7 @@ Additional information: * [How to export time series](https://docs.victoriametrics.com/#how-to-export-time-series) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/import/native +### /api/v1/import/native **Imports data to VictoriaMetrics in native format** @@ -248,7 +248,7 @@ Additional information: * [How to export time series](https://docs.victoriametrics.com/#how-to-export-time-series) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/import/prometheus +### /api/v1/import/prometheus **Imports data to VictoriaMetrics in Prometheus text exposition format** @@ -305,7 +305,7 @@ Additional information: * [Querying label values](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/label/.../values +### /api/v1/label/.../values **Get a list of values for a particular label on the given time range** @@ -335,7 +335,7 @@ Additional information: * [Getting label names](https://prometheus.io/docs/prometheus/latest/querying/api/#getting-label-names) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/query +### /api/v1/query **Performs PromQL/MetricsQL instant query** @@ -363,7 +363,7 @@ Additional information: * [Query language](https://docs.victoriametrics.com/keyConcepts.html#metricsql) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/query_range +### /api/v1/query_range **Performs PromQL/MetricsQL range query** @@ -391,7 +391,7 @@ Additional information: * [Query language](https://docs.victoriametrics.com/keyConcepts.html#metricsql) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /api/v1/series +### /api/v1/series **Returns series names with their labels on the given time range** @@ -422,7 +422,7 @@ Additional information: * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) VictoriaMetrics accepts `limit` query arg for `/api/v1/series` handlers for limiting the number of returned entries. For example, the query to `/api/v1/series?limit=5` returns a sample of up to 5 series, while ignoring the rest. If the provided `limit` value exceeds the corresponding `-search.maxSeries` command-line flag values, then limits specified in the command-line flags are used. -## /api/v1/status/tsdb +### /api/v1/status/tsdb **Cardinality statistics** @@ -449,7 +449,7 @@ Additional information: * [TSDB Stats](https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-stats) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /datadog +### /datadog **DataDog URL for Single-node VictoriaMetrics** @@ -471,7 +471,7 @@ http://vminsert:8480/insert/0/datadog -## /datadog/api/v1/series +### /datadog/api/v1/series **Imports data in DataDog format into VictoriaMetrics** @@ -534,7 +534,7 @@ Additional information: * [How to send data from datadog agent](https://docs.victoriametrics.com/#how-to-send-data-from-datadog-agent) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /federate +### /federate **Returns federated metrics** @@ -562,7 +562,7 @@ Additional information: * [Prometheus-compatible federation data](https://prometheus.io/docs/prometheus/latest/federation/#configuring-federation) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /graphite/metrics/find +### /graphite/metrics/find **Searches Graphite metrics in VictoriaMetrics** @@ -591,7 +591,7 @@ Additional information: * [How to send Graphite data to VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-graphite-compatible-agents-such-as-statsd) * [URL Format](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /influx/write +### /influx/write **Writes data with InfluxDB line protocol to VictoriaMetrics** @@ -618,7 +618,7 @@ Additional information: * [How to send Influx data to VictoriaMetrics](https://docs.victoriametrics.com/#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) * [URL Format](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) -## /internal/resetRollupResultCache +### /internal/resetRollupResultCache **Resets the response cache for previously served queries. It is recommended to invoke after [backfilling](https://docs.victoriametrics.com/#backfilling) procedure.** @@ -641,9 +641,9 @@ curl -Is http://:8481/select/internal/resetRollupResultCache -## TCP and UDP +### TCP and UDP -### How to send data from OpenTSDB-compatible agents to VictoriaMetrics +#### How to send data from OpenTSDB-compatible agents to VictoriaMetrics Turned off by default. Enable OpenTSDB receiver in VictoriaMetrics by setting `-opentsdbListenAddr` command-line flag. *If run from docker, '-opentsdbListenAddr' port should be exposed* @@ -691,7 +691,7 @@ Additional information: * [OpenTSDB http put API](http://opentsdb.net/docs/build/html/api_http/put.html) * [How to send data OpenTSDB data to VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-opentsdb-compatible-agents) -### How to send Graphite data to VictoriaMetrics +#### How to send Graphite data to VictoriaMetrics Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` command-line flag.