logstash-filter-memcached 1.0.2 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/CONTRIBUTORS +2 -1
- data/LICENSE +200 -9
- data/README.md +1 -1
- data/lib/logstash/filters/memcached.rb +71 -26
- data/logstash-filter-memcached.gemspec +5 -5
- data/spec/filters/memcached_spec.rb +112 -49
- metadata +8 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0f1f2515f5a21a93db4453ea7bb592250857b47cd96e8932ea413bea82c23f6a
|
4
|
+
data.tar.gz: 8712fd59ba85e32b97e6148595a83961208ed3bc2fc4a79a6e74b47c711594a8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7c827e902ee464b47b90ec977b3bc08542c0344aeeab4310ba036ec765c43e224f355cc0a198e284adf96cad228e30f1ce14a4181eb80d3b327b022811eec294
|
7
|
+
data.tar.gz: 92b386d854d7ec592fbe4ec3edb764b08c109f26131245a95438ce4776558b7b082a8f89140f604633dc403073430e42fb0c47abf46687037a7d95196666f4fe
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,9 @@
|
|
1
|
+
## 1.2.0
|
2
|
+
- Upgrade Dalli to 3.x [#33](https://github.com/logstash-plugins/logstash-filter-memcached/pull/33)
|
3
|
+
|
4
|
+
## 1.1.0
|
5
|
+
- Added better exception handling [#25](https://github.com/logstash-plugins/logstash-filter-memcached/pull/25)
|
6
|
+
|
1
7
|
## 1.0.2
|
2
8
|
- Fixed issue with ttl not being set [#13](https://github.com/logstash-plugins/logstash-filter-memcached/pull/13)
|
3
9
|
|
data/CONTRIBUTORS
CHANGED
@@ -2,7 +2,8 @@ The following is a list of people who have contributed ideas, code, bug
|
|
2
2
|
reports, or in general have helped logstash along its way.
|
3
3
|
|
4
4
|
Contributors:
|
5
|
-
* Ry Biesemeyer
|
5
|
+
* Ry Biesemeyer (yaauie)
|
6
|
+
* Colin Surprenant (colinsurprenant)
|
6
7
|
|
7
8
|
Note: If you've sent us patches, bug reports, or otherwise contributed to
|
8
9
|
Logstash, and you aren't on the list above and want to be, please let us know
|
data/LICENSE
CHANGED
@@ -1,11 +1,202 @@
|
|
1
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
2
|
-
you may not use this file except in compliance with the License.
|
3
|
-
You may obtain a copy of the License at
|
4
1
|
|
5
|
-
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
6
5
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
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
|
-
[![Travis Build Status](https://travis-ci.
|
3
|
+
[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-memcached.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-memcached)
|
4
4
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
6
|
|
@@ -1,6 +1,7 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
require "logstash/filters/base"
|
3
3
|
require "logstash/namespace"
|
4
|
+
require 'dalli'
|
4
5
|
|
5
6
|
# This filter provides facilities to interact with Memcached.
|
6
7
|
class LogStash::Filters::Memcached < LogStash::Filters::Base
|
@@ -67,28 +68,59 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
|
|
67
68
|
# NOTE: in Memcached, a value of 0 (default) means "never expire"
|
68
69
|
config :ttl, :validate => :number, :default => 0
|
69
70
|
|
71
|
+
# Tags the event on failure. This can be used in later analysis.
|
72
|
+
config :tag_on_failure, :validate => :string, :default => "_memcached_failure"
|
73
|
+
|
70
74
|
public
|
71
75
|
|
72
76
|
attr_reader :cache
|
73
77
|
|
74
78
|
def register
|
75
|
-
if @ttl < 0
|
76
|
-
|
77
|
-
|
79
|
+
raise(LogStash::ConfigurationError, "'ttl' option cannot be negative") if @ttl < 0
|
80
|
+
|
81
|
+
@memcached_hosts = validate_connection_hosts
|
82
|
+
@memcached_options = validate_connection_options
|
83
|
+
begin
|
84
|
+
@cache = new_connection(@memcached_hosts, @memcached_options)
|
85
|
+
rescue => e
|
86
|
+
logger.error("failed to connect to memcached", hosts: @memcached_hosts, options: @memcached_options, message: e.message)
|
87
|
+
fail("failed to connect to memcached")
|
78
88
|
end
|
79
|
-
|
80
|
-
@
|
81
|
-
end
|
89
|
+
@connected = Concurrent::AtomicBoolean.new(true)
|
90
|
+
@connection_mutex = Mutex.new
|
91
|
+
end
|
82
92
|
|
83
93
|
def filter(event)
|
84
|
-
|
85
|
-
|
94
|
+
unless connection_available?
|
95
|
+
event.tag(@tag_on_failure)
|
96
|
+
return
|
97
|
+
end
|
86
98
|
|
87
|
-
|
88
|
-
|
99
|
+
begin
|
100
|
+
set_success = do_set(event)
|
101
|
+
get_success = do_get(event)
|
102
|
+
filter_matched(event) if (set_success || get_success)
|
103
|
+
rescue Dalli::NetworkError, Dalli::RingError => e
|
104
|
+
event.tag(@tag_on_failure)
|
105
|
+
logger.error("memcached communication error", hosts: @memcached_hosts, options: @memcached_options, message: e.message)
|
106
|
+
close
|
107
|
+
rescue => e
|
108
|
+
meta = { :message => e.message }
|
109
|
+
meta[:backtrace] = e.backtrace if logger.debug?
|
110
|
+
logger.error("unexpected error", meta)
|
111
|
+
event.tag(@tag_on_failure)
|
112
|
+
end
|
113
|
+
end
|
89
114
|
|
90
115
|
def close
|
91
|
-
|
116
|
+
@connection_mutex.synchronize do
|
117
|
+
@connected.make_false
|
118
|
+
cache.close
|
119
|
+
end
|
120
|
+
rescue => e
|
121
|
+
# we basically ignore any error here as we may be trying to close an invalid
|
122
|
+
# connection or if we close on shutdown we can also ignore any error
|
123
|
+
logger.debug("error closing memcached connection", :message => e.message)
|
92
124
|
end
|
93
125
|
|
94
126
|
private
|
@@ -141,19 +173,33 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
|
|
141
173
|
return true
|
142
174
|
end
|
143
175
|
|
144
|
-
def
|
145
|
-
require 'dalli'
|
146
|
-
|
147
|
-
hosts = validate_connection_hosts
|
148
|
-
options = validate_connection_options
|
176
|
+
def new_connection(hosts, options)
|
149
177
|
logger.debug('connecting to memcached', context(hosts: hosts, options: options))
|
150
|
-
Dalli::Client.new(
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
178
|
+
Dalli::Client.new(hosts, options).tap { |client| client.alive! }
|
179
|
+
end
|
180
|
+
|
181
|
+
# reconnect is not thread safe
|
182
|
+
def reconnect(hosts, options)
|
183
|
+
begin
|
184
|
+
@cache = new_connection(hosts, options)
|
185
|
+
@connected.make_true
|
186
|
+
rescue => e
|
187
|
+
logger.error("failed to reconnect to memcached", hosts: hosts, options: options, message: e.message)
|
188
|
+
@connected.make_false
|
189
|
+
end
|
190
|
+
return @connected.value
|
191
|
+
end
|
192
|
+
|
193
|
+
def connection_available?
|
194
|
+
# this method is called at every #filter method invocation and to minimize synchronization cost
|
195
|
+
# only @connected if fist check. The tradeoff is that another worker connection could be in the
|
196
|
+
# process of failing and @connected will not yet reflect that but this is acceptable for performance reason.
|
197
|
+
return true if @connected.true?
|
198
|
+
|
199
|
+
@connection_mutex.synchronize do
|
200
|
+
# the reconnection process is exclusive and will not be be concurrently performed in another worker
|
201
|
+
# by re-verifying the state of @connected from the exclusive code.
|
202
|
+
return @connected.true? ? true : reconnect(@memcached_hosts, @memcached_options)
|
157
203
|
end
|
158
204
|
end
|
159
205
|
|
@@ -165,8 +211,7 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
|
|
165
211
|
end
|
166
212
|
|
167
213
|
def validate_connection_hosts
|
168
|
-
|
169
|
-
|
214
|
+
raise(LogStash::ConfigurationError, "'hosts' cannot be empty") if @hosts.empty?
|
170
215
|
@hosts.map(&:to_s)
|
171
216
|
end
|
172
217
|
|
@@ -178,4 +223,4 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
|
|
178
223
|
|
179
224
|
@plugin_context.merge(hash)
|
180
225
|
end
|
181
|
-
end
|
226
|
+
end
|
@@ -1,11 +1,11 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
s.name = 'logstash-filter-memcached'
|
3
|
-
s.version = '1.0
|
3
|
+
s.version = '1.2.0'
|
4
4
|
s.licenses = ['Apache-2.0']
|
5
5
|
s.summary = 'A Logstash filter plugin for interacting with memcached'
|
6
|
-
s.
|
7
|
-
s.
|
8
|
-
s.
|
6
|
+
s.authors = ["Elastic"]
|
7
|
+
s.email = 'info@elastic.co'
|
8
|
+
s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
|
9
9
|
s.require_paths = ['lib']
|
10
10
|
|
11
11
|
# Files
|
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
|
|
18
18
|
|
19
19
|
# Gem dependencies
|
20
20
|
s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
|
21
|
-
s.add_runtime_dependency "dalli", "~>
|
21
|
+
s.add_runtime_dependency "dalli", "~> 3"
|
22
22
|
s.add_development_dependency 'logstash-devutils'
|
23
23
|
end
|
@@ -7,87 +7,150 @@ LogStash::Logging::Logger::configure_logging("TRACE")
|
|
7
7
|
describe LogStash::Filters::Memcached do
|
8
8
|
subject(:memcached_filter) { described_class.new(config) }
|
9
9
|
let(:cache) { double('memcached') }
|
10
|
-
before(:each) do
|
11
|
-
allow(memcached_filter).to receive(:establish_connection).and_return(cache)
|
12
|
-
allow(memcached_filter).to receive(:close)
|
13
|
-
memcached_filter.register
|
14
|
-
end
|
15
|
-
|
16
|
-
after(:each) do
|
17
|
-
memcached_filter.close
|
18
|
-
end
|
19
10
|
|
20
|
-
describe "
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
"get" => { "success/%{success}/answer" => "[ultimate][answer]" }
|
26
|
-
}
|
11
|
+
describe "a well behaved memcached server" do
|
12
|
+
before(:each) do
|
13
|
+
allow(memcached_filter).to receive(:new_connection).and_return(cache)
|
14
|
+
allow(memcached_filter).to receive(:close)
|
15
|
+
memcached_filter.register
|
27
16
|
end
|
28
|
-
let(:data) { { "success" => "true" } }
|
29
17
|
|
30
|
-
|
31
|
-
|
32
|
-
expect(memcached_filter).to receive(:filter_matched)
|
33
|
-
memcached_filter.filter(event)
|
34
|
-
expect(event.get("ultimate")).to eq("answer" => "42")
|
18
|
+
after(:each) do
|
19
|
+
memcached_filter.close
|
35
20
|
end
|
36
21
|
|
37
|
-
|
38
|
-
|
39
|
-
|
22
|
+
describe "#get" do
|
23
|
+
let(:event) { ::LogStash::Event.new(data) }
|
24
|
+
let(:config) do
|
25
|
+
{
|
26
|
+
"hosts" => ["localhost:11211"],
|
27
|
+
"get" => { "success/%{success}/answer" => "[ultimate][answer]" }
|
28
|
+
}
|
40
29
|
end
|
30
|
+
let(:data) { { "success" => "true" } }
|
41
31
|
|
42
|
-
it
|
43
|
-
expect(
|
32
|
+
it "retrieves data from memcache" do
|
33
|
+
expect(cache).to receive(:get_multi).with(["success/true/answer"]).and_return({"success/true/answer" => "42"})
|
34
|
+
expect(memcached_filter).to receive(:filter_matched)
|
44
35
|
memcached_filter.filter(event)
|
36
|
+
expect(event.get("ultimate")).to eq("answer" => "42")
|
45
37
|
end
|
46
38
|
|
47
|
-
|
48
|
-
|
49
|
-
|
39
|
+
context 'when memcached does not hold the value' do
|
40
|
+
before do
|
41
|
+
expect(cache).to receive(:get_multi).with(["success/true/answer"]).and_return({"success/true/answer" => nil})
|
42
|
+
end
|
43
|
+
|
44
|
+
it 'does not invoke `filter_matched`' do
|
45
|
+
expect(memcached_filter).to_not receive(:filter_matched)
|
46
|
+
memcached_filter.filter(event)
|
47
|
+
end
|
48
|
+
|
49
|
+
it 'does not populate the value' do
|
50
|
+
memcached_filter.filter(event)
|
51
|
+
expect(event.include?("ultimate")).to be false
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
describe "#set" do
|
57
|
+
let(:event) { ::LogStash::Event.new(data) }
|
58
|
+
let(:config) do
|
59
|
+
{
|
60
|
+
"hosts" => ["localhost:11211"],
|
61
|
+
"set" => { "[answer]" => "success/%{success}/answer" },
|
62
|
+
}
|
63
|
+
end
|
64
|
+
before(:each) do
|
65
|
+
allow(cache).to receive(:multi) {|&b| b.call }
|
66
|
+
allow(cache).to receive(:set)
|
67
|
+
end
|
68
|
+
|
69
|
+
context 'when the event includes the value to set' do
|
70
|
+
let(:data) { { "answer" => "42", "success" => "true" } }
|
71
|
+
|
72
|
+
it "sets data on memcached" do
|
73
|
+
expect(cache).to receive(:set).with("success/true/answer", "42")
|
74
|
+
memcached_filter.filter(event)
|
75
|
+
end
|
76
|
+
|
77
|
+
it 'invokes `filter_matched`' do
|
78
|
+
expect(memcached_filter).to receive(:filter_matched)
|
79
|
+
memcached_filter.filter(event)
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
context 'when the event does not include the value being set' do
|
84
|
+
let(:data) { { "success" => "true" } }
|
85
|
+
|
86
|
+
it 'does not set data on memcached' do
|
87
|
+
expect(cache).to_not receive(:set)
|
88
|
+
memcached_filter.filter(event)
|
89
|
+
end
|
90
|
+
|
91
|
+
it 'does not invoke `filter_matched`' do
|
92
|
+
expect(memcached_filter).to_not receive(:filter_matched)
|
93
|
+
memcached_filter.filter(event)
|
94
|
+
end
|
50
95
|
end
|
51
96
|
end
|
52
97
|
end
|
53
98
|
|
54
|
-
describe "
|
55
|
-
let(:event) { ::LogStash::Event.new(data) }
|
99
|
+
describe "a misbehaved memcached server" do
|
56
100
|
let(:config) do
|
57
101
|
{
|
58
102
|
"hosts" => ["localhost:11211"],
|
103
|
+
"get" => { "success/%{success}/answer" => "[ultimate][answer]" },
|
59
104
|
"set" => { "[answer]" => "success/%{success}/answer" },
|
60
105
|
}
|
61
106
|
end
|
62
|
-
|
63
|
-
|
64
|
-
|
107
|
+
|
108
|
+
context "#register" do
|
109
|
+
it "raises error upon new connection error" do
|
110
|
+
allow(memcached_filter).to receive(:new_connection).and_raise("some error")
|
111
|
+
expect{memcached_filter.register}.to raise_error(RuntimeError)
|
112
|
+
end
|
65
113
|
end
|
66
114
|
|
67
|
-
context
|
115
|
+
context "#get and #set" do
|
116
|
+
let(:event) { ::LogStash::Event.new(data) }
|
68
117
|
let(:data) { { "answer" => "42", "success" => "true" } }
|
69
118
|
|
70
|
-
|
71
|
-
|
72
|
-
|
119
|
+
before(:each) do
|
120
|
+
allow(memcached_filter).to receive(:new_connection).and_return(cache)
|
121
|
+
allow(cache).to receive(:close).and_raise("some error")
|
122
|
+
|
123
|
+
memcached_filter.register
|
73
124
|
end
|
74
125
|
|
75
|
-
|
76
|
-
|
77
|
-
memcached_filter.filter(event)
|
126
|
+
after(:each) do
|
127
|
+
memcached_filter.close
|
78
128
|
end
|
79
|
-
end
|
80
129
|
|
81
|
-
|
82
|
-
|
130
|
+
it "fails #get and tag" do
|
131
|
+
allow(cache).to receive(:multi) { |&b| b.call }
|
132
|
+
allow(cache).to receive(:set).with("success/true/answer", "42")
|
133
|
+
expect(cache).to receive(:get_multi).with(["success/true/answer"]).and_raise(Dalli::RingError.new("foo"))
|
134
|
+
expect(memcached_filter).not_to receive(:filter_matched)
|
135
|
+
memcached_filter.filter(event)
|
136
|
+
expect(event.get("tags")).to eq(["_memcached_failure"])
|
137
|
+
end
|
83
138
|
|
84
|
-
it
|
85
|
-
|
139
|
+
it "fails #set and tag" do
|
140
|
+
allow(cache).to receive(:get_multi).with(["success/true/answer"]).and_return({"success/true/answer" => "42"})
|
141
|
+
allow(cache).to receive(:multi) { |&b| b.call }
|
142
|
+
expect(cache).to receive(:set).with("success/true/answer", "42").and_raise(Dalli::RingError.new("foo"))
|
143
|
+
expect(memcached_filter).not_to receive(:filter_matched)
|
86
144
|
memcached_filter.filter(event)
|
145
|
+
expect(event.get("tags")).to eq(["_memcached_failure"])
|
87
146
|
end
|
88
147
|
|
89
|
-
it
|
90
|
-
|
148
|
+
it "reconnects after a failure" do
|
149
|
+
allow(memcached_filter).to receive(:do_get).and_raise(Dalli::RingError.new("foo"))
|
150
|
+
allow(memcached_filter).to receive(:do_set).and_raise(Dalli::RingError.new("foo"))
|
151
|
+
|
152
|
+
expect(memcached_filter).to receive(:new_connection).once.and_raise("foo")
|
153
|
+
memcached_filter.filter(event)
|
91
154
|
memcached_filter.filter(event)
|
92
155
|
end
|
93
156
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-filter-memcached
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0
|
4
|
+
version: 1.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: 2023-01-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
requirements:
|
30
30
|
- - "~>"
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: '
|
32
|
+
version: '3'
|
33
33
|
name: dalli
|
34
34
|
prerelease: false
|
35
35
|
type: :runtime
|
@@ -37,7 +37,7 @@ dependencies:
|
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '
|
40
|
+
version: '3'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
requirement: !ruby/object:Gem::Requirement
|
43
43
|
requirements:
|
@@ -53,7 +53,7 @@ dependencies:
|
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '0'
|
55
55
|
description:
|
56
|
-
email:
|
56
|
+
email: info@elastic.co
|
57
57
|
executables: []
|
58
58
|
extensions: []
|
59
59
|
extra_rdoc_files: []
|
@@ -68,7 +68,7 @@ files:
|
|
68
68
|
- logstash-filter-memcached.gemspec
|
69
69
|
- spec/filters/memcached_spec.rb
|
70
70
|
- spec/spec_helper.rb
|
71
|
-
homepage:
|
71
|
+
homepage: http://www.elastic.co/guide/en/logstash/current/index.html
|
72
72
|
licenses:
|
73
73
|
- Apache-2.0
|
74
74
|
metadata:
|
@@ -89,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
89
89
|
- !ruby/object:Gem::Version
|
90
90
|
version: '0'
|
91
91
|
requirements: []
|
92
|
-
|
93
|
-
rubygems_version: 2.6.13
|
92
|
+
rubygems_version: 3.1.6
|
94
93
|
signing_key:
|
95
94
|
specification_version: 4
|
96
95
|
summary: A Logstash filter plugin for interacting with memcached
|