From fed51462b701ab76c407e42d2dcf79b7c0b94d8c Mon Sep 17 00:00:00 2001 From: Romain Gaillard Date: Fri, 3 Jan 2025 14:46:58 +0100 Subject: [PATCH] Clarify usage of secret types --- docs/sources/reference/components/loki/loki.secretfilter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/reference/components/loki/loki.secretfilter.md b/docs/sources/reference/components/loki/loki.secretfilter.md index b94c3cb5fc..27dcc1d2e4 100644 --- a/docs/sources/reference/components/loki/loki.secretfilter.md +++ b/docs/sources/reference/components/loki/loki.secretfilter.md @@ -53,7 +53,7 @@ The Gitleaks configuration file embedded in the component is used if you don't p This component does not support all the features of the Gitleaks configuration file. Currently, it only supports the regex-based rules, `secretGroup`, and allowlist regexes (`regexTarget` only supports the default value `secret`). Other features such as `keywords`, `entropy`, `paths`, and `stopwords` are not supported. The `extend` feature is also not supported, meaning that a custom configuration file must contain all the rules to use. {{< /admonition >}} -The `types` argument is a map of secret types to look for. The values are used as prefixes for the secret types in the Gitleaks configuration. If you don't provide this argument, all types are used. +The `types` argument is a map of secret types to look for. The values provided are used as prefixes to match rules IDs in the Gitleaks configuration (e.g. providing the type `grafana` will match the rules `grafana-api-key`, `grafana-cloud-api-token`, and `grafana-service-account-token`). If you don't provide this argument, all rules are used. {{< admonition type="note" >}} Configuring this argument with the secret types you want to look for is strongly recommended.