› › ›

Redact 处理器

Redact 处理器编辑

此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能的支持 SLA 的约束。

Redact 处理器使用 Grok 规则引擎来模糊输入文档中与给定 Grok 模式匹配的文本。该处理器可用于通过配置它来检测已知模式（如电子邮件或 IP 地址）来模糊个人身份信息 (PII)。与 Grok 模式匹配的文本将被替换为可配置的字符串，例如 <EMAIL>（在匹配电子邮件地址时），或者如果需要，只需将所有匹配项替换为文本 <REDACTED>。

Elasticsearch 附带了许多有用的预定义模式，Redact 处理器可以方便地引用这些模式。如果这些模式不符合您的需求，请使用自定义模式定义创建新模式。Redact 处理器会替换匹配项的每次出现。如果有多个匹配项，所有匹配项都将被替换为模式名称。

Redact 处理器与 Elastic 通用模式 (ECS) 模式兼容。不支持旧版 Grok 模式。

在管道中使用 Redact 处理器编辑

表 34. Redact 选项

名称	必需	默认值	描述
`field`	是	-	要进行红化的字段
`patterns`	是	-	要匹配和红化命名捕获的 Grok 表达式列表
`pattern_definitions`	否	-	模式名称和模式元组的映射，定义处理器要使用的自定义模式。与现有名称匹配的模式将覆盖预先存在的定义
`prefix`	否	<	使用此标记开始红化部分
`suffix`	否	>	使用此标记结束红化部分
`ignore_missing`	否	`true`	如果 `true` 且 `field` 不存在或为 `null`，则处理器将静默退出，不会修改文档
`description`	否	-	处理器的描述。用于描述处理器的目的或其配置。
`if`	否	-	有条件地执行处理器。请参阅有条件地运行处理器。
`ignore_failure`	否	`false`	忽略处理器的错误。请参阅处理管道错误。
`on_failure`	否	-	处理处理器的错误。请参阅处理管道错误。
`tag`	否	-	处理器的标识符。用于调试和指标。
`skip_if_unlicensed`	否	`false`	如果 `true` 且当前许可证不支持运行 redact 处理器，则处理器将静默退出，不会修改文档

在此示例中，预定义的 IP Grok 模式用于匹配和红化来自 message 文本字段的 IP 地址。使用模拟 API 测试管道。

response = client.ingest.simulate(
  body: {
    pipeline: {
      description: 'Hide my IP',
      processors: [
        {
          redact: {
            field: 'message',
            patterns: [
              '%{IP:client}'
            ]
          }
        }
      ]
    },
    docs: [
      {
        _source: {
          message: '55.3.244.1 GET /index.html 15824 0.043'
        }
      }
    ]
  }
)
puts response

POST _ingest/pipeline/_simulate
{
  "pipeline": {
    "description" : "Hide my IP",
    "processors": [
      {
        "redact": {
          "field": "message",
          "patterns": ["%{IP:client}"]
        }
      }
    ]
  },
  "docs":[
    {
      "_source": {
        "message": "55.3.244.1 GET /index.html 15824 0.043"
      }
    }
  ]
}

响应中的文档仍然包含 message 字段，但现在 IP 地址 55.3.244.1 被替换为文本 <client>。

{
  "docs": [
    {
      "doc": {
        "_index": "_index",
        "_id": "_id",
        "_version": "-3",
        "_source": {
          "message": "<client> GET /index.html 15824 0.043"
        },
        "_ingest": {
          "timestamp": "2023-02-01T16:08:39.419056008Z"
        }
      }
    }
  ]
}

IP 地址被替换为单词 client，因为这是 Grok 模式 %{IP:client} 中指定的。包围模式名称的 < 和 > 标记可以使用 prefix 和 suffix 选项进行配置。

下一个示例定义了多个模式，这两个模式都将被替换为单词 REDACTED，并且前缀和后缀标记设置为 *

