From 063f1c269f9167e710992f137e4534f3f501119f Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Wed, 14 Jun 2023 18:13:46 +0200 Subject: [PATCH] docs: mention errors processing for /api/v1/import API (#4448) https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4446 Signed-off-by: hagen1778 --- README.md | 6 ++++++ docs/README.md | 6 ++++++ docs/Single-server-VictoriaMetrics.md | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/README.md b/README.md index b22a0af64..387f6c4dc 100644 --- a/README.md +++ b/README.md @@ -1163,6 +1163,12 @@ Additionally, VictoriaMetrics can accept metrics via the following popular data ### 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 +check for changes in `vm_rows_invalid_total` (exported by server side) metric. + Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format): ```console diff --git a/docs/README.md b/docs/README.md index dfb287298..1cdd98492 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1166,6 +1166,12 @@ Additionally, VictoriaMetrics can accept metrics via the following popular data ### 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 +check for changes in `vm_rows_invalid_total` (exported by server side) metric. + 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 22d51a1c6..d7accfbef 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1174,6 +1174,12 @@ Additionally, VictoriaMetrics can accept metrics via the following popular data ### 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 +check for changes in `vm_rows_invalid_total` (exported by server side) metric. + Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format): ```console