twitter

Status: beta

Read events from the twitter streaming api.

Synopsis

This is what it might look like in your config file:

input {
  twitter {
    add_field => ... # hash (optional), default: {}
    debug => ... # boolean (optional)
    format => ... # ["plain", "json", "json_event"] (optional)
    keywords => ... # array (required)
    message_format => ... # string (optional)
    password => ... # password (required)
    tags => ... # array (optional)
    type => ... # string (required)
    user => ... # string (required)
  }
}

Details

add_field

• Value type is hash
• Default value is {}

Add a field to an event

debug

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

Set this to true to enable debugging on an input.

format

• Value can be any of: "plain", "json", "json_event"
• There is no default value for this setting.

The format of input data (plain, json, json_event)

keywords (required setting)

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

Any keywords to track in the twitter stream

message_format

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

If format is "json", an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname} or %{@metadata}.

password (required setting)

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

Your twitter password

tags

• 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.

type (required setting)

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

Label this input with a type. Types are used mainly for filter activation.

If you create an input with type "foobar", then only filters which also have type "foobar" will act on them.

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

user (required setting)

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

Your twitter username

---

This is documentation from lib/logstash/inputs/twitter.rb