response = client.ingest.simulate(
  body: {
    pipeline: {
      description: 'Hide my IP',
      processors: [
        {
          redact: {
            field: 'message',
            patterns: [
              '%{IP:REDACTED}',
              '%{EMAILADDRESS:REDACTED}'
            ],
            prefix: '*',
            suffix: '*'
          }
        }
      ]
    },
    docs: [
      {
        _source: {
          message: '55.3.244.1 GET /index.html 15824 0.043 [email protected]'
        }
      }
    ]
  }
)
puts response

POST _ingest/pipeline/_simulate
{
  "pipeline": {
    "description": "Hide my IP",
    "processors": [
      {
        "redact": {
          "field": "message",
          "patterns": [
            "%{IP:REDACTED}",
            "%{EMAILADDRESS:REDACTED}"
          ],
          "prefix": "*",
          "suffix": "*"
        }
      }
    ]
  },
  "docs": [
    {
      "_source": {
        "message": "55.3.244.1 GET /index.html 15824 0.043 [email protected]"
      }
    }
  ]
}

在响应中，IP 55.3.244.1 和电子邮件地址 [email protected] 都被替换为 *REDACTED*。

{
  "docs": [
    {
      "doc": {
        "_index": "_index",
        "_id": "_id",
        "_version": "-3",
        "_source": {
          "message": "*REDACTED* GET /index.html 15824 0.043 *REDACTED*"
        },
        "_ingest": {
          "timestamp": "2023-02-01T16:53:14.560005377Z"
        }
      }
    }
  ]
}

自定义模式编辑

如果现有 Grok 模式之一不符合您的要求，可以使用 pattern_definitions 选项添加自定义模式。新的模式定义由模式名称和模式本身组成。模式可以是正则表达式，也可以引用现有的 Grok 模式。

此示例定义了自定义模式 GITHUB_NAME 来匹配 GitHub 用户名。模式定义使用现有的 USERNAME Grok 模式，以文字 @ 为前缀。

Grok 调试器是构建自定义模式的非常有用的工具。

response = client.ingest.simulate(
  body: {
    pipeline: {
      processors: [
        {
          redact: {
            field: 'message',
            patterns: [
              '%{GITHUB_NAME:GITHUB_NAME}'
            ],
            pattern_definitions: {
              "GITHUB_NAME": '@%<USERNAME>s'
            }
          }
        }
      ]
    },
    docs: [
      {
        _source: {
          message: '@elastic-data-management the PR is ready for review'
        }
      }
    ]
  }
)
puts response

POST _ingest/pipeline/_simulate
{
  "pipeline": {
    "processors": [
      {
        "redact": {
          "field": "message",
          "patterns": [
            "%{GITHUB_NAME:GITHUB_NAME}"
          ],
          "pattern_definitions": {
            "GITHUB_NAME": "@%{USERNAME}"
          }
        }
      }
    ]
  },
  "docs": [
    {
      "_source": {
        "message": "@elastic-data-management the PR is ready for review"
      }
    }
  ]
}

用户名在响应中被红化。

{
  "docs": [
    {
      "doc": {
        "_index": "_index",
        "_id": "_id",
        "_version": "-3",
        "_source": {
          "message": "<GITHUB_NAME> the PR is ready for review"
        },
        "_ingest": {
          "timestamp": "2023-02-01T16:53:14.560005377Z"
        }
      }
    }
  ]
}

Grok 看门狗编辑

看门狗会中断执行时间过长的表达式。中断后，Redact 处理器会失败并出现错误。控制 Grok 看门狗超时的相同设置也适用于 Redact 处理器。

许可编辑

redact 处理器是需要适当许可证的商业功能。有关更多信息，请参阅 https://elastic.ac.cn/subscriptions。

可以在 redact 处理器上设置 skip_if_unlicensed 选项，以控制集群许可证不足以运行此类处理器时的行为。 skip_if_unlicensed 默认值为 false，如果集群许可证不足，redact 处理器将抛出异常。但是，如果将 skip_if_unlicensed 选项设置为 true，则 redact 处理器在许可证不足的情况下不会抛出异常（它将什么也不做）。

« 管道处理器注册域处理器 »