From 75f3db1f5cf059ae31f283c8c8fcce4eedab903e Mon Sep 17 00:00:00 2001 From: Yurii Kravets <30324382+YuriKravetc@users.noreply.github.com> Date: Tue, 22 Feb 2022 20:08:35 +0200 Subject: [PATCH] Update URL examples (#2207) added div with copy function --- docs/url-examples.md | 88 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) diff --git a/docs/url-examples.md b/docs/url-examples.md index 8bdb21f75..ecdb95b27 100644 --- a/docs/url-examples.md +++ b/docs/url-examples.md @@ -10,15 +10,23 @@ sort: 20 **Deletes time series from VictoriaMetrics** Single: +
+ ```bash curl 'http://:8428/api/v1/admin/tsdb/delete_series?match[]=vm_http_request_errors_total' ``` +
+ Cluster: +
+ ```bash curl 'http://:8481/delete/0/prometheus/api/v1/admin/tsdb/delete_series?match[]=vm_http_request_errors_total' ``` +
+ Additional information: * [How to delete time series](https://docs.victoriametrics.com/#how-to-delete-time-series) @@ -28,15 +36,23 @@ Additional information: **Exports CSV data from VictoriaMetrics** Single: +
+ ```bash curl 'http://:8428/api/v1/export/csv?format=__name__,__value__,__timestamp__:unix_s&match=vm_http_request_errors_total' > filename.txt ``` + +
Cluster: +
+ ```bash curl -G 'http://:8481/select/0/prometheus/api/v1/export/csv?format=__name__,__value__,__timestamp__:unix_s&match=vm_http_request_errors_total' > filename.txt ``` +
+ Additional information: * [How to export time series](https://docs.victoriametrics.com/#how-to-export-csv-data) * [URL Format](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) @@ -47,15 +63,23 @@ Additional information: **Exports data from VictoriaMetrics in native format** Single: +
+ ```bash curl -G 'http://:8428/api/v1/export/native?match[]=vm_http_request_errors_total' > filename.txt ``` +
+ Cluster: +
+ ```bash curl -G 'http://:8481/select/0/prometheus/api/v1/export/native?match=vm_http_request_errors_total' > filename.txt ``` +
+ More information: * [How to export data in native format](https://docs.victoriametrics.com/#how-to-export-data-in-native-format) @@ -65,15 +89,23 @@ More information: **Imports data obtained via /api/v1/export** Single: +
+ ```bash curl --data-binary "@import.txt" -X POST 'http://destination-victoriametrics:8428/api/v1/import' ``` +
+ Cluster: +
+ ```bash curl --data-binary "@import.txt" -X POST 'http://:8480/insert/prometheus/api/v1/import' ``` +
+ Additional information: * [How to import time series data](https://docs.victoriametrics.com/#how-to-import-time-series-data) @@ -83,17 +115,25 @@ Additional information: **Imports CSV data to VictoriaMetrics** Single: +
+ ```bash curl --data-binary "@import.txt" -X POST 'http://localhost:8428/api/v1/import/prometheus' curl -d "GOOG,1.23,4.56,NYSE" 'http://localhost:8428/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' ``` +
+ Cluster: +
+ ```bash curl --data-binary "@import.txt" -X POST 'http://:8480/insert/0/prometheus/api/v1/import/csv' curl -d "GOOG,1.23,4.56,NYSE" 'http://:8480/insert/0/prometheus/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' ``` +
+ Additional information: * [URL format](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#url-format) * [How to import CSV data](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-import-csv-data) @@ -104,6 +144,8 @@ Additional information: **Sends data from DataDog agent to VM** Single: +
+ ```bash echo ' { @@ -126,7 +168,11 @@ echo ' ' | curl -X POST --data-binary @- http://localhost:8428/datadog/api/v1/series ``` +
+ Cluster: +
+ ```bash echo ' { @@ -149,6 +195,8 @@ echo ' ' | curl -X POST --data-binary @- 'http://:8480/insert/0/datadog/api/v1/series' ``` +
+ Additional information: * [How to send data from datadog agent](https://docs.victoriametrics.com/#how-to-send-data-from-datadog-agent) @@ -158,14 +206,22 @@ Additional information: **Searches Graphite metrics in VictoriaMetrics** Single: +
+ ```bash curl -G 'http://localhost:8428/graphite/metrics/find?query=vm_http_request_errors_total' ``` + +
Cluster: +
+ ```bash curl -G 'http://:8481/select/0/graphite/metrics/find?query=vm_http_request_errors_total' ``` + +
Additional information: * [Metrics find](https://graphite-api.readthedocs.io/en/latest/api.html#metrics-find) @@ -178,14 +234,22 @@ Additional information: **Writes data with InfluxDB line protocol to VictoriaMetrics** Single: +
+ ```bash curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://localhost:8428/write' ``` + +
Cluster: +
+ ```bash curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://:8480/insert/0/influx/write' ``` + +
Additional information: * [How to send data from influxdb compatible agents such as telegraf](https://docs.victoriametrics.com/#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) @@ -199,27 +263,43 @@ Turned off by default. Enable OpenTSDB receiver in VictoriaMetrics by setting `- *If run from docker, '-opentsdbListenAddr' port should be exposed* Single: +
+ ```bash echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2" | nc -N localhost 4242 ``` + +
Cluster: +
+ ```bash echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2 VictoriaMetrics_AccountID=0" | nc -N http:// 4242 ``` + +
Enable HTTP server for OpenTSDB /api/put requests by setting `-opentsdbHTTPListenAddr` command-line flag. Single: +
+ ```bash curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' http://localhost:4242/api/put ``` + +
Cluster: +
+ ```bash curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' 'http://:8480/insert/42/opentsdb/api/put' ``` + +
Additional information: * [Api http put](http://opentsdb.net/docs/build/html/api_http/put.html) @@ -231,16 +311,24 @@ Additional information: Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` command-line flag. Single: +
+ ```bash echo "foo.bar.baz;tag1=value1;tag2=value2 123 `date +%s`" | nc -N localhost 2003 ``` + +
Cluster: +
+ ```bash echo "foo.bar.baz;tag1=value1;tag2=value2;VictoriaMetrics_AccountID=42 123 `date +%s`" | nc -N http:// 2003 ``` +
+ Additional information: `VictoriaMetrics_AccountID=42` - tag that indicated tenant ID.