logstash-output-udp 3.0.4 → 3.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +13 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +31 -5
- data/lib/logstash/outputs/udp.rb +51 -8
- data/logstash-output-udp.gemspec +2 -2
- data/spec/outputs/udp_spec.rb +111 -5
- metadata +10 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: b3988df4d07ed849b41de584e2c9e6b37edc51d002b773ad1cc9719e71ed7f9f
|
|
4
|
+
data.tar.gz: 5ee9f9e3d85b0640a5fe9986950e68a07901c6252073fe3c9b2034a8e0793bbd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 842bb5c01a12602223e3e9778f756e6a25a9505a9e8c61d79b99aa801497ae990d5e241d6051ba79e9e4c3cb0b0871ff455d635f10d97946c4328ffd0fee2d3a
|
|
7
|
+
data.tar.gz: 9250a7c4cecbafc3a1c8c36fd15c62c8a24bbebb38479f397dc2837b07f6860cc4ec391c7a4244caff2301d9a82a9f443d72d7b226eb18c87869208fbed98fa4
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
## 3.2.0
|
|
2
|
+
- Added field reference support in `port` [#13](https://github.com/logstash-plugins/logstash-output-udp/pull/13)
|
|
3
|
+
|
|
4
|
+
## 3.1.0
|
|
5
|
+
- Fixed plugin crash upon socket write exception [#10](https://github.com/logstash-plugins/logstash-output-udp/pull/10)
|
|
6
|
+
- Added support for the 'retry_count' and 'retry_backoff_ms' options [#12](https://github.com/logstash-plugins/logstash-output-udp/pull/12)
|
|
7
|
+
|
|
8
|
+
## 3.0.6
|
|
9
|
+
- Docs: Set the default_codec doc attribute.
|
|
10
|
+
|
|
11
|
+
## 3.0.5
|
|
12
|
+
- Update gemspec summary
|
|
13
|
+
|
|
1
14
|
## 3.0.4
|
|
2
15
|
- Fix some documentation issues
|
|
3
16
|
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2020 Elastic and contributors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Logstash Plugin
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.com/logstash-plugins/logstash-output-udp)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
:plugin: udp
|
|
2
2
|
:type: output
|
|
3
|
+
:default_codec: json
|
|
3
4
|
|
|
4
5
|
///////////////////////////////////////////
|
|
5
6
|
START - GENERATED VARIABLES, DO NOT EDIT!
|
|
@@ -22,7 +23,14 @@ include::{include_path}/plugin_header.asciidoc[]
|
|
|
22
23
|
|
|
23
24
|
Send events over UDP
|
|
24
25
|
|
|
25
|
-
Keep in mind that UDP
|
|
26
|
+
Keep in mind that UDP does not provide delivery or duplicate protection guarantees.
|
|
27
|
+
Even when this plugin succeeds at writing to the UDP socket, there is no guarantee that
|
|
28
|
+
the recipient will receive exactly one copy of the event.
|
|
29
|
+
|
|
30
|
+
When this plugin fails to write to the UDP socket, by default the event will be dropped
|
|
31
|
+
and the error message will be logged. The <<plugins-{type}s-{plugin}-retry_count>> option
|
|
32
|
+
in conjunction with the <<plugins-{type}s-{plugin}-retry_backoff_ms>> option can be used
|
|
33
|
+
to retry a failed write for a number of times before dropping the event.
|
|
26
34
|
|
|
27
35
|
[id="plugins-{type}s-{plugin}-options"]
|
|
28
36
|
==== Udp Output Configuration Options
|
|
@@ -33,7 +41,9 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
|
33
41
|
|=======================================================================
|
|
34
42
|
|Setting |Input type|Required
|
|
35
43
|
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
|
|
36
|
-
| <<plugins-{type}s-{plugin}-port>> |<<
|
|
44
|
+
| <<plugins-{type}s-{plugin}-port>> |<<string,string>>|Yes
|
|
45
|
+
| <<plugins-{type}s-{plugin}-retry_count>> |<<number,number>>|No
|
|
46
|
+
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
|
|
37
47
|
|=======================================================================
|
|
38
48
|
|
|
39
49
|
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
|
@@ -54,12 +64,28 @@ The address to send messages to
|
|
|
54
64
|
===== `port`
|
|
55
65
|
|
|
56
66
|
* This is a required setting.
|
|
57
|
-
* Value type is <<
|
|
67
|
+
* Value type is <<string,string>>
|
|
58
68
|
* There is no default value for this setting.
|
|
59
69
|
|
|
60
|
-
The port to send messages on
|
|
70
|
+
The port to send messages on. This can be dynamic using the `%{[target][port]}` syntax.
|
|
71
|
+
|
|
72
|
+
[id="plugins-{type}s-{plugin}-retry_count"]
|
|
73
|
+
===== `retry_count`
|
|
74
|
+
|
|
75
|
+
* Value type is <<number,number>>
|
|
76
|
+
* Default value is `0`
|
|
61
77
|
|
|
78
|
+
The number of times to retry a failed UPD socket write
|
|
62
79
|
|
|
80
|
+
[id="plugins-{type}s-{plugin}-retry_backoff_ms"]
|
|
81
|
+
===== `retry_backoff_ms`
|
|
82
|
+
|
|
83
|
+
* Value type is <<number,number>>
|
|
84
|
+
* Default value is `10`
|
|
85
|
+
|
|
86
|
+
The amount of time to wait in milliseconds before attempting to retry a failed UPD socket write
|
|
63
87
|
|
|
64
88
|
[id="plugins-{type}s-{plugin}-common-options"]
|
|
65
|
-
include::{include_path}/{type}.asciidoc[]
|
|
89
|
+
include::{include_path}/{type}.asciidoc[]
|
|
90
|
+
|
|
91
|
+
:default_codec!:
|
data/lib/logstash/outputs/udp.rb
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# encoding: utf-8
|
|
2
|
+
require "socket"
|
|
2
3
|
require "logstash/outputs/base"
|
|
3
4
|
require "logstash/namespace"
|
|
4
|
-
require "socket"
|
|
5
5
|
|
|
6
6
|
# Send events over UDP
|
|
7
7
|
#
|
|
8
|
-
# Keep in mind that UDP
|
|
8
|
+
# Keep in mind that UDP is a lossy protocol
|
|
9
9
|
class LogStash::Outputs::UDP < LogStash::Outputs::Base
|
|
10
|
+
|
|
10
11
|
config_name "udp"
|
|
11
12
|
|
|
12
13
|
default :codec, "json"
|
|
@@ -15,20 +16,62 @@ class LogStash::Outputs::UDP < LogStash::Outputs::Base
|
|
|
15
16
|
config :host, :validate => :string, :required => true
|
|
16
17
|
|
|
17
18
|
# The port to send messages on
|
|
18
|
-
config :port, :validate => :
|
|
19
|
+
config :port, :validate => :string, :required => true
|
|
20
|
+
|
|
21
|
+
# The number of times to retry a failed UPD socket write
|
|
22
|
+
config :retry_count, :validate => :number, :default => 0
|
|
23
|
+
|
|
24
|
+
# The amount of time to wait in milliseconds before attempting to retry a failed UPD socket write
|
|
25
|
+
config :retry_backoff_ms, :validate => :number, :default => 100
|
|
19
26
|
|
|
20
|
-
public
|
|
21
27
|
def register
|
|
22
28
|
@socket = UDPSocket.new
|
|
29
|
+
|
|
23
30
|
@codec.on_event do |event, payload|
|
|
24
|
-
|
|
31
|
+
port = event.sprintf(@port)
|
|
32
|
+
begin
|
|
33
|
+
port = Integer(port)
|
|
34
|
+
rescue => e # ArgumentError (invalid value for Integer(): "foo")
|
|
35
|
+
logger.error("Failed to resolve port, dropping event", port: @port, event: event.to_hash, message: e.message)
|
|
36
|
+
else
|
|
37
|
+
socket_send(payload, port)
|
|
38
|
+
end
|
|
25
39
|
end
|
|
26
40
|
end
|
|
27
41
|
|
|
28
42
|
def receive(event)
|
|
29
|
-
|
|
30
|
-
return if event == LogStash::SHUTDOWN
|
|
31
43
|
@codec.encode(event)
|
|
32
44
|
end
|
|
33
45
|
|
|
34
|
-
|
|
46
|
+
private
|
|
47
|
+
|
|
48
|
+
def socket_send(payload, port)
|
|
49
|
+
send_count = 0
|
|
50
|
+
begin
|
|
51
|
+
send_count += 1
|
|
52
|
+
@socket.send(payload, 0, @host, port)
|
|
53
|
+
rescue Errno::EMSGSIZE => e
|
|
54
|
+
logger.error("Failed to send event, message size of #{payload.size} too long", error_hash(e, payload))
|
|
55
|
+
rescue => e
|
|
56
|
+
if @retry_count > 0 && send_count <= @retry_count
|
|
57
|
+
logger.warn("Failed to send event, retrying:", error_hash(e, payload, trace: false))
|
|
58
|
+
sleep(@retry_backoff_ms / 1000.0)
|
|
59
|
+
retry
|
|
60
|
+
else
|
|
61
|
+
logger.error("Failed to send event:", error_hash(e, payload))
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
MAX_DEBUG_PAYLOAD = 1000
|
|
67
|
+
|
|
68
|
+
def error_hash(error, payload, trace: true)
|
|
69
|
+
error_hash = { :message => error.message, :exception => error.class }
|
|
70
|
+
if logger.debug?
|
|
71
|
+
error_hash[:event_payload] =
|
|
72
|
+
payload.length > MAX_DEBUG_PAYLOAD ? "#{payload[0...MAX_DEBUG_PAYLOAD]}...<TRUNCATED>" : payload
|
|
73
|
+
end
|
|
74
|
+
error_hash[:backtrace] = error.backtrace if trace || logger.debug?
|
|
75
|
+
error_hash
|
|
76
|
+
end
|
|
77
|
+
end
|
data/logstash-output-udp.gemspec
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-output-udp'
|
|
4
|
-
s.version = '3.0
|
|
4
|
+
s.version = '3.2.0'
|
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
|
6
|
-
s.summary = "
|
|
6
|
+
s.summary = "Sends events over UDP"
|
|
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"
|
|
8
8
|
s.authors = ["Elastic"]
|
|
9
9
|
s.email = 'info@elastic.co'
|
data/spec/outputs/udp_spec.rb
CHANGED
|
@@ -3,18 +3,20 @@ require_relative "../spec_helper"
|
|
|
3
3
|
|
|
4
4
|
describe LogStash::Outputs::UDP do
|
|
5
5
|
|
|
6
|
+
subject { described_class.new(config) }
|
|
6
7
|
let(:host) { "localhost" }
|
|
7
8
|
let(:port) { rand(1024..65535) }
|
|
9
|
+
let(:config) {{ "host" => host, "port" => port}}
|
|
10
|
+
|
|
11
|
+
let(:logger) { subject.logger }
|
|
12
|
+
let(:socket) { subject.instance_variable_get("@socket") }
|
|
8
13
|
|
|
9
14
|
it "should register without errors" do
|
|
10
|
-
plugin = LogStash::Plugin.lookup("output", "udp").new(
|
|
15
|
+
plugin = LogStash::Plugin.lookup("output", "udp").new(config)
|
|
11
16
|
expect { plugin.register }.to_not raise_error
|
|
12
17
|
end
|
|
13
18
|
|
|
14
19
|
describe "#send" do
|
|
15
|
-
|
|
16
|
-
subject { LogStash::Outputs::UDP.new({"host" => host, "port" => port}) }
|
|
17
|
-
|
|
18
20
|
let(:properties) { { "message" => "This is a message!"} }
|
|
19
21
|
let(:event) { LogStash::Event.new(properties) }
|
|
20
22
|
|
|
@@ -23,8 +25,112 @@ describe LogStash::Outputs::UDP do
|
|
|
23
25
|
end
|
|
24
26
|
|
|
25
27
|
it "should receive the generated event" do
|
|
26
|
-
expect(
|
|
28
|
+
expect(socket).to receive(:send).with(kind_of(String), 0, host, port)
|
|
29
|
+
expect(logger).not_to receive(:error)
|
|
27
30
|
subject.receive(event)
|
|
28
31
|
end
|
|
29
32
|
end
|
|
33
|
+
|
|
34
|
+
describe "port" do
|
|
35
|
+
|
|
36
|
+
let(:config) { super().merge('port' => '%{[target_port]}') }
|
|
37
|
+
|
|
38
|
+
before do
|
|
39
|
+
subject.register
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
context 'valid' do
|
|
43
|
+
|
|
44
|
+
let(:event) { LogStash::Event.new('message' => 'Hey!', 'target_port' => '12345') }
|
|
45
|
+
|
|
46
|
+
before do
|
|
47
|
+
expect(socket).to receive(:send).with(kind_of(String), 0, host, 12345)
|
|
48
|
+
expect(logger).not_to receive(:error)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
it "should receive the event" do
|
|
52
|
+
subject.receive(event)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
context 'invalid' do
|
|
58
|
+
|
|
59
|
+
let(:event) { LogStash::Event.new('message' => 'Hey!', 'target_port' => 'bogus') }
|
|
60
|
+
|
|
61
|
+
before do
|
|
62
|
+
expect(socket).to_not receive(:send)
|
|
63
|
+
expect(logger).to receive(:error).with /Failed to resolve port, dropping event/,
|
|
64
|
+
hash_including(:message => "invalid value for Integer(): \"bogus\"")
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
it "should receive the event" do
|
|
68
|
+
subject.receive(event)
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
describe "retries" do
|
|
75
|
+
let(:event) { LogStash::Event.new("message" => "test") }
|
|
76
|
+
let(:config) {{ "host" => host, "port" => port}}
|
|
77
|
+
|
|
78
|
+
before(:each) do
|
|
79
|
+
subject.register
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
context "not using :retry_count" do
|
|
83
|
+
it "should not retry upon send exception by default" do
|
|
84
|
+
allow(socket).to receive(:send).once.and_raise(IOError)
|
|
85
|
+
expect(logger).to receive(:error).once
|
|
86
|
+
subject.receive(event)
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
context "using :retry_count" do
|
|
91
|
+
let(:backoff) { 10 }
|
|
92
|
+
let(:retry_count) { 5 }
|
|
93
|
+
let(:config) {{ "host" => host, "port" => port, "retry_count" => retry_count, "retry_backoff_ms" => backoff}}
|
|
94
|
+
|
|
95
|
+
it "should retry upon send exception" do
|
|
96
|
+
allow(socket).to receive(:send).exactly(retry_count + 1).times.and_raise(IOError)
|
|
97
|
+
expect(logger).to receive(:warn).exactly(retry_count).times
|
|
98
|
+
expect(logger).to receive(:error).once
|
|
99
|
+
expect(subject).to receive(:sleep).with(backoff / 1000.0).exactly(retry_count).times
|
|
100
|
+
subject.receive(event)
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
describe "large message" do
|
|
106
|
+
let(:properties) { { "message" => "0" * 65_536 } }
|
|
107
|
+
let(:event) { LogStash::Event.new(properties) }
|
|
108
|
+
|
|
109
|
+
before(:each) do
|
|
110
|
+
subject.register
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
it "should handle the error and log when an error is received" do
|
|
114
|
+
expect(logger).to receive(:error)
|
|
115
|
+
subject.receive(event)
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
it "should log a truncated payload with debug logging when an error is received and the message is too long" do
|
|
119
|
+
expect(logger).to receive(:debug?).and_return(true)
|
|
120
|
+
expect(logger).to receive(:error) do |_, hash|
|
|
121
|
+
expect(hash).to include(:event_payload)
|
|
122
|
+
expect(hash[:event_payload]).to include("TRUNCATED")
|
|
123
|
+
end
|
|
124
|
+
subject.receive(event)
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
it "should not log a payload with debug logging when an error is received" do
|
|
128
|
+
expect(logger).to receive(:debug?).and_return(false)
|
|
129
|
+
expect(logger).to receive(:error) do |_, hash|
|
|
130
|
+
expect(hash).not_to include(:event_payload)
|
|
131
|
+
end
|
|
132
|
+
subject.receive(event)
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
end
|
|
30
136
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-output-udp
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0
|
|
4
|
+
version: 3.2.0
|
|
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: 2021-07-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -20,8 +20,8 @@ dependencies:
|
|
|
20
20
|
- !ruby/object:Gem::Version
|
|
21
21
|
version: '2.99'
|
|
22
22
|
name: logstash-core-plugin-api
|
|
23
|
-
prerelease: false
|
|
24
23
|
type: :runtime
|
|
24
|
+
prerelease: false
|
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
@@ -37,8 +37,8 @@ dependencies:
|
|
|
37
37
|
- !ruby/object:Gem::Version
|
|
38
38
|
version: '0'
|
|
39
39
|
name: logstash-codec-json
|
|
40
|
-
prerelease: false
|
|
41
40
|
type: :runtime
|
|
41
|
+
prerelease: false
|
|
42
42
|
version_requirements: !ruby/object:Gem::Requirement
|
|
43
43
|
requirements:
|
|
44
44
|
- - ">="
|
|
@@ -51,14 +51,16 @@ dependencies:
|
|
|
51
51
|
- !ruby/object:Gem::Version
|
|
52
52
|
version: '0'
|
|
53
53
|
name: logstash-devutils
|
|
54
|
-
prerelease: false
|
|
55
54
|
type: :development
|
|
55
|
+
prerelease: false
|
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
57
57
|
requirements:
|
|
58
58
|
- - ">="
|
|
59
59
|
- !ruby/object:Gem::Version
|
|
60
60
|
version: '0'
|
|
61
|
-
description: This gem is a Logstash plugin required to be installed on top of the
|
|
61
|
+
description: This gem is a Logstash plugin required to be installed on top of the
|
|
62
|
+
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
|
63
|
+
gem is not a stand-alone program
|
|
62
64
|
email: info@elastic.co
|
|
63
65
|
executables: []
|
|
64
66
|
extensions: []
|
|
@@ -96,11 +98,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
96
98
|
- !ruby/object:Gem::Version
|
|
97
99
|
version: '0'
|
|
98
100
|
requirements: []
|
|
99
|
-
|
|
100
|
-
rubygems_version: 2.4.8
|
|
101
|
+
rubygems_version: 3.0.6
|
|
101
102
|
signing_key:
|
|
102
103
|
specification_version: 4
|
|
103
|
-
summary:
|
|
104
|
+
summary: Sends events over UDP
|
|
104
105
|
test_files:
|
|
105
106
|
- spec/outputs/udp_spec.rb
|
|
106
107
|
- spec/spec_helper.rb
|