Skip to content

Commit

Permalink
(1) Updated Configure Logs page, Redact Logs section with recommendat…
Browse files Browse the repository at this point in the history
…ion to use external log collector to redact logs. (#18104)
  • Loading branch information
florence-crl authored Dec 13, 2023
1 parent 7457a30 commit 30e7faa
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion src/current/v23.1/configure-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,13 +509,15 @@ http-defaults:
In addition, the `DEV` channel should be output to a separate logging directory, since it is likely to contain sensitive data. See [`DEV` channel](#dev-channel).
{{site.data.alerts.end}}
External log collectors can misinterpret the `cockroach debug` redaction markers, since they are specific to CockroachDB. To prevent this issue when using network sinks, disable `redactable`:
External log collectors can misinterpret the `cockroach debug` redaction markers (`< >`), since they are specific to CockroachDB. To prevent this issue when using network sinks, disable `redactable`:
~~~ yaml
fluent-defaults:
redactable: false
~~~
If the default redaction behavior and policies do not meet redaction requirements, we recommend using the external log collectors with the redaction markers (`< >`) to redact. In this case, enable `redactable`.
### DEV channel
The `DEV` channel is used for debug and uncategorized messages. It can therefore be noisy and contain sensitive (PII) information.
Expand Down
4 changes: 3 additions & 1 deletion src/current/v23.2/configure-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,13 +576,15 @@ http-defaults:
In addition, the `DEV` channel should be output to a separate logging directory, since it is likely to contain sensitive data. See [`DEV` channel](#dev-channel).
{{site.data.alerts.end}}
External log collectors can misinterpret the `cockroach debug` redaction markers, since they are specific to CockroachDB. To prevent this issue when using network sinks, disable `redactable`:
External log collectors can misinterpret the `cockroach debug` redaction markers (`< >`), since they are specific to CockroachDB. To prevent this issue when using network sinks, disable `redactable`:
~~~ yaml
fluent-defaults:
redactable: false
~~~
If the default redaction behavior and policies do not meet redaction requirements, we recommend using the external log collectors with the redaction markers (`< >`) to redact. In this case, enable `redactable`.
### DEV channel
The `DEV` channel is used for debug and uncategorized messages. It can therefore be noisy and contain sensitive (PII) information.
Expand Down

0 comments on commit 30e7faa

Please sign in to comment.