Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-15 00:13:30 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: url example change the title h2->h3 h3->h4 for better indexing in search

Browse Source 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
This commit is contained in:
Artem Navoiev 2023-11-07 09:54:32 +01:00 committed by Aliaksandr Valialkin
parent b72dc10bb3
commit 4bba3e39bd
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/url-examples.md
View File

@ -10,7 +10,7 @@ menu:
# VictoriaMetrics API examples # VictoriaMetrics API examples
## /api/v1/admin/tsdb/delete_series ### /api/v1/admin/tsdb/delete_series
**Deletes time series from VictoriaMetrics** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **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) * [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) * [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** **Performs PromQL/MetricsQL instant query**
@ -363,7 +363,7 @@ Additional information:
* [Query language](https://docs.victoriametrics.com/keyConcepts.html#metricsql) * [Query language](https://docs.victoriametrics.com/keyConcepts.html#metricsql)
* [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) * [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** **Performs PromQL/MetricsQL range query**
@ -391,7 +391,7 @@ Additional information:
* [Query language](https://docs.victoriametrics.com/keyConcepts.html#metricsql) * [Query language](https://docs.victoriametrics.com/keyConcepts.html#metricsql)
* [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) * [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** **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) * [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. 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** **Cardinality statistics**
@ -449,7 +449,7 @@ Additional information:
* [TSDB Stats](https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-stats) * [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) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format)
## /datadog ### /datadog
**DataDog URL for Single-node VictoriaMetrics** **DataDog URL for Single-node VictoriaMetrics**
@ -471,7 +471,7 @@ http://vminsert:8480/insert/0/datadog
</div> </div>
## /datadog/api/v1/series ### /datadog/api/v1/series
**Imports data in DataDog format into VictoriaMetrics** **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) * [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) * [URL format for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format)
## /federate ### /federate
**Returns federated metrics** **Returns federated metrics**
@ -562,7 +562,7 @@ Additional information:
* [Prometheus-compatible federation data](https://prometheus.io/docs/prometheus/latest/federation/#configuring-federation) * [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) * [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** **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) * [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) * [URL Format](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format)
## /influx/write ### /influx/write
**Writes data with InfluxDB line protocol to VictoriaMetrics** **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) * [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) * [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.** **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://<vmselect>:8481/select/internal/resetRollupResultCache
</div> </div>
## 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. Turned off by default. Enable OpenTSDB receiver in VictoriaMetrics by setting `-opentsdbListenAddr` command-line flag.
*If run from docker, '-opentsdbListenAddr' port should be exposed* *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) * [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 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. Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` command-line flag.