• Plugin version: v3.0.11
• Released on: 2023-05-30
• Changelog

For other versions, see theVersioned plugin docs.

For plugins not bundled by default, it is easy to install by runningbin/logstash-plugin install logstash-input-github. SeeWorking with plugins for more details.

For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.

Read events from github webhooks

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all input plugins.

• Value type isboolean
• Default value isfalse

If Secret is defined, we drop the events that don’t match. Otherwise, we’ll just add an invalid tag

• Value type isstring
• Default value is"0.0.0.0"

The ip to listen on

• This is a required setting.
• Value type isnumber
• There is no default value for this setting.

The port to listen on

• Value type ispassword
• There is no default value for this setting.

Your GitHub Secret Token for the webhook

These configuration options are supported by all input plugins:

• Value type ishash
• Default value is{}

Add a field to an event

• Value type iscodec
• Default value is"plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

• Value type isboolean
• Default value istrue

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

• Value type isstring
• There is no default value for this setting.

Add a uniqueID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 github inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

• Value type isarray
• There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

• Value type isstring
• There is no default value for this setting.

Add atype field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.