Twitter input plugin

Your Twitter App’s consumer key

Don’t know what this is? You need to create an "application" on Twitter, see this url: https://dev.twitter.com/apps/new

Your Twitter App’s consumer secret

If you don’t have one of these, you can create one by registering a new application with Twitter: https://dev.twitter.com/apps/new

A comma separated list of user IDs, indicating the users to return statuses for in the Twitter stream. See https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters for more details.

Record full tweet object as given to us by the Twitter Streaming API.

Lets you ignore the retweets coming out of the Twitter API. Default ⇒ false

Any keywords to track in the Twitter stream. For multiple keywords, use the syntax ["foo", "bar"]. There’s a logical OR between each keyword string listed and a logical AND between words separated by spaces per keyword string. See https://dev.twitter.com/streaming/overview/request-parameters#track for more details.

The wildcard "*" option is not supported. To ingest a sample stream of all tweets, the use_samples option is recommended.

A list of BCP 47 language identifiers corresponding to any of the languages listed on Twitter’s advanced search page will only return tweets that have been detected as being written in the specified languages.

A comma-separated list of longitude, latitude pairs specifying a set of bounding boxes to filter tweets by. See https://dev.twitter.com/streaming/overview/request-parameters#locations for more details.

Your oauth token.

To get this, login to Twitter with whatever account you want, then visit https://dev.twitter.com/apps

Click on your app (used with the consumer_key and consumer_secret settings) Then at the bottom of the page, click Create my access token which will create an oauth token and secret bound to your account and that application.

Your oauth token secret.

To get this, login to Twitter with whatever account you want, then visit https://dev.twitter.com/apps

Click on your app (used with the consumer_key and consumer_secret settings) Then at the bottom of the page, click Create my access token which will create an oauth token and secret bound to your account and that application.

Location of the proxy, by default the same machine as the one running this LS instance

Port where the proxy is listening, by default 3128 (squid)

Duration in seconds to wait before retrying a connection when twitter responds with a 429 TooManyRequests In some cases the x-rate-limit-reset header is not set in the response and <error>.rate_limit.reset_in is nil. If this occurs then we use the integer specified here. The default is 5 minutes.

When to use a proxy to handle the connections

Returns a small random sample of all public statuses. The tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same tweets. If set to true, the keywords, follows, locations, and languages options will be ignored. Default ⇒ false

Add a field to an event

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.

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.

Add a unique ID 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 twitter inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

Add any number of arbitrary tags to your event.

This can help with processing later.

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.