From 709cd46cd9d8da54582729fe9a634e9ef0afdc8a Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Tue, 26 Nov 2024 20:32:06 +0100 Subject: [PATCH] docs: explain the json log format in more detail --- docs/content/docs.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/content/docs.md b/docs/content/docs.md index cb05455b6..1bc681aef 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -1466,8 +1466,13 @@ warnings and significant events. ### --use-json-log ### -This switches the log format to JSON for rclone. The fields of json log -are level, msg, source, time. +This switches the log format to JSON. The log messages are then +streamed as individual JSON objects, with fields: level, msg, source, +and time. The resulting format is what is sometimes referred to as +[newline-delimited JSON](https://en.wikipedia.org/wiki/JSON_streaming#Newline-delimited_JSON) +(NDJSON), or JSON Lines (JSONL). This is well suited for processing by +traditional line-oriented tools and shell pipelines, but a complete log +file is not strictly valid JSON and needs a parser that can handle it. ### --low-level-retries NUMBER ###