From 690f58c01657f171ca4812e7660924f6afae7bee Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Thu, 6 Jul 2023 00:21:56 +0200 Subject: [PATCH] docs: explicitly mention errors processing for import APIs (#4583) Signed-off-by: hagen1778 --- docs/README.md | 13 +++++++------ docs/Single-server-VictoriaMetrics.md | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4aec3925f5..6998351301 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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). See [these docs](#how-to-import-data-in-prometheus-exposition-format) for details. -### How to import data in JSON line format - -`/api/v1/import` is an API optimized for performance and processes data in a streaming fashion. -The client can transfer unlimited amount of data through one open connection. -`/api/v1/import` API doesn't return parsing errors to the client, as it is expected for data stream -to be not interrupted. Instead, look for parsing errors on server side (VictoriaMetrics single-node or vminsert) or +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. +It means that client can transfer unlimited amount of data through the open connection. Because of this, import APIs +may not return parsing errors to the client, as it is expected for data stream to be not interrupted. +Instead, look for parsing errors on the server side (VictoriaMetrics single-node or vminsert) or 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): ```console diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 5a16d55bc0..c6b3bb4f3a 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -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). See [these docs](#how-to-import-data-in-prometheus-exposition-format) for details. -### How to import data in JSON line format - -`/api/v1/import` is an API optimized for performance and processes data in a streaming fashion. -The client can transfer unlimited amount of data through one open connection. -`/api/v1/import` API doesn't return parsing errors to the client, as it is expected for data stream -to be not interrupted. Instead, look for parsing errors on server side (VictoriaMetrics single-node or vminsert) or +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. +It means that client can transfer unlimited amount of data through the open connection. Because of this, import APIs +may not return parsing errors to the client, as it is expected for data stream to be not interrupted. +Instead, look for parsing errors on the server side (VictoriaMetrics single-node or vminsert) or 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): ```console