githubedit

  • Version: 3.0.1
  • Released on: 2016-07-14
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-input-github.

Read events from github webhooks

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

github {
    port => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

codec

codec

No

"plain"

drop_invalid

boolean

No

false

enable_metric

boolean

No

true

id

string

No

ip

string

No

"0.0.0.0"

port

number

Yes

secret_token

string

No

tags

array

No

type

string

No

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

  • Value type is codec
  • 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.

drop_invalidedit

  • Value type is boolean
  • Default value is false

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

enable_metricedit

  • Value type is boolean
  • Default value is true

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 is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

  • Value type is string
  • Default value is "0.0.0.0"

The ip to listen on

portedit

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

The port to listen on

secret_tokenedit

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

Your GitHub Secret Token for the webhook

tagsedit

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

Add any number of arbitrary tags to your event.

This can help with processing later.

typeedit

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

Add a type 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.