设置	输入类型	必需
`host`	字符串	否
`password`	password	否
`port`	数字	否
`ssl_certificate`	路径	否
`ssl_certificate_authorities`	数组	否
`ssl_client_authentication`	字符串，以下之一：`["none", "optional", "required"]`	否
`ssl_enabled`	布尔值	否
`ssl_key`	路径	否
`ssl_keystore_password`	password	否
`ssl_keystore_path`	路径	否
`ssl_key_passphrase`	password	否
`username`	字符串	否

另请参阅通用选项，了解所有输入插件支持的选项列表。

`host`

编辑

值类型是字符串 IP 地址
默认值为 0.0.0.0 (所有接口)

通过提供其 IP 地址来指定要侦听的接口。默认情况下，此输入侦听所有可用的接口。

`password`

编辑

值类型是密码
此设置没有默认值。

用于基于密码的身份验证的密码。需要 username。

`port`

编辑

值类型是数字端口
默认值为 9800

指定要侦听的端口。

`ssl_certificate`

编辑

值类型是路径
此设置没有默认值。
存在时，还需要 ssl_key 和 ssl_key_passphrase。
不能与禁用 SSL 的配置组合使用。

PEM 编码的证书或证书链的路径，用于向连接的客户端标识此插件。该证书应包括有关客户端用于建立连接的 IP 地址或主机名的身份声明。

`ssl_certificate_authorities`

编辑

值类型是路径列表
此设置没有默认值。
不能与禁用 SSL 的配置组合使用。
不能与 +ssl_client_authentication => none+ 组合使用。

一个或多个 PEM 编码的文件，定义用于客户端身份验证的证书颁发机构。此设置可用于覆盖系统信任存储，以验证客户端提供的 SSL 证书。

`ssl_client_authentication`

编辑

值可以是以下任何值：
- none：不请求客户端的证书，也不验证提供的证书
- optional：请求客户端的证书，并仅当提供证书时才针对我们的信任机构验证证书
- required：要求客户端提供由受信任的证书颁发机构签名的有效证书
默认值为 "none"

默认情况下，服务器不执行任何客户端身份验证。这意味着启用 SSL 后，客户端的连接是私有的，但此输入将允许来自任何客户端的 SSL 连接。如果您希望配置此插件以拒绝来自不受信任主机的连接，则需要配置此插件以验证客户端，并且可能还需要配置其信任源。

`ssl_enabled`

编辑

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

默认情况下启用 SSL，这需要配置此插件以提供其身份。

您可以使用 +ssl_enabled => false+ 禁用 SSL。禁用后，设置任何 ssl_* 配置会导致配置失败。

`ssl_key`

编辑

值类型是路径
此设置没有默认值。
当使用 ssl_certificate 配置连接身份时，需要此选项。
不能与禁用 SSL 的配置组合使用。

PEM 编码的加密 PKCS8 SSL 证书密钥的路径。

`ssl_keystore_password`

编辑

值类型是密码
此设置没有默认值。
当使用 ssl_keystore_path 配置连接身份时，需要此选项。
不能与禁用 SSL 的配置组合使用。

ssl_keystore_path 的密码

`ssl_keystore_path`

编辑

值类型是路径
此设置没有默认值。
存在时，还需要 ssl_keystore_password。
不能与禁用 SSL 的配置组合使用。

JKS 或 PKCS12 格式的密钥库的路径，用于向 Elasticsearch 标识此插件。

`ssl_key_passphrase`

编辑

值类型是密码
此设置没有默认值。
当使用 ssl_certificate 配置连接身份时，需要此选项。
不能与禁用 SSL 的配置组合使用。

ssl_key 的密码或密码短语。

`username`

编辑

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

用于基于密码的身份验证的用户名。当使用 username 配置此输入插件时，它还需要 password，并且任何上游 logstash-output 插件也必须配置为匹配的 username/password 对。

当禁用 SSL 时，凭据将以明文形式传输。

通用选项

编辑

所有输入插件都支持以下配置选项

设置	输入类型	必需
`add_field`	hash	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

值类型为哈希
默认值为 {}

向事件添加字段

`enable_metric`

编辑

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

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

`id`

编辑

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

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

input {
  logstash {
    id => "my_plugin_id"
  }
}

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

`tags`

编辑

值类型为数组
此设置没有默认值。

向您的事件添加任意数量的标签。

这有助于后续处理。

`type`

编辑

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

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型作为事件本身的一部分存储，因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型（例如，当您从 shipper 向 indexer 发送事件时），则新的输入将不会覆盖现有类型。在 shipper 上设置的类型在其生命周期内一直与该事件相关联，即使发送到另一个 Logstash 服务器也是如此。

« Kinesis 输入插件 Log4j 输入插件 »