› ›

文件输出插件

编辑

文件输出插件

编辑

插件版本: v4.3.0
发布日期: 2020-04-27
更新日志

对于其他版本，请参阅版本化插件文档。

获取帮助

编辑

有关插件的问题，请在Discuss论坛中开启一个主题。对于错误或功能请求，请在Github中开启一个 issue。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。

描述

编辑

此输出将事件写入磁盘上的文件。您可以使用事件中的字段作为文件名和/或路径的一部分。

默认情况下，此输出以 json 格式每行写入一个事件。您可以使用 line 编解码器自定义行格式，例如

output {
 file {
   path => ...
   codec => line { format => "custom format: %{message}"}
 }
}

文件输出配置选项

编辑

此插件支持以下配置选项，以及稍后描述的通用选项。

设置	输入类型	必填
`create_if_deleted`	布尔值	否
`dir_mode`	数字	否
`file_mode`	数字	否
`filename_failure`	字符串	否
`flush_interval`	数字	否
`gzip`	布尔值	否
`path`	字符串	是
`stale_cleanup_interval`	数字	否
`write_behavior`	字符串	否

另请参阅通用选项，以获取所有输出插件支持的选项列表。

`create_if_deleted`

编辑

值类型为布尔值
默认值为 true

如果配置的文件被删除，但插件处理了一个事件，则插件将重新创建该文件。默认值 ⇒ true

`dir_mode`

编辑

值类型为数字
默认值为 -1

要使用的目录访问模式。请注意，由于 jruby 系统中的错误，linux 上会忽略 umask：https://github.com/jruby/jruby/issues/3426。将其设置为 -1 将使用默认的操作系统值。示例："dir_mode" => 0750

`file_mode`

编辑

值类型为数字
默认值为 -1

要使用的文件访问模式。请注意，由于 jruby 系统中的错误，linux 上会忽略 umask：https://github.com/jruby/jruby/issues/3426。将其设置为 -1 将使用默认的操作系统值。示例："file_mode" => 0640

`filename_failure`

编辑

值类型为字符串
默认值为 "_filepath_failures"

如果生成的路径无效，则事件将被保存到此文件和定义的路径内。

`flush_interval`

编辑

值类型为数字
默认值为 2

将写入刷新到日志文件的刷新间隔（以秒为单位）。0 将在每条消息上刷新。

`gzip`

编辑

值类型为布尔值
默认值为 false

在写入磁盘之前对输出流进行 Gzip 压缩。

`path`

编辑

这是一个必填设置。
值类型为字符串
此设置没有默认值。

要写入的文件的路径。可以在此处使用事件字段，例如 /var/log/logstash/%{host}/%{application}。还可以通过 joda 时间格式利用路径选项进行基于日期的日志轮换。这将使用事件时间戳。例如：path => "./test-%{+YYYY-MM-dd}.txt" 将创建 ./test-2013-05-29.txt

如果使用绝对路径，则不能以动态字符串开头。例如：/%{myfield}/，/test-%{myfield}/ 不是有效的路径

`stale_cleanup_interval`

编辑

值类型为数字
默认值为 10

定义过时文件清理运行之间的间隔（以秒为单位）。过时文件清理周期会关闭不活动的文件（即自上次周期以来未写入的文件）。

`write_behavior`

编辑

值类型为字符串
默认值为 append

如果为 append，则将打开该文件以进行追加，并且每个新事件都将写入文件的末尾。如果为 overwrite，则将在写入之前截断该文件，并且该文件中将仅显示最近的事件。

通用选项

编辑

所有输出插件都支持这些配置选项

设置	输入类型	必填
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否

`codec`

编辑

值类型为编解码器
默认值为 "json_lines"

用于输出数据的编解码器。输出编解码器是一种方便的方法，可以在数据离开输出之前对其进行编码，而无需在 Logstash 管道中使用单独的过滤器。

`enable_metric`

编辑

值类型为布尔值
默认值为 true

禁用或启用此特定插件实例的指标记录。默认情况下，我们会记录所有可以记录的指标，但是您可以禁用特定插件的指标收集。

`id`

编辑

值类型为字符串
此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个 ID。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用。例如，如果您有 2 个文件输出。在这种情况下添加命名的 ID 将有助于在使用监控 API 时监控 Logstash。

output {
  file {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

« Exec 输出插件 Ganglia 输出插件 »