logstash-input-twitter 3.0.3 → 3.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/docs/index.asciidoc +225 -0
- data/logstash-input-twitter.gemspec +4 -2
- metadata +31 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bba593742e660c80110a34df062516d6fe02284b
|
|
4
|
+
data.tar.gz: 8ab5db006d055ee9f8bf8b96f3e6c30edee53a68
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 682ec663925857d87e177c52d70fb32a0d16aaae23addabe336a951268f5cd3018c65ab1cd7e1161557e8953fd43f89e0b0d087292798ac5c7f68dc366ebf4a5
|
|
7
|
+
data.tar.gz: 9a049ec69246c3e4a8d8fc2686a819b703070a6f66126c162ffd85cc31ca3e71c93119a4049ab382cd2bd50227c73d72bab2866453d59a7edb70be307ea0c479
|
data/CHANGELOG.md
CHANGED
data/docs/index.asciidoc
ADDED
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
:plugin: twitter
|
|
2
|
+
:type: input
|
|
3
|
+
|
|
4
|
+
///////////////////////////////////////////
|
|
5
|
+
START - GENERATED VARIABLES, DO NOT EDIT!
|
|
6
|
+
///////////////////////////////////////////
|
|
7
|
+
:version: %VERSION%
|
|
8
|
+
:release_date: %RELEASE_DATE%
|
|
9
|
+
:changelog_url: %CHANGELOG_URL%
|
|
10
|
+
:include_path: ../../../logstash/docs/include
|
|
11
|
+
///////////////////////////////////////////
|
|
12
|
+
END - GENERATED VARIABLES, DO NOT EDIT!
|
|
13
|
+
///////////////////////////////////////////
|
|
14
|
+
|
|
15
|
+
[id="plugins-{type}-{plugin}"]
|
|
16
|
+
|
|
17
|
+
=== Twitter
|
|
18
|
+
|
|
19
|
+
include::{include_path}/plugin_header.asciidoc[]
|
|
20
|
+
|
|
21
|
+
==== Description
|
|
22
|
+
|
|
23
|
+
Ingest events from the Twitter Streaming API.
|
|
24
|
+
|
|
25
|
+
[id="plugins-{type}s-{plugin}-options"]
|
|
26
|
+
==== Twitter Input Configuration Options
|
|
27
|
+
|
|
28
|
+
This plugin supports the following configuration options plus the <<plugins-{type}s-common-options>> described later.
|
|
29
|
+
|
|
30
|
+
[cols="<,<,<",options="header",]
|
|
31
|
+
|=======================================================================
|
|
32
|
+
|Setting |Input type|Required
|
|
33
|
+
| <<plugins-{type}s-{plugin}-consumer_key>> |<<string,string>>|Yes
|
|
34
|
+
| <<plugins-{type}s-{plugin}-consumer_secret>> |<<password,password>>|Yes
|
|
35
|
+
| <<plugins-{type}s-{plugin}-follows>> |<<array,array>>|No
|
|
36
|
+
| <<plugins-{type}s-{plugin}-full_tweet>> |<<boolean,boolean>>|No
|
|
37
|
+
| <<plugins-{type}s-{plugin}-ignore_retweets>> |<<boolean,boolean>>|No
|
|
38
|
+
| <<plugins-{type}s-{plugin}-keywords>> |<<array,array>>|No
|
|
39
|
+
| <<plugins-{type}s-{plugin}-languages>> |<<array,array>>|No
|
|
40
|
+
| <<plugins-{type}s-{plugin}-locations>> |<<string,string>>|No
|
|
41
|
+
| <<plugins-{type}s-{plugin}-oauth_token>> |<<string,string>>|Yes
|
|
42
|
+
| <<plugins-{type}s-{plugin}-oauth_token_secret>> |<<password,password>>|Yes
|
|
43
|
+
| <<plugins-{type}s-{plugin}-proxy_address>> |<<string,string>>|No
|
|
44
|
+
| <<plugins-{type}s-{plugin}-proxy_port>> |<<number,number>>|No
|
|
45
|
+
| <<plugins-{type}s-{plugin}-rate_limit_reset_in>> |<<number,number>>|No
|
|
46
|
+
| <<plugins-{type}s-{plugin}-use_proxy>> |<<boolean,boolean>>|No
|
|
47
|
+
| <<plugins-{type}s-{plugin}-use_samples>> |<<boolean,boolean>>|No
|
|
48
|
+
|=======================================================================
|
|
49
|
+
|
|
50
|
+
Also see <<plugins-{type}s-common-options>> for a list of options supported by all
|
|
51
|
+
input plugins.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
[id="plugins-{type}s-{plugin}-consumer_key"]
|
|
56
|
+
===== `consumer_key`
|
|
57
|
+
|
|
58
|
+
* This is a required setting.
|
|
59
|
+
* Value type is <<string,string>>
|
|
60
|
+
* There is no default value for this setting.
|
|
61
|
+
|
|
62
|
+
Your Twitter App's consumer key
|
|
63
|
+
|
|
64
|
+
Don't know what this is? You need to create an "application"
|
|
65
|
+
on Twitter, see this url: <https://dev.twitter.com/apps/new>
|
|
66
|
+
|
|
67
|
+
[id="plugins-{type}s-{plugin}-consumer_secret"]
|
|
68
|
+
===== `consumer_secret`
|
|
69
|
+
|
|
70
|
+
* This is a required setting.
|
|
71
|
+
* Value type is <<password,password>>
|
|
72
|
+
* There is no default value for this setting.
|
|
73
|
+
|
|
74
|
+
Your Twitter App's consumer secret
|
|
75
|
+
|
|
76
|
+
If you don't have one of these, you can create one by
|
|
77
|
+
registering a new application with Twitter:
|
|
78
|
+
<https://dev.twitter.com/apps/new>
|
|
79
|
+
|
|
80
|
+
[id="plugins-{type}s-{plugin}-follows"]
|
|
81
|
+
===== `follows`
|
|
82
|
+
|
|
83
|
+
* Value type is <<array,array>>
|
|
84
|
+
* There is no default value for this setting.
|
|
85
|
+
|
|
86
|
+
A comma separated list of user IDs, indicating the users to
|
|
87
|
+
return statuses for in the Twitter stream.
|
|
88
|
+
See https://dev.twitter.com/streaming/overview/request-parameters#follow
|
|
89
|
+
for more details.
|
|
90
|
+
|
|
91
|
+
[id="plugins-{type}s-{plugin}-full_tweet"]
|
|
92
|
+
===== `full_tweet`
|
|
93
|
+
|
|
94
|
+
* Value type is <<boolean,boolean>>
|
|
95
|
+
* Default value is `false`
|
|
96
|
+
|
|
97
|
+
Record full tweet object as given to us by the Twitter Streaming API.
|
|
98
|
+
|
|
99
|
+
[id="plugins-{type}s-{plugin}-ignore_retweets"]
|
|
100
|
+
===== `ignore_retweets`
|
|
101
|
+
|
|
102
|
+
* Value type is <<boolean,boolean>>
|
|
103
|
+
* Default value is `false`
|
|
104
|
+
|
|
105
|
+
Lets you ingore the retweets coming out of the Twitter API. Default => false
|
|
106
|
+
|
|
107
|
+
[id="plugins-{type}s-{plugin}-keywords"]
|
|
108
|
+
===== `keywords`
|
|
109
|
+
|
|
110
|
+
* Value type is <<array,array>>
|
|
111
|
+
* There is no default value for this setting.
|
|
112
|
+
|
|
113
|
+
Any keywords to track in the Twitter stream. For multiple keywords, use
|
|
114
|
+
the syntax ["foo", "bar"]. There's a logical OR between each keyword
|
|
115
|
+
string listed and a logical AND between words separated by spaces per
|
|
116
|
+
keyword string.
|
|
117
|
+
See https://dev.twitter.com/streaming/overview/request-parameters#track
|
|
118
|
+
for more details.
|
|
119
|
+
|
|
120
|
+
The wildcard "*" option is not supported. To ingest a sample stream of
|
|
121
|
+
all tweets, the use_samples option is recommended.
|
|
122
|
+
|
|
123
|
+
[id="plugins-{type}s-{plugin}-languages"]
|
|
124
|
+
===== `languages`
|
|
125
|
+
|
|
126
|
+
* Value type is <<array,array>>
|
|
127
|
+
* There is no default value for this setting.
|
|
128
|
+
|
|
129
|
+
A list of BCP 47 language identifiers corresponding to any of the languages listed
|
|
130
|
+
on Twitter’s advanced search page will only return tweets that have been detected
|
|
131
|
+
as being written in the specified languages.
|
|
132
|
+
|
|
133
|
+
[id="plugins-{type}s-{plugin}-locations"]
|
|
134
|
+
===== `locations`
|
|
135
|
+
|
|
136
|
+
* Value type is <<string,string>>
|
|
137
|
+
* There is no default value for this setting.
|
|
138
|
+
|
|
139
|
+
A comma-separated list of longitude, latitude pairs specifying a set
|
|
140
|
+
of bounding boxes to filter tweets by.
|
|
141
|
+
See https://dev.twitter.com/streaming/overview/request-parameters#locations
|
|
142
|
+
for more details.
|
|
143
|
+
|
|
144
|
+
[id="plugins-{type}s-{plugin}-oauth_token"]
|
|
145
|
+
===== `oauth_token`
|
|
146
|
+
|
|
147
|
+
* This is a required setting.
|
|
148
|
+
* Value type is <<string,string>>
|
|
149
|
+
* There is no default value for this setting.
|
|
150
|
+
|
|
151
|
+
Your oauth token.
|
|
152
|
+
|
|
153
|
+
To get this, login to Twitter with whatever account you want,
|
|
154
|
+
then visit <https://dev.twitter.com/apps>
|
|
155
|
+
|
|
156
|
+
Click on your app (used with the consumer_key and consumer_secret settings)
|
|
157
|
+
Then at the bottom of the page, click 'Create my access token' which
|
|
158
|
+
will create an oauth token and secret bound to your account and that
|
|
159
|
+
application.
|
|
160
|
+
|
|
161
|
+
[id="plugins-{type}s-{plugin}-oauth_token_secret"]
|
|
162
|
+
===== `oauth_token_secret`
|
|
163
|
+
|
|
164
|
+
* This is a required setting.
|
|
165
|
+
* Value type is <<password,password>>
|
|
166
|
+
* There is no default value for this setting.
|
|
167
|
+
|
|
168
|
+
Your oauth token secret.
|
|
169
|
+
|
|
170
|
+
To get this, login to Twitter with whatever account you want,
|
|
171
|
+
then visit <https://dev.twitter.com/apps>
|
|
172
|
+
|
|
173
|
+
Click on your app (used with the consumer_key and consumer_secret settings)
|
|
174
|
+
Then at the bottom of the page, click 'Create my access token' which
|
|
175
|
+
will create an oauth token and secret bound to your account and that
|
|
176
|
+
application.
|
|
177
|
+
|
|
178
|
+
[id="plugins-{type}s-{plugin}-proxy_address"]
|
|
179
|
+
===== `proxy_address`
|
|
180
|
+
|
|
181
|
+
* Value type is <<string,string>>
|
|
182
|
+
* Default value is `"127.0.0.1"`
|
|
183
|
+
|
|
184
|
+
Location of the proxy, by default the same machine as the one running this LS instance
|
|
185
|
+
|
|
186
|
+
[id="plugins-{type}s-{plugin}-proxy_port"]
|
|
187
|
+
===== `proxy_port`
|
|
188
|
+
|
|
189
|
+
* Value type is <<number,number>>
|
|
190
|
+
* Default value is `3128`
|
|
191
|
+
|
|
192
|
+
Port where the proxy is listening, by default 3128 (squid)
|
|
193
|
+
|
|
194
|
+
[id="plugins-{type}s-{plugin}-rate_limit_reset_in"]
|
|
195
|
+
===== `rate_limit_reset_in`
|
|
196
|
+
|
|
197
|
+
* Value type is <<number,number>>
|
|
198
|
+
* Default value is `300`
|
|
199
|
+
|
|
200
|
+
Duration in seconds to wait before retrying a connection when twitter responds with a 429 TooManyRequests
|
|
201
|
+
In some cases the 'x-rate-limit-reset' header is not set in the response and <error>.rate_limit.reset_in
|
|
202
|
+
is nil. If this occurs then we use the integer specified here. The default is 5 minutes.
|
|
203
|
+
|
|
204
|
+
[id="plugins-{type}s-{plugin}-use_proxy"]
|
|
205
|
+
===== `use_proxy`
|
|
206
|
+
|
|
207
|
+
* Value type is <<boolean,boolean>>
|
|
208
|
+
* Default value is `false`
|
|
209
|
+
|
|
210
|
+
When to use a proxy to handle the connections
|
|
211
|
+
|
|
212
|
+
[id="plugins-{type}s-{plugin}-use_samples"]
|
|
213
|
+
===== `use_samples`
|
|
214
|
+
|
|
215
|
+
* Value type is <<boolean,boolean>>
|
|
216
|
+
* Default value is `false`
|
|
217
|
+
|
|
218
|
+
Returns a small random sample of all public statuses. The tweets returned
|
|
219
|
+
by the default access level are the same, so if two different clients connect
|
|
220
|
+
to this endpoint, they will see the same tweets. If set to true, the keywords,
|
|
221
|
+
follows, locations, and languages options will be ignored. Default => false
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
include::{include_path}/{type}.asciidoc[]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-input-twitter'
|
|
4
|
-
s.version = '3.0.
|
|
4
|
+
s.version = '3.0.4'
|
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
|
6
6
|
s.summary = "Read events from the twitter streaming api."
|
|
7
7
|
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
|
|
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
|
|
|
11
11
|
s.require_paths = ["lib"]
|
|
12
12
|
|
|
13
13
|
# Files
|
|
14
|
-
s.files = Dir[
|
|
14
|
+
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
|
|
15
15
|
|
|
16
16
|
# Tests
|
|
17
17
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
|
@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
|
|
|
22
22
|
# Gem dependencies
|
|
23
23
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
|
24
24
|
s.add_runtime_dependency 'twitter', '5.15.0'
|
|
25
|
+
s.add_runtime_dependency 'http-form_data', '<= 1.0.1'
|
|
26
|
+
s.add_runtime_dependency 'public_suffix', '<= 1.4.6'
|
|
25
27
|
s.add_runtime_dependency 'stud', '>= 0.0.22', '< 0.1'
|
|
26
28
|
|
|
27
29
|
s.add_development_dependency 'logstash-devutils'
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-input-twitter
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0.
|
|
4
|
+
version: 3.0.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Elastic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2017-05-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -44,6 +44,34 @@ dependencies:
|
|
|
44
44
|
- - '='
|
|
45
45
|
- !ruby/object:Gem::Version
|
|
46
46
|
version: 5.15.0
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
requirements:
|
|
50
|
+
- - "<="
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: 1.0.1
|
|
53
|
+
name: http-form_data
|
|
54
|
+
prerelease: false
|
|
55
|
+
type: :runtime
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "<="
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: 1.0.1
|
|
61
|
+
- !ruby/object:Gem::Dependency
|
|
62
|
+
requirement: !ruby/object:Gem::Requirement
|
|
63
|
+
requirements:
|
|
64
|
+
- - "<="
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: 1.4.6
|
|
67
|
+
name: public_suffix
|
|
68
|
+
prerelease: false
|
|
69
|
+
type: :runtime
|
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - "<="
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: 1.4.6
|
|
47
75
|
- !ruby/object:Gem::Dependency
|
|
48
76
|
requirement: !ruby/object:Gem::Requirement
|
|
49
77
|
requirements:
|
|
@@ -119,6 +147,7 @@ files:
|
|
|
119
147
|
- LICENSE
|
|
120
148
|
- NOTICE.TXT
|
|
121
149
|
- README.md
|
|
150
|
+
- docs/index.asciidoc
|
|
122
151
|
- lib/logstash/inputs/twitter.rb
|
|
123
152
|
- lib/logstash/inputs/twitter/patches.rb
|
|
124
153
|
- logstash-input-twitter.gemspec
|