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 指定的频率扫描目录中的文件。指定 1 秒以尽可能频繁地扫描目录，而不会导致 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 分钟）之类的时间字符串。默认值为 5 分钟。

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

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

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

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

默认情况下启用此选项。如果禁用此选项，您还必须禁用 clean_removed。

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

启用此选项后，Filebeat 会在到达文件末尾时立即关闭文件。当您的文件只写入一次，而不是不时更新时，这非常有用。例如，当您将每个日志事件写入一个新文件时，会发生这种情况。默认情况下禁用此选项。

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

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

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

当您将 close.reader.after_interval 用于包含多行事件的日志时，harvester 可能会在多行事件的中间停止，这意味着只会发送事件的部分内容。如果 harvester 再次启动并且文件仍然存在，则只会发送事件的第二部分。

此选项默认为 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 无法在磁盘上找到以最后已知名称命名的文件，则会从注册表中清理这些文件。这也意味着在 harvester 完成后重命名的文件将被删除。默认情况下启用此选项。

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

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

回退选项指定 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 数量。这直接关系到打开的最大文件句柄数。harvester_limit 的默认值为 0，这意味着没有限制。如果要收割的文件数量超过操作系统的打开文件句柄限制，则此配置很有用。

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

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

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

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

file_identity.native: ~

file_identity.path: ~

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

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

有关详细信息，请参阅指纹配置。

file_identity.fingerprint: ~

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

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

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

但是，如果使用 copytruncate 策略，您应该为 Filebeat 提供其他配置。

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

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