logstash-input-http_bold 3.4.1-java

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.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 3.4.1
@@ -0,0 +1,437 @@
1
+ :plugin: http
2
+ :type: input
3
+ :default_codec: plain
4
+
5
+ ///////////////////////////////////////////
6
+ START - GENERATED VARIABLES, DO NOT EDIT!
7
+ ///////////////////////////////////////////
8
+ :version: %VERSION%
9
+ :release_date: %RELEASE_DATE%
10
+ :changelog_url: %CHANGELOG_URL%
11
+ :include_path: ../../../../logstash/docs/include
12
+ ///////////////////////////////////////////
13
+ END - GENERATED VARIABLES, DO NOT EDIT!
14
+ ///////////////////////////////////////////
15
+
16
+ [id="plugins-{type}s-{plugin}"]
17
+
18
+ === Http input plugin
19
+
20
+ include::{include_path}/plugin_header.asciidoc[]
21
+
22
+ ==== Description
23
+
24
+ Using this input you can receive single or multiline events over http(s).
25
+ Applications can send an HTTP request to the endpoint started by this input and
26
+ Logstash will convert it into an event for subsequent processing. Users
27
+ can pass plain text, JSON, or any formatted data and use a corresponding codec with this
28
+ input. For Content-Type `application/json` the `json` codec is used, but for all other
29
+ data formats, `plain` codec is used.
30
+
31
+ This input can also be used to receive webhook requests to integrate with other services
32
+ and applications. By taking advantage of the vast plugin ecosystem available in Logstash
33
+ you can trigger actionable events right from your application.
34
+
35
+ [id="plugins-{type}s-{plugin}-ecs_metadata"]
36
+ ==== Event Metadata and the Elastic Common Schema (ECS)
37
+ In addition to decoding the events, this input will add HTTP headers containing connection information to each event.
38
+ When ECS compatibility is disabled, the headers are stored in the `headers` field, which has the potential to create confusion and schema conflicts downstream.
39
+ When ECS is enabled, we can ensure a pipeline maintains access to this metadata throughout the event's lifecycle without polluting the top-level namespace.
40
+
41
+ Here’s how ECS compatibility mode affects output.
42
+ [cols="<l,<l,e,<e"]
43
+ |=======================================================================
44
+ | ECS `disabled` | ECS `v1`,`v8` | Availability | Description
45
+
46
+ | [host] | [host][ip] | Always | Host IP address
47
+ | [headers] | [@metadata][input][http][request][headers] | Always | Complete HTTP headers
48
+ | [headers][http_version] | [http][version] | Always | HTTP version
49
+ | [headers][http_user_agent] | [user_agent][original] | Always | client user agent
50
+ | [headers][http_host] | [url][domain] and [url][port] | Always | host domain and port
51
+ | [headers][request_method] | [http][method] | Always | HTTP method
52
+ | [headers][request_path] | [url][path] | Always | Query path
53
+ | [headers][content_length] | [http][request][body][bytes] | Always | Request content length
54
+ | [headers][content_type] | [http][request][mime_type] | Always | Request mime type
55
+ |=======================================================================
56
+
57
+ ==== Blocking Behavior
58
+
59
+ The HTTP protocol doesn't deal well with long running requests. This plugin will either return
60
+ a 429 (busy) error when Logstash is backlogged, or it will time out the request.
61
+
62
+ If a 429 error is encountered clients should sleep, backing off exponentially with some random
63
+ jitter, then retry their request.
64
+
65
+ This plugin will block if the Logstash queue is blocked and there are available HTTP input threads.
66
+ This will cause most HTTP clients to time out. Sent events will still be processed in this case. This
67
+ behavior is not optimal and will be changed in a future release. In the future, this plugin will always
68
+ return a 429 if the queue is busy, and will not time out in the event of a busy queue.
69
+
70
+ ==== Security
71
+ This plugin supports standard HTTP basic authentication headers to identify the requester.
72
+ You can pass in a username, password combination while sending data to this input
73
+
74
+ You can also setup SSL and send data securely over https, with multiple options such as
75
+ validating the client's certificate.
76
+
77
+ [id="plugins-{type}s-{plugin}-codec-settings"]
78
+ ==== Codec settings
79
+ This plugin has two configuration options for codecs: `codec` and `additional_codecs`.
80
+
81
+ Values in `additional_codecs` are prioritized over those specified in the
82
+ `codec` option. That is, the default `codec` is applied only if no codec
83
+ for the request's content-type is found in the `additional_codecs` setting.
84
+
85
+ [id="plugins-{type}s-{plugin}-options"]
86
+ ==== Http Input Configuration Options
87
+
88
+ This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
89
+
90
+ [cols="<,<,<",options="header",]
91
+ |=======================================================================
92
+ |Setting |Input type|Required
93
+ | <<plugins-{type}s-{plugin}-additional_codecs>> |<<hash,hash>>|No
94
+ | <<plugins-{type}s-{plugin}-cipher_suites>> |<<array,array>>|No
95
+ | <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
96
+ | <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
97
+ | <<plugins-{type}s-{plugin}-keystore>> |<<path,path>>|No
98
+ | <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|No
99
+ | <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
100
+ | <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
101
+ | <<plugins-{type}s-{plugin}-max_pending_requests>> |<<number,number>>|No
102
+ | <<plugins-{type}s-{plugin}-response_headers>> |<<hash,hash>>|No
103
+ | <<plugins-{type}s-{plugin}-response_code>> |<<number,number>>, one of `[200, 201, 202, 204]`|No
104
+ | <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|No
105
+ | <<plugins-{type}s-{plugin}-ssl_certificate>> |a valid filesystem path|No
106
+ | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |<<array,array>>|No
107
+ | <<plugins-{type}s-{plugin}-ssl_handshake_timeout>> |<<number,number>>|No
108
+ | <<plugins-{type}s-{plugin}-ssl_key>> |a valid filesystem path|No
109
+ | <<plugins-{type}s-{plugin}-ssl_key_passphrase>> |<<password,password>>|No
110
+ | <<plugins-{type}s-{plugin}-ssl_verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|No
111
+ | <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
112
+ | <<plugins-{type}s-{plugin}-tls_max_version>> |<<number,number>>|No
113
+ | <<plugins-{type}s-{plugin}-tls_min_version>> |<<number,number>>|No
114
+ | <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
115
+ | <<plugins-{type}s-{plugin}-verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|No
116
+ |=======================================================================
117
+
118
+ Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
119
+ input plugins.
120
+
121
+ &nbsp;
122
+
123
+ [id="plugins-{type}s-{plugin}-additional_codecs"]
124
+ ===== `additional_codecs`
125
+
126
+ * Value type is <<hash,hash>>
127
+ * Default value is `{"application/json"=>"json"}`
128
+
129
+ Apply specific codecs for specific content types.
130
+ The default codec will be applied only after this list is checked
131
+ and no codec for the request's content-type is found
132
+
133
+ [id="plugins-{type}s-{plugin}-cipher_suites"]
134
+ ===== `cipher_suites`
135
+
136
+ * Value type is <<array,array>>
137
+ * Default value is `java.lang.String[TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256]@459cfcca`
138
+
139
+ The list of ciphers suite to use, listed by priorities.
140
+
141
+ [id="plugins-{type}s-{plugin}-ecs_compatibility"]
142
+ ===== `ecs_compatibility`
143
+
144
+ * Value type is <<string,string>>
145
+ * Supported values are:
146
+ ** `disabled`: unstructured connection metadata added at root level
147
+ ** `v1`,`v8`: headers added under `[@metadata][http][header]`. Some are copied to structured ECS fields `http`, `url`, `user_agent` and `host`
148
+
149
+ Controls this plugin's compatibility with the
150
+ {ecs-ref}[Elastic Common Schema (ECS)].
151
+ See <<plugins-{type}s-{plugin}-ecs_metadata>> for detailed information.
152
+
153
+ Example output:
154
+
155
+ **Sample output: ECS disabled**
156
+ [source,text]
157
+ -----
158
+ {
159
+ "@version" => "1",
160
+ "headers" => {
161
+ "request_path" => "/twitter/tweet/1",
162
+ "http_accept" => "*/*",
163
+ "http_version" => "HTTP/1.1",
164
+ "request_method" => "PUT",
165
+ "http_host" => "localhost:8080",
166
+ "http_user_agent" => "curl/7.64.1",
167
+ "content_length" => "5",
168
+ "content_type" => "application/x-www-form-urlencoded"
169
+ },
170
+ "@timestamp" => 2021-05-28T19:27:28.609Z,
171
+ "host" => "127.0.0.1",
172
+ "message" => "hello"
173
+ }
174
+ -----
175
+
176
+ **Sample output: ECS enabled**
177
+ [source,text]
178
+ -----
179
+ {
180
+ "@version" => "1",
181
+ "user_agent" => {
182
+ "original" => "curl/7.64.1"
183
+ },
184
+ "http" => {
185
+ "method" => "PUT",
186
+ "request" => {
187
+ "mime_type" => "application/x-www-form-urlencoded",
188
+ "body" => {
189
+ "bytes" => "5"
190
+ }
191
+ },
192
+ "version" => "HTTP/1.1"
193
+ },
194
+ "url" => {
195
+ "port" => "8080",
196
+ "domain" => "snmp1",
197
+ "path" => "/twitter/tweet/1"
198
+ },
199
+ "@timestamp" => 2021-05-28T23:32:38.222Z,
200
+ "host" => {
201
+ "ip" => "127.0.0.1"
202
+ },
203
+ "message" => "hello",
204
+ }
205
+ -----
206
+
207
+ [id="plugins-{type}s-{plugin}-host"]
208
+ ===== `host`
209
+
210
+ * Value type is <<string,string>>
211
+ * Default value is `"0.0.0.0"`
212
+
213
+ The host or ip to bind
214
+
215
+ [id="plugins-{type}s-{plugin}-keystore"]
216
+ ===== `keystore`
217
+
218
+ * Value type is <<path,path>>
219
+ * There is no default value for this setting.
220
+ * This option is deprecated
221
+
222
+ The JKS keystore to validate the client's certificates
223
+
224
+ Note: This option is deprecated and it will be removed in the next major version of Logstash.
225
+ Use `ssl_certificate` and `ssl_key` instead.
226
+
227
+ [id="plugins-{type}s-{plugin}-keystore_password"]
228
+ ===== `keystore_password`
229
+
230
+ * Value type is <<password,password>>
231
+ * There is no default value for this setting.
232
+ * This option is deprecated
233
+
234
+ Set the truststore password
235
+
236
+ Note: This option is deprecated and it will be removed in the next major version of Logstash.
237
+ Use `ssl_certificate` and `ssl_key` instead.
238
+
239
+ [id="plugins-{type}s-{plugin}-password"]
240
+ ===== `password`
241
+
242
+ * Value type is <<password,password>>
243
+ * There is no default value for this setting.
244
+
245
+ Password for basic authorization
246
+
247
+ [id="plugins-{type}s-{plugin}-port"]
248
+ ===== `port`
249
+
250
+ * Value type is <<number,number>>
251
+ * Default value is `8080`
252
+
253
+ The TCP port to bind to
254
+
255
+ [id="plugins-{type}s-{plugin}-max_content_length"]
256
+ ===== `max_content_length`
257
+
258
+ * Value type is <<number,number>>
259
+ * Default value is 104857600
260
+
261
+ The max content of an HTTP request in bytes. It defaults to 100mb.
262
+
263
+ [id="plugins-{type}s-{plugin}-max_pending_requests"]
264
+ ===== `max_pending_requests`
265
+
266
+ * Value type is <<number,number>>
267
+ * Default value is 200
268
+
269
+ Maximum number of incoming requests to store in a temporary queue before being processed by worker threads.
270
+ If a request arrives and the queue is full a 429 response will be returned immediately.
271
+ This queue exists to deal with micro bursts of events and to improve overall throughput,
272
+ so it should be changed very carefully as it can lead to memory pressure and impact performance.
273
+ If you need to deal both periodic or unforeseen spikes in incoming requests consider enabling the
274
+ Persistent Queue for the logstash pipeline.
275
+
276
+ [id="plugins-{type}s-{plugin}-response_code"]
277
+ ===== `response_code`
278
+
279
+ * Value can be any of: 200, 201, 202, 204
280
+ * Default value is `200`
281
+
282
+ The HTTP return code if the request is processed successfully.
283
+
284
+ Other return codes may happen in the case of an error condition, such as
285
+ invalid credentials (401), internal errors (503) or backpressure (429).
286
+
287
+ If 204 (No Content) is set, the response body will not be sent in the response.
288
+
289
+ [id="plugins-{type}s-{plugin}-response_headers"]
290
+ ===== `response_headers`
291
+
292
+ * Value type is <<hash,hash>>
293
+ * Default value is `{"Content-Type"=>"text/plain"}`
294
+
295
+ specify a custom set of response headers
296
+
297
+ [id="plugins-{type}s-{plugin}-remote_host_target_field"]
298
+ ===== `remote_host_target_field`
299
+
300
+ * Value type is <<string,string>>
301
+ * Default value is `"host"` when ECS is disabled
302
+ * Default value is `[host][ip]` when ECS is enabled
303
+
304
+ specify a target field for the client host of the http request
305
+
306
+ [id="plugins-{type}s-{plugin}-request_headers_target_field"]
307
+ ===== `request_headers_target_field`
308
+
309
+ * Value type is <<string,string>>
310
+ * Default value is `"headers"` when ECS is disabled
311
+ * Default value is `[@metadata][http][header]` when ECS is enabled
312
+
313
+ specify target field for the client host of the http request
314
+
315
+ [id="plugins-{type}s-{plugin}-ssl"]
316
+ ===== `ssl`
317
+
318
+ * Value type is <<boolean,boolean>>
319
+ * Default value is `false`
320
+
321
+ Events are by default sent in plain text. You can
322
+ enable encryption by setting `ssl` to true and configuring
323
+ the `ssl_certificate` and `ssl_key` options.
324
+
325
+ [id="plugins-{type}s-{plugin}-ssl_certificate"]
326
+ ===== `ssl_certificate`
327
+
328
+ * Value type is <<path,path>>
329
+ * There is no default value for this setting.
330
+
331
+ SSL certificate to use.
332
+
333
+ [id="plugins-{type}s-{plugin}-ssl_certificate_authorities"]
334
+ ===== `ssl_certificate_authorities`
335
+
336
+ * Value type is <<array,array>>
337
+ * Default value is `[]`
338
+
339
+ Validate client certificates against these authorities.
340
+ You can define multiple files or paths. All the certificates will
341
+ be read and added to the trust store. You need to configure the `ssl_verify_mode`
342
+ to `peer` or `force_peer` to enable the verification.
343
+
344
+
345
+ [id="plugins-{type}s-{plugin}-ssl_handshake_timeout"]
346
+ ===== `ssl_handshake_timeout`
347
+
348
+ * Value type is <<number,number>>
349
+ * Default value is `10000`
350
+
351
+ Time in milliseconds for an incomplete ssl handshake to timeout
352
+
353
+ [id="plugins-{type}s-{plugin}-ssl_key"]
354
+ ===== `ssl_key`
355
+
356
+ * Value type is <<path,path>>
357
+ * There is no default value for this setting.
358
+
359
+ SSL key to use.
360
+ NOTE: This key need to be in the PKCS8 format, you can convert it with https://www.openssl.org/docs/man1.1.0/apps/pkcs8.html[OpenSSL]
361
+ for more information.
362
+
363
+ [id="plugins-{type}s-{plugin}-ssl_key_passphrase"]
364
+ ===== `ssl_key_passphrase`
365
+
366
+ * Value type is <<password,password>>
367
+ * There is no default value for this setting.
368
+
369
+ SSL key passphrase to use.
370
+
371
+ [id="plugins-{type}s-{plugin}-ssl_verify_mode"]
372
+ ===== `ssl_verify_mode`
373
+
374
+ * Value can be any of: `none`, `peer`, `force_peer`
375
+ * Default value is `"none"`
376
+
377
+ By default the server doesn't do any client verification.
378
+
379
+ `peer` will make the server ask the client to provide a certificate.
380
+ If the client provides a certificate, it will be validated.
381
+
382
+ `force_peer` will make the server ask the client to provide a certificate.
383
+ If the client doesn't provide a certificate, the connection will be closed.
384
+
385
+ This option needs to be used with `ssl_certificate_authorities` and a defined list of CAs.
386
+
387
+ [id="plugins-{type}s-{plugin}-threads"]
388
+ ===== `threads`
389
+
390
+ * Value type is <<number,number>>
391
+ * Default value is number of processors
392
+
393
+ Number of threads to use for both accepting connections and handling requests
394
+
395
+ [id="plugins-{type}s-{plugin}-tls_max_version"]
396
+ ===== `tls_max_version`
397
+
398
+ * Value type is <<number,number>>
399
+ * Default value is `1.2`
400
+
401
+ The maximum TLS version allowed for the encrypted connections. The value must be the one of the following:
402
+ 1.0 for TLS 1.0, 1.1 for TLS 1.1, 1.2 for TLS 1.2
403
+
404
+ [id="plugins-{type}s-{plugin}-tls_min_version"]
405
+ ===== `tls_min_version`
406
+
407
+ * Value type is <<number,number>>
408
+ * Default value is `1`
409
+
410
+ The minimum TLS version allowed for the encrypted connections. The value must be one of the following:
411
+ 1.0 for TLS 1.0, 1.1 for TLS 1.1, 1.2 for TLS 1.2
412
+
413
+ [id="plugins-{type}s-{plugin}-user"]
414
+ ===== `user`
415
+
416
+ * Value type is <<string,string>>
417
+ * There is no default value for this setting.
418
+
419
+ Username for basic authorization
420
+
421
+ [id="plugins-{type}s-{plugin}-verify_mode"]
422
+ ===== `verify_mode`
423
+
424
+ * Value can be any of: `none`, `peer`, `force_peer`
425
+ * Default value is `"none"`
426
+ * This option is deprecated
427
+
428
+ Set the client certificate verification method. Valid methods: none, peer, force_peer
429
+
430
+ Note: This option is deprecated and it will be removed in the next major version of Logstash.
431
+ Use `ssl_verify_mode` instead.
432
+
433
+
434
+ [id="plugins-{type}s-{plugin}-common-options"]
435
+ include::{include_path}/{type}.asciidoc[]
436
+
437
+ :default_codec!:
@@ -0,0 +1,6 @@
1
+ # AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
2
+
3
+ require 'jar_dependencies'
4
+ require_jar('io.netty', 'netty-all', '4.1.65.Final')
5
+ require_jar('org.apache.logging.log4j', 'log4j-api', '2.11.1')
6
+ require_jar('org.logstash.plugins.input.http_bold', 'logstash-input-http_bold', '3.4.1')
@@ -0,0 +1,6 @@
1
+ # AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
2
+
3
+ require 'jar_dependencies'
4
+ require_jar('io.netty', 'netty-all', '4.1.65.Final')
5
+ require_jar('org.apache.logging.log4j', 'log4j-api', '2.11.1')
6
+ require_jar('org.logstash.plugins.input.http', 'logstash-input-http', '3.4.1')