« Generator 输入插件 Google Cloud Storage 输入插件 »

› ›

Github 输入插件

编辑

Github 输入插件

编辑

插件版本: v3.0.11
发布于: 2023-05-30
更新日志

有关其他版本，请参阅版本化插件文档。

安装

编辑

对于默认未捆绑的插件，可以通过运行bin/logstash-plugin install logstash-input-github轻松安装。有关更多详细信息，请参阅使用插件。

获取帮助

编辑

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

描述

编辑

从 github webhooks 读取事件

Github 输入配置选项

编辑

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

设置	输入类型	必需
`drop_invalid`	布尔值	否
`ip`	字符串	否
`port`	数字	是
`secret_token`	密码	否

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

`drop_invalid`

编辑

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

如果定义了 Secret，我们会删除不匹配的事件。否则，我们只会添加一个无效标签

`ip`

编辑

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

要监听的 IP

`port`

编辑

这是一个必需的设置。
值类型为数字
此设置没有默认值。

要监听的端口

`secret_token`

编辑

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

您的 GitHub Webhook 密钥令牌

通用选项

编辑

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

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

`add_field`

编辑

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

向事件添加字段

`codec`

编辑

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

用于输入数据的编解码器。输入编解码器是在数据进入输入之前解码数据的便捷方法，无需在 Logstash 管道中使用单独的过滤器。

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

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

`type`

编辑

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

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

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

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

如果您尝试在已经具有类型的事件上设置类型（例如，当您将事件从托运人发送到索引器时），则新的输入将不会覆盖现有类型。托运人设置的类型会一直保留在该事件中，即使发送到另一个 Logstash 服务器也是如此。

« Generator 输入插件 Google Cloud Storage 输入插件 »