Skip to content

Commit 3eb7887

Browse files
authored
Merge pull request #2507 from lucafavatella/kv-lager-logs-multi-line
Warn Riak KV user of potential newlines in log messages
2 parents 4cc9d68 + 3904e3d commit 3eb7887

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

content/riak/kv/2.2.3/using/reference/logging.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,21 @@ and the message `prefix` will often identify the Riak subsystem
6565
involved, e.g. `riak_ensemble_peer` or `alarm_handler` (amongst many
6666
other possibilities).
6767

68+
{{% note title="Warning: Log messages may contain newline characters" %}}
69+
As of Riak KV 2.2.3 a few of the log messages may contain newline
70+
characters, preventing reliable identification of the end of each log
71+
when attempting log files ingestion by external tools.
72+
73+
A known workaround is ingesting not the logs enabled by the
74+
`log.console` configurable parameter but rather the logs as enabled by
75+
the `log.syslog` configurable parameter and processed by syslog,
76+
e.g. exploiting the
77+
[`no-multi-line`](https://www.balabit.com/documents/syslog-ng-ose-3.5-guides/en/syslog-ng-ose-guide-admin/html-single/index.html)
78+
option (e.g. see [this StackExchange topic
79+
answer](https://unix.stackexchange.com/questions/317422/is-there-a-way-to-rewrite-parts-of-a-message-globally-instead-of-inserting-rewri/317474#317474))
80+
- or equivalent - of syslog implementations.
81+
{{% /note %}}
82+
6883
The exception to this syntax is in crash logs (stored in `crash.log`
6984
files). For crash logs, the syntax tends to be along the following
7085
lines:

0 commit comments

Comments
 (0)