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

Update URL examples (#2207)

Browse Source 
added div with copy function
This commit is contained in:
Yurii Kravets 2022-02-22 20:08:35 +02:00 committed by Aliaksandr Valialkin
parent fc6f71fba8
commit 538114cd7c
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
1 changed files with 88 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
docs/url-examples.md
View File

@ -10,15 +10,23 @@ sort: 20
**Deletes time series from VictoriaMetrics**
Single:
<div class="with-copy" markdown="1">
```bash
curl 'http://<victoriametrics-addr>:8428/api/v1/admin/tsdb/delete_series?match[]=vm_http_request_errors_total'
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl 'http://<vmselect>:8481/delete/0/prometheus/api/v1/admin/tsdb/delete_series?match[]=vm_http_request_errors_total'
```
</div>
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:
<div class="with-copy" markdown="1">
```bash
curl 'http://<victoriametrics-addr>:8428/api/v1/export/csv?format=__name__,__value__,__timestamp__:unix_s&match=vm_http_request_errors_total' > filename.txt
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl -G 'http://<vmselect>:8481/select/0/prometheus/api/v1/export/csv?format=__name__,__value__,__timestamp__:unix_s&match=vm_http_request_errors_total' > filename.txt
```
</div>
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:
<div class="with-copy" markdown="1">
```bash
curl -G 'http://<victoriametrics-addr>:8428/api/v1/export/native?match[]=vm_http_request_errors_total' > filename.txt
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl -G 'http://<vmselect>:8481/select/0/prometheus/api/v1/export/native?match=vm_http_request_errors_total' > filename.txt
```
</div>
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:
<div class="with-copy" markdown="1">
```bash
curl --data-binary "@import.txt" -X POST 'http://destination-victoriametrics:8428/api/v1/import'
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl --data-binary "@import.txt" -X POST 'http://<vminsert>:8480/insert/prometheus/api/v1/import'
```
</div>
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:
<div class="with-copy" markdown="1">
```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'
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl --data-binary "@import.txt" -X POST 'http://<vminsert>:8480/insert/0/prometheus/api/v1/import/csv'
curl -d "GOOG,1.23,4.56,NYSE" 'http://<vminsert>:8480/insert/0/prometheus/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market'
```
</div>
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:
<div class="with-copy" markdown="1">
```bash
echo '
{
@ -126,7 +168,11 @@ echo '
' | curl -X POST --data-binary @- http://localhost:8428/datadog/api/v1/series
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
echo '
{
@ -149,6 +195,8 @@ echo '
' | curl -X POST --data-binary @- 'http://<vminsert>:8480/insert/0/datadog/api/v1/series'
```
</div>
Additional information:
* [How to send data from datadog agent](https://docs.victoriametrics.com/#how-to-send-data-from-datadog-agent)
@ -158,15 +206,23 @@ Additional information:
**Searches Graphite metrics in VictoriaMetrics**
Single:
<div class="with-copy" markdown="1">
```bash
curl -G 'http://localhost:8428/graphite/metrics/find?query=vm_http_request_errors_total'
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl -G 'http://<vmselect>:8481/select/0/graphite/metrics/find?query=vm_http_request_errors_total'
```
</div>
Additional information:
* [Metrics find](https://graphite-api.readthedocs.io/en/latest/api.html#metrics-find)
* [How to send data from graphite compatible agents such as statsd](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-graphite-compatible-agents-such-as-statsd)
@ -178,15 +234,23 @@ Additional information:
**Writes data with InfluxDB line protocol to VictoriaMetrics**
Single:
<div class="with-copy" markdown="1">
```bash
curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://localhost:8428/write'
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://<vminsert>:8480/insert/0/influx/write'
```
</div>
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,28 +263,44 @@ Turned off by default. Enable OpenTSDB receiver in VictoriaMetrics by setting `-
*If run from docker, '-opentsdbListenAddr' port should be exposed*
Single:
<div class="with-copy" markdown="1">
```bash
echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2" | nc -N localhost 4242
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2 VictoriaMetrics_AccountID=0" | nc -N http://<vminsert> 4242
```
</div>
Enable HTTP server for OpenTSDB /api/put requests by setting `-opentsdbHTTPListenAddr` command-line flag.
Single:
<div class="with-copy" markdown="1">
```bash
curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' http://localhost:4242/api/put
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]'
'http://<vminsert>:8480/insert/42/opentsdb/api/put'
```
</div>
Additional information:
* [Api http put](http://opentsdb.net/docs/build/html/api_http/put.html)
* [How to send data from opentsdb compatible agents](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-send-data-from-opentsdb-compatible-agents)
@ -231,16 +311,24 @@ Additional information:
Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` command-line flag.
Single:
<div class="with-copy" markdown="1">
```bash
echo "foo.bar.baz;tag1=value1;tag2=value2 123 `date +%s`" |
nc -N localhost 2003
```
</div>
Cluster:
<div class="with-copy" markdown="1">
```bash
echo "foo.bar.baz;tag1=value1;tag2=value2;VictoriaMetrics_AccountID=42 123 `date +%s`" | nc -N http://<vminsert> 2003
```
</div>
Additional information:
`VictoriaMetrics_AccountID=42` - tag that indicated tenant ID.