github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2025-01-10 15:14:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: explicitly mention errors processing for import APIs (#4583)

Browse source 
Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
Roman Khavronenko 2023-07-06 00:21:56 +02:00 committed by Aliaksandr Valialkin
parent 97a5bdf4f0
commit 690f58c016
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
2 changed files with 14 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/README.md
View file

@ -1168,14 +1168,15 @@ Additionally, VictoriaMetrics can accept metrics via the following popular data
* `/api/v1/import/prometheus` for importing data in Prometheus exposition format and in [Pushgateway format](https://github.com/prometheus/pushgateway#url). * `/api/v1/import/prometheus` for importing data in Prometheus exposition format and in [Pushgateway format](https://github.com/prometheus/pushgateway#url).
See [these docs](#how-to-import-data-in-prometheus-exposition-format) for details. See [these docs](#how-to-import-data-in-prometheus-exposition-format) for details.
### How to import data in JSON line format Please note, most of the ingestion APIs (except [Prometheus remote_write API](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write))
are optimized for performance and processes data in a streaming fashion.
`/api/v1/import` is an API optimized for performance and processes data in a streaming fashion. It means that client can transfer unlimited amount of data through the open connection. Because of this, import APIs
The client can transfer unlimited amount of data through one open connection. may not return parsing errors to the client, as it is expected for data stream to be not interrupted.
`/api/v1/import` API doesn't return parsing errors to the client, as it is expected for data stream Instead, look for parsing errors on the server side (VictoriaMetrics single-node or vminsert) or
to be not interrupted. Instead, look for parsing errors on server side (VictoriaMetrics single-node or vminsert) or
check for changes in `vm_rows_invalid_total` (exported by server side) metric. check for changes in `vm_rows_invalid_total` (exported by server side) metric.
### How to import data in JSON line format
Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format): Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format):
```console ```console

13
docs/Single-server-VictoriaMetrics.md
View file

@ -1176,14 +1176,15 @@ Additionally, VictoriaMetrics can accept metrics via the following popular data
* `/api/v1/import/prometheus` for importing data in Prometheus exposition format and in [Pushgateway format](https://github.com/prometheus/pushgateway#url). * `/api/v1/import/prometheus` for importing data in Prometheus exposition format and in [Pushgateway format](https://github.com/prometheus/pushgateway#url).
See [these docs](#how-to-import-data-in-prometheus-exposition-format) for details. See [these docs](#how-to-import-data-in-prometheus-exposition-format) for details.
### How to import data in JSON line format Please note, most of the ingestion APIs (except [Prometheus remote_write API](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write))
are optimized for performance and processes data in a streaming fashion.
`/api/v1/import` is an API optimized for performance and processes data in a streaming fashion. It means that client can transfer unlimited amount of data through the open connection. Because of this, import APIs
The client can transfer unlimited amount of data through one open connection. may not return parsing errors to the client, as it is expected for data stream to be not interrupted.
`/api/v1/import` API doesn't return parsing errors to the client, as it is expected for data stream Instead, look for parsing errors on the server side (VictoriaMetrics single-node or vminsert) or
to be not interrupted. Instead, look for parsing errors on server side (VictoriaMetrics single-node or vminsert) or
check for changes in `vm_rows_invalid_total` (exported by server side) metric. check for changes in `vm_rows_invalid_total` (exported by server side) metric.
### How to import data in JSON line format
Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format): Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format):
```console ```console