Feedback: Configure CockroachDB Dedicated Logs about docs HOT 3 CLOSED

Kevin Ngo (kevin-v-ngo) commented:
Hi Florence Morris, assigning this to you. Should be a relatively small update where we need to provide guidance on redaction. If the default redaction behavior and policies do not meet requirements, we recommend users to use downstream logging system (with redactable markers) to redact.

from docs.

Florence Morris (florence-crl) commented:
Hi Kevin Ngo , would you be able to give an example how “the default redaction and policies do not meet requirements”? And how using downstream logging system (with redactable markers) to redact?

From my testing, an example log line with {{logs.yaml}}

defaults (redact: false, redactable: true):

{{+- Your cluster is open to any client that can access ‹localhost›.}}

redact: true (redactable: true):

{{+- Your cluster is open to any client that can access ‹×›.}}

redact: true, redactable: false

{{ +- Your cluster is open to any client that can access ×.}}

from docs.

Kevin Ngo (kevin-v-ngo) commented:
We shouldn’t provide examples on how to redact using third party tools (similar to third party monitoring tools). Users should already know how to use their downstream tools to identify the redactable markers <> for fields they need to redact.

For this doc issue, its sufficient to just say something along the lines of:

If the default redaction behavior and policies do not meet redaction requirements, we recommend users to use downstream logging system (with redactable markers) to redact.

from docs.