filestream 输入

要匹配您希望 Filebeat 包含的文件的正则表达式列表。如果提供了正则表达式列表，则仅收集由模式允许的文件。

默认情况下不排除任何文件。此选项是 prospector.scanner.exclude_files 的对应项。

以下示例配置 Filebeat 以排除不在 /var/log 下的文件。

filebeat.inputs:
- type: filestream
  ...
  prospector.scanner.include_files: ['^/var/log/.*']

请参阅 正则表达式支持 以获取支持的正则表达式模式列表。

使用 symlinks 选项，Filebeat 除了常规文件之外还可以收集符号链接。在收集符号链接时，Filebeat 会打开并读取原始文件，即使它报告的是符号链接的路径。

配置符号链接以进行收集时，请确保已排除原始路径。如果单个输入配置为同时收集符号链接和原始文件，Filebeat 将检测到问题，并且仅处理它找到的第一个文件。但是，如果配置了两个不同的输入（一个读取符号链接，另一个读取原始路径），则两个路径都将被收集，导致 Filebeat 发送重复数据，并且输入会覆盖彼此的状态。

如果符号链接到日志文件的文件名中包含其他元数据，并且您想在 Logstash 中处理这些元数据，则 symlinks 选项很有用。例如，Kubernetes 日志文件就是这种情况。

由于此选项可能导致数据丢失，因此默认情况下已禁用。

如果启用此选项，如果文件的大小没有更改但其修改时间已更改为早于之前的时间，则文件将被重新发送。默认情况下禁用它以避免意外重新发送文件。

