loki.secretfilter: Add explicit message in the docs about labels no…

…t being scanned (#2588) * Add explicit message in the docs about labels not being scanned * Add explicit message in the docs about labels not being scanned * Update docs/sources/reference/components/loki/loki.secretfilter.md Co-authored-by: Clayton Cornell <[email protected]> --------- Co-authored-by: Clayton Cornell <[email protected]>
grafana · Jan 31, 2025 · d0b4081 · d0b4081
1 parent db30a7d
commit d0b4081
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/sources/reference/components/loki/loki.secretfilter.md b/docs/sources/reference/components/loki/loki.secretfilter.md
@@ -20,6 +20,10 @@ This component may generate false positives or redact too much.
 Don't rely solely on this component to redact sensitive information.
 {{< /admonition >}}
 
+{{< admonition type="note" >}}
+This component operates on log lines and doesn't scan labels or other metadata.
+{{< /admonition >}}
+
 [gitleaks]: https://github.com/gitleaks/gitleaks/blob/master/config/gitleaks.toml
 
 ## Usage
@@ -104,7 +108,7 @@ The following fields are exported and can be referenced by other components:
 
 ## Example
 
-This example shows how to use `loki.secretfilter` to redact secrets from log entries before forwarding them to a Loki receiver.
+This example shows how to use `loki.secretfilter` to redact secrets from log lines before forwarding them to a Loki receiver.
 It uses a custom redaction string that will include the secret type and its hash.
 
 ```alloy