设置	输入类型	必需
`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`	哈希表	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

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

向事件添加字段

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

这可以帮助以后进行处理。

`type`

编辑

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

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

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

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

如果您尝试在已经具有类型的事件上设置类型（例如，当您从发货器发送事件到索引器时），则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器，在发货器处设置的类型也会在事件的整个生命周期中保留。

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