Filebeat 检查要收集的路径中是否有新文件的频率。例如，如果您指定了类似 /var/log/* 的 glob，则将使用 check_interval 指定的频率扫描目录以查找文件。指定 1s 以尽可能频繁地扫描目录，而不会导致 Filebeat 扫描过于频繁。我们建议不要将此值设置为 <1s。

如果您需要以接近实时的速度发送日志行，请不要使用非常低的 check_interval，而是调整 close.on_state_change.inactive，以便文件处理程序保持打开状态并持续轮询您的文件。

默认设置为 10 秒。

在比较文件时，不再依赖设备 ID 和 inode 值，而是比较给定字节范围的文件哈希值。

如果您遇到由于文件系统提供的文件标识符不稳定导致的数据丢失或数据重复，请启用此选项。

以下是一些可能发生这种情况的场景

配置

默认情况下禁用指纹模式。

通常，日志行包含时间戳和其他唯一字段，这些字段应该能够使用指纹模式，但在每个用例中，用户都应该检查其日志以确定 offset 和 length 参数的适当值。默认 offset 为 0，默认 length 为 1024 或 1 KB。 length 不能小于 64。

fingerprint:
  enabled: false
  offset: 0
  length: 1024

如果启用此选项，Filebeat 将忽略在指定时间段之前修改的任何文件。如果您长期保留日志文件，配置 ignore_older 可能特别有用。例如，如果您想启动 Filebeat，但只想发送最新的文件和过去一周的文件，则可以配置此选项。

您可以使用时间字符串，例如 2h（2 小时）和 5m（5 分钟）。默认为 0，禁用此设置。注释掉配置的效果与将其设置为 0 相同。

受此设置影响的文件分为两类

对于以前从未见过的文件，偏移量状态将设置为文件末尾。如果状态已存在，则偏移量将重置为文件的大小。如果稍后再次更新文件，则读取将从设置的偏移量位置继续。

ignore_older 设置依赖于文件的修改时间来确定是否忽略文件。如果在将行写入文件时未更新文件的修改时间（这可能发生在 Windows 上），则 ignore_older 设置可能会导致 Filebeat 忽略文件，即使在稍后添加了内容。

要从注册表文件中删除以前收集的文件的状态，请使用 clean_inactive 配置选项。

在 Filebeat 忽略文件之前，必须先关闭该文件。为了确保在忽略文件时不再收集文件，您必须将 ignore_older 设置为比 close.on_state_change.inactive 更长的持续时间。

如果当前正在收集的文件属于 ignore_older 范围，则收集器将首先完成读取文件，并在达到 close.on_state_change.inactive 后关闭它。然后，在此之后，该文件将被忽略。

如果启用此选项，Filebeat 将忽略自选定时间以来未更新的每个文件。可能的选项是 since_first_start 和 since_last_start。第一个选项忽略自 Filebeat 首次启动以来未更新的每个文件。当 Beat 可能由于配置更改或故障而重新启动时，这很有用。第二个选项告诉 Beat 读取自其启动以来已更新的文件。

受此设置影响的文件分为两类

对于以前从未见过的文件，偏移量状态将设置为文件末尾。如果状态已存在，则偏移量不会更改。如果稍后再次更新文件，则读取将从设置的偏移量位置继续。

此设置依赖于文件的修改时间来确定是否忽略文件。如果在将行写入文件时未更新文件的修改时间（这可能发生在 Windows 上），则此设置可能会导致 Filebeat 忽略文件，即使在稍后添加了内容。

要从注册表文件中删除以前收集的文件的状态，请使用 clean_inactive 配置选项。

如果将 take_over 设置为 true，则此 filestream 将接管来自 log 输入的所有文件，前提是它们至少匹配 filestream 中设置的 paths 之一。

创建此 take over 模式是为了能够从已弃用的 log 输入平滑迁移到新的 filestream 输入。

有关迁移过程的更多详细信息，请参阅 将 log 输入配置迁移到 filestream。

close.* 配置选项用于在满足特定条件或时间后关闭收集器。关闭收集器意味着关闭文件句柄。如果在关闭收集器后更新了文件，则该文件将在 prospector.scanner.check_interval 过期后再次被拾取。但是，如果在收集器关闭时移动或删除了文件，则 Filebeat 将无法再次拾取该文件，并且收集器未读取的任何数据都将丢失。

close.on_state_change.* 设置异步应用于读取文件，这意味着如果 Filebeat 由于输出阻塞、队列已满或其他问题而处于阻塞状态，则无论如何都会关闭文件。

启用此选项时，如果文件在指定持续时间内未被收集，Filebeat 将关闭文件句柄。已定义时间段的计数器从收集器读取最后一条日志行时开始。它不是基于文件的修改时间。如果关闭的文件再次更改，则将启动一个新的收集器，并且在 prospector.scanner.check_interval 过期后将拾取最新的更改。

建议您将 close.on_state_change.inactive 设置为大于日志文件更新频率最低的值。例如，如果您的日志文件每隔几秒更新一次，则可以安全地将 close.on_state_change.inactive 设置为 1m。如果存在更新速率差异很大的日志文件，则可以使用多个具有不同值的配置。

将 close.on_state_change.inactive 设置为较低的值意味着文件句柄将更快地关闭。但是，这会产生副作用，即如果收集器关闭，则不会以接近实时的速度发送新的日志行。

关闭文件的时间戳不依赖于文件的修改时间。相反，Filebeat 使用反映文件上次收集时间的内部时间戳。例如，如果将 close.on_state_change.inactive 设置为 5 分钟，则 5 分钟的倒计时将从收集器读取文件的最后一行后开始。

您可以使用时间字符串，例如 2h（2 小时）和 5m（5 分钟）。默认为 5m。

启用此选项时，如果文件被重命名，Filebeat 将关闭文件句柄。例如，在轮换文件时会发生这种情况。默认情况下，收集器保持打开状态并继续读取文件，因为文件句柄不依赖于文件名。如果启用了 close.on_state_change.renamed 选项，并且文件以不再与为其指定的 文件模式匹配的方式重命名或移动，则该文件将不会再次被拾取。Filebeat 将不会完成读取文件。

当配置基于 path 的 file_identity 时，请勿使用此选项。启用此选项没有意义，因为 Filebeat 无法使用路径名作为唯一标识符检测重命名。

WINDOWS：如果您的 Windows 日志轮换系统显示错误，因为它无法轮换文件，则应启用此选项。

启用此选项时，如果文件被删除，Filebeat 将关闭收集器。通常，文件应仅在处于非活动状态 close.on_state_change.inactive 指定的持续时间后才能删除。但是，如果文件过早删除并且您没有启用 close.on_state_change.removed，则 Filebeat 会保持文件打开状态以确保收集器已完成。如果此设置导致文件由于过早从磁盘删除而未完全读取，请禁用此选项。

此选项默认启用。如果禁用此选项，则必须同时禁用clean_removed。

WINDOWS：如果您的 Windows 日志轮换系统显示错误，因为它无法轮换文件，请确保此选项已启用。

启用此选项后，Filebeat 只要到达文件末尾就会关闭文件。当您的文件仅写入一次且不会定期更新时，这很有用。例如，当您将每个日志事件写入新文件时就会发生这种情况。此选项默认禁用。

启用此选项后，Filebeat 会为每个采集器提供一个预定义的生命周期。无论读取器在文件中的哪个位置，读取将在close.reader.after_interval时间段结束后停止。当您希望仅在文件上花费预定义的时间时，此选项对于旧日志文件很有用。虽然close.reader.after_interval将在预定义的超时后关闭文件，但如果文件仍在更新，Filebeat 将根据定义的prospector.scanner.check_interval再次启动一个新的采集器。并且此采集器的 close.reader.after_interval 将再次开始倒计时。

如果输出被阻塞，此选项特别有用，这会导致 Filebeat 即使对于已从磁盘删除的文件也保持打开文件句柄。将close.reader.after_interval设置为5m可确保定期关闭文件，以便操作系统可以释放它们。

如果将close.reader.after_interval设置为等于ignore_older，则如果在采集器关闭时修改了文件，则不会拾取该文件。这种设置组合通常会导致数据丢失，并且不会发送完整的文件。

当您对包含多行事件的日志使用close.reader.after_interval时，采集器可能会在多行事件的中间停止，这意味着只会发送事件的一部分。如果采集器重新启动并且文件仍然存在，则只会发送事件的第二部分。

此选项默认设置为 0，这意味着它已禁用。

clean_*选项用于清理注册表文件中的状态条目。这些设置有助于减小注册表文件的大小，并可以防止潜在的inode 重用问题。

启用此选项后，Filebeat 会在指定的不活动时间段结束后删除文件的状态。只有当 Filebeat 已经忽略该文件（该文件比ignore_older旧）时，才能删除该状态。clean_inactive设置必须大于ignore_older + prospector.scanner.check_interval，以确保在文件仍在采集时不会删除任何状态。否则，该设置可能会导致 Filebeat 不断重新发送完整内容，因为clean_inactive会删除 Filebeat 仍在检测到的文件的状态。如果文件更新或再次出现，则会从开头读取文件。

clean_inactive配置选项可用于减小注册表文件的大小，尤其是在每天生成大量新文件的情况下。

此配置选项还有助于防止由 Linux 上的 inode 重用导致的 Filebeat 问题。有关更多信息，请参阅Inode 重用导致 Filebeat 跳过行。

启用此选项后，如果 Filebeat 在磁盘上找不到文件（使用上次已知名称），则会从注册表中清理这些文件。这意味着还将删除在采集器完成之后重命名的文件。此选项默认启用。

如果共享驱动器短暂消失然后再次出现，所有文件将从开头重新读取，因为状态已从注册表文件中删除。在这种情况下，我们建议您禁用clean_removed选项。

如果还禁用了close.on_state_change.removed，则必须禁用此选项。

backoff 选项指定 Filebeat 扫描打开文件以获取更新的力度。在大多数情况下，您可以使用默认值。

backoff.init选项定义 Filebeat 在 EOF 达到后第一次检查文件之前等待多长时间。回退间隔呈指数增长。默认为 2 秒。因此，文件将在 2 秒后检查，然后 4 秒，然后 8 秒，依此类推，直到达到backoff.max中定义的限制。每次文件中出现新行时，backoff.init值都会重置为初始值。

Filebeat 在 EOF 达到后再次检查文件之前等待的最长时间。在多次回退检查文件后，等待时间永远不会超过backoff.max。因为读取新行最多需要 10 秒，所以为backoff.max指定 10 秒意味着，在最坏的情况下，如果 Filebeat 已多次回退，则可以将新行添加到日志文件中。默认为 10 秒。

要求：将backoff.max设置为大于或等于backoff.init且小于或等于prospector.scanner.check_interval（backoff.init <= backoff.max <= prospector.scanner.check_interval）。如果需要更高的backoff.max，建议改为关闭文件句柄并让 Filebeat 再次拾取文件。

harvester_limit选项限制为一个输入并行启动的采集器数量。这直接关系到打开的文件句柄的最大数量。harvester_limit的默认值为 0，这意味着没有限制。如果要采集的文件数量超过操作系统的打开文件句柄限制，则此配置很有用。

对采集器数量设置限制意味着可能并非所有文件都并行打开。因此，我们建议您将此选项与close.on_state_change.*选项结合使用，以确保更频繁地停止采集器，以便可以拾取新文件。

目前，如果可以再次启动新的采集器，则会随机选择采集器。这意味着，刚刚关闭然后更新的文件的采集器可能会启动，而不是长时间未采集的文件的采集器。

此配置选项适用于每个输入。您可以使用此选项通过分配更高的采集器限制来间接设置某些输入的更高优先级。

可以配置不同的file_identity方法以适应您收集日志消息的环境。

file_identity.native: ~

file_identity.path: ~

以以下方式设置标记文件的位置

file_identity.inode_marker.path: /logs/.filebeat-marker

请参阅 fingerprint 配置以获取详细信息。

file_identity.fingerprint: ~

由于日志文件会不断写入，因此必须对其进行轮换和清除，以防止记录器应用程序填满磁盘。轮换由外部应用程序完成，因此 Filebeat 需要了解如何与其协作。

从轮换文件读取时，请确保路径配置包含活动文件和所有轮换文件。

默认情况下，Filebeat 能够在以下策略中正确跟踪文件：* create：在轮换时创建具有唯一名称的新活动文件 * rename：轮换的文件将重命名

但是，在 copytruncate 策略的情况下，您应该为 Filebeat 提供其他配置。

如果日志轮换应用程序复制活动文件的内容，然后截断原始文件，请使用这些选项来帮助 Filebeat 正确读取文件。

设置选项suffix_regex，以便 Filebeat 可以区分活动文件和轮换文件。输入中有两种受支持的后缀类型：数字和日期。