logstash-mixin-plugin_factory_support 1.0.0-java
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +2 -0
- data/LICENSE +202 -0
- data/README.md +71 -0
- data/lib/logstash/plugin_mixins/plugin_factory_support.rb +169 -0
- data/spec/logstash/plugin_mixins/plugin_factory_support_spec.rb +212 -0
- metadata +120 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6a19f100a0806291e455d660d61f70f10fc3973219cdf835db16889a556f4163
|
4
|
+
data.tar.gz: 599f15315a561ea8098eeab1785e67740824fa3998e2eea1e0237ffffa536f93
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: cccfe54b8e7af003484b58a04b2943f6e9419245dd9892c4e7c04afc88b9f86b0928bc35d7c0b253a725ac8e009426b215eeb069718f9d5b70b618394e411ff3
|
7
|
+
data.tar.gz: d998ce46bb6cc32ffc9ed6c6a92ae562842f196c241e665745674f004038ba8e0e27aea25cf4c55802ab6f5471b01aa03ef3dd5f9532b828688d1f45e85e8348
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,2 @@
|
|
1
|
+
## 1.0.0
|
2
|
+
- Support Mixin for ensuring a plugin has an `plugin_factory` method that returns a `PluginFactory` that can be used to instantiate wrapped plugins that maintain the pipeline execution context [#1](https://github.com/logstash-plugins/logstash-mixin-plugin_factory_support/pull/1)
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
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
ADDED
@@ -0,0 +1,71 @@
|
|
1
|
+
# Plugin Factory Support Mixin
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.com/logstash-plugins/logstash-mixin-plugin_factory_support.svg?branch=main)](https://travis-ci.com/logstash-plugins/logstash-mixin-plugin_factory_support)
|
4
|
+
|
5
|
+
This gem is a support adapter for Logstash plugins that can be used to ensure your plugin
|
6
|
+
has access to an api-stable Plugin Factory for instantiating inner plugins, even when run
|
7
|
+
on a Logstash version that does not provide a Plugin Factory.
|
8
|
+
|
9
|
+
Inner plugins generated by this factory will be fully-contextualized in the pipeline that
|
10
|
+
the outer plugin is running in, and when instantiated without an explicit `id` parameter,
|
11
|
+
a sensibly-descriptive distinct id will be generated.
|
12
|
+
|
13
|
+
## Usage (simple)
|
14
|
+
|
15
|
+
1. Add version `~>1.0` of this gem as a runtime dependency of your Logstash plugin's `gemspec`:
|
16
|
+
|
17
|
+
~~~ ruby
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
# ...
|
20
|
+
|
21
|
+
s.add_runtime_dependency 'logstash-mixin-plugin_factory_support', '~>1.0'
|
22
|
+
end
|
23
|
+
~~~
|
24
|
+
|
25
|
+
2. In your plugin code, require this library and include it into your plugin class
|
26
|
+
that already inherits `LogStash::Plugin`:
|
27
|
+
|
28
|
+
~~~ ruby
|
29
|
+
require 'logstash/plugin_mixins/plugin_factory_support'
|
30
|
+
|
31
|
+
class LogStash::Inputs::Foo < Logstash::Inputs::Base
|
32
|
+
include LogStash::PluginMixins::PluginFactorySupport
|
33
|
+
|
34
|
+
# ...
|
35
|
+
end
|
36
|
+
~~~
|
37
|
+
|
38
|
+
3. When instantiating other plugins from inside your plugin, _do not_ send `new`
|
39
|
+
to the plugin class directly. Instead use the `plugin_factory`
|
40
|
+
method to obtain a PluginFactory, and then use one of its `#input`, `#output`,
|
41
|
+
`#codec`, or `#filter` methods with your plugin's name to obtain a proxy for
|
42
|
+
the plugin class, and then send the proxy `#new` with your options as normal.
|
43
|
+
This will ensure that the inner plugin instance is properly bound to the pipeline
|
44
|
+
and execution context from the outer plugin.
|
45
|
+
|
46
|
+
~~~ ruby
|
47
|
+
def register
|
48
|
+
@internal_grok = plugin_factory.filter('grok').new("match" => {"message" => "^PATTERN"})
|
49
|
+
end
|
50
|
+
~~~
|
51
|
+
|
52
|
+
Expressed as a diff:
|
53
|
+
|
54
|
+
~~~ diff
|
55
|
+
def register
|
56
|
+
- @internal_grok = ::LogStash::Filter::Grok.new("match" => {"message" => "^PATTERN"})
|
57
|
+
+ @internal_grok = plugin_factory.filter('grok').new("match" => {"message" => "^PATTERN"})
|
58
|
+
end
|
59
|
+
|
60
|
+
~~~
|
61
|
+
|
62
|
+
Note: when instantiating an inner plugin with a plugin factory, managing its lifecycle remains
|
63
|
+
an implementation detail of the _outer_ plugin. Lifecycle events like `LogStash::Plugin#close`,
|
64
|
+
`LogStash::Inputs::Base#stop`, or `LogStash::Codecs::Base#flush` for the outer plugin are not
|
65
|
+
automatically propagated to the inner plugin.
|
66
|
+
|
67
|
+
## Development
|
68
|
+
|
69
|
+
This gem:
|
70
|
+
- *MUST* remain API-stable at 1.x
|
71
|
+
- *MUST NOT* introduce additional runtime dependencies
|
@@ -0,0 +1,169 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'java'
|
4
|
+
require 'thread'
|
5
|
+
|
6
|
+
require 'logstash/namespace'
|
7
|
+
require 'logstash/plugin'
|
8
|
+
|
9
|
+
module LogStash
|
10
|
+
module PluginMixins
|
11
|
+
##
|
12
|
+
# This `PluginFactorySupport` can be included in any `LogStash::Plugin`,
|
13
|
+
# and will ensure that the plugin provides an `plugin_factory` method that
|
14
|
+
# returns a factory for instantiating plugins with as much context as possible.
|
15
|
+
#
|
16
|
+
# When included into a Logstash plugin that already has a plugin factory (e.g.,
|
17
|
+
# when run on a Logstash release that provides a plugin factory),
|
18
|
+
# this adapter will _NOT_ override the existing implementation.
|
19
|
+
module PluginFactorySupport
|
20
|
+
|
21
|
+
##
|
22
|
+
# @api internal (use: `LogStash::Plugin::include`)
|
23
|
+
# @param base [Class]: a class that inherits `LogStash::Plugin`, typically one
|
24
|
+
# descending from one of the four plugin base classes
|
25
|
+
# (e.g., `LogStash::Inputs::Base`)
|
26
|
+
# @return [void]
|
27
|
+
def self.included(base)
|
28
|
+
fail(ArgumentError, "`#{base}` must inherit LogStash::Plugin") unless base < LogStash::Plugin
|
29
|
+
|
30
|
+
# If our base does not include an `plugin_factory`,
|
31
|
+
# prepend the legacy adapter to ensure it gets defined.
|
32
|
+
base.send(:prepend, LegacyAdapter) unless base.method_defined?(:plugin_factory)
|
33
|
+
end
|
34
|
+
|
35
|
+
##
|
36
|
+
# This `PluginFactorySupport` cannot be extended into an existing object.
|
37
|
+
# @api private
|
38
|
+
#
|
39
|
+
# @param base [Object]
|
40
|
+
# @raise [ArgumentError]
|
41
|
+
def self.extended(base)
|
42
|
+
fail(ArgumentError, "`#{self}` cannot be extended into an existing object.")
|
43
|
+
end
|
44
|
+
|
45
|
+
##
|
46
|
+
# Implements `plugin_factory` method, which returns a `PluginFactory`
|
47
|
+
#
|
48
|
+
# @api internal
|
49
|
+
module LegacyAdapter
|
50
|
+
|
51
|
+
##
|
52
|
+
# pre-initialize the sequence generator for id generation
|
53
|
+
def initialize(*a,&b)
|
54
|
+
@_pf_sequence_generator = SequenceGenerator.new
|
55
|
+
|
56
|
+
super
|
57
|
+
end
|
58
|
+
|
59
|
+
##
|
60
|
+
# @return [PluginFactory]
|
61
|
+
def plugin_factory
|
62
|
+
PluginFactory.new(self, @_pf_sequence_generator)
|
63
|
+
end
|
64
|
+
|
65
|
+
##
|
66
|
+
# A PluginFactory provides methods for retrieving plugin
|
67
|
+
# classes that can be initialized with a pre-determined ExecutionContext.
|
68
|
+
class PluginFactory
|
69
|
+
|
70
|
+
def initialize(outer_plugin, sequence_generator)
|
71
|
+
@outer_plugin = outer_plugin
|
72
|
+
@sequence_generator = sequence_generator
|
73
|
+
end
|
74
|
+
|
75
|
+
%i(
|
76
|
+
input
|
77
|
+
output
|
78
|
+
codec
|
79
|
+
filter
|
80
|
+
).each do |plugin_type|
|
81
|
+
define_method(plugin_type) do |plugin_name|
|
82
|
+
PluginClassProxy.new(self, plugin_type, plugin_name)
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
def execution_context
|
87
|
+
@outer_plugin.execution_context
|
88
|
+
end
|
89
|
+
|
90
|
+
def outer_plugin_id
|
91
|
+
@outer_plugin.id
|
92
|
+
end
|
93
|
+
|
94
|
+
def next_sequence_id
|
95
|
+
@sequence_generator.next
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
##
|
100
|
+
# A PluginClassProxy responds to `new` with a string-keyed params hash,
|
101
|
+
# and is a proxy for the ruby plugin class associated with its type and name.
|
102
|
+
class PluginClassProxy
|
103
|
+
|
104
|
+
include LogStash::Util::Loggable
|
105
|
+
|
106
|
+
def initialize(plugin_factory, plugin_type, plugin_name)
|
107
|
+
@plugin_type = plugin_type
|
108
|
+
@plugin_name = plugin_name
|
109
|
+
@plugin_factory = plugin_factory
|
110
|
+
end
|
111
|
+
|
112
|
+
##
|
113
|
+
# Creates an instance of the plugin using the provided parameters
|
114
|
+
# that has access to the factory's execution context.
|
115
|
+
#
|
116
|
+
# If an `id` is not explicitly provided, a sensible one will be generated
|
117
|
+
# indicating its relationship to the plugin in which it was instantiated.
|
118
|
+
#
|
119
|
+
# @param params [Hash{String=>Object}]
|
120
|
+
# @return [LogStash::Plugin]
|
121
|
+
def new(params={})
|
122
|
+
params_with_id = params.include?('id') ? params : params.merge('id' => generate_inner_id)
|
123
|
+
|
124
|
+
logger.debug("initializing inner #{@plugin_name} #{@plugin_type}",
|
125
|
+
:outer_plugin_id => @plugin_factory.outer_plugin_id,
|
126
|
+
:inner_plugin_id => params_with_id.fetch('id'))
|
127
|
+
|
128
|
+
initialize_contextualized_plugin(params_with_id)
|
129
|
+
end
|
130
|
+
|
131
|
+
private
|
132
|
+
|
133
|
+
# Reach into the logstash-internal Plugin::Contextualizer provided in Logstash 7.10+
|
134
|
+
# to instantiate the inner plugin with the factory's execution context.
|
135
|
+
def initialize_contextualized_plugin(params)
|
136
|
+
::LogStash::Plugins::Contextualizer.initialize_plugin(@plugin_factory.execution_context, plugin_class, params)
|
137
|
+
end
|
138
|
+
|
139
|
+
# Reach into the logstash-internal Plugin::lookup to find the inner plugin's class
|
140
|
+
# by type and name
|
141
|
+
def plugin_class
|
142
|
+
::LogStash::Plugin.lookup(@plugin_type, @plugin_name)
|
143
|
+
end
|
144
|
+
|
145
|
+
def generate_inner_id
|
146
|
+
"#{@plugin_factory.outer_plugin_id}/inner-#{@plugin_type}-#{@plugin_name}@#{@plugin_factory.next_sequence_id}"
|
147
|
+
end
|
148
|
+
end
|
149
|
+
|
150
|
+
|
151
|
+
##
|
152
|
+
# A SequenceGenerator will never generate the same sequence id twice.
|
153
|
+
# The shape of the produced string is an implementation detail.
|
154
|
+
class SequenceGenerator
|
155
|
+
def initialize
|
156
|
+
@last_sequence_id = java.util.concurrent.atomic.AtomicLong.new(0)
|
157
|
+
end
|
158
|
+
|
159
|
+
def next
|
160
|
+
sequence_id = @last_sequence_id.increment_and_get
|
161
|
+
fail("OVERFLOW") if sequence_id.zero?
|
162
|
+
|
163
|
+
"#{sequence_id}"
|
164
|
+
end
|
165
|
+
end
|
166
|
+
end
|
167
|
+
end
|
168
|
+
end
|
169
|
+
end
|
@@ -0,0 +1,212 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'rspec/its'
|
4
|
+
|
5
|
+
require "logstash-core"
|
6
|
+
|
7
|
+
require 'logstash/inputs/base'
|
8
|
+
require 'logstash/filters/base'
|
9
|
+
require 'logstash/codecs/base'
|
10
|
+
require 'logstash/outputs/base'
|
11
|
+
|
12
|
+
require 'logstash/codecs/plain' # to init base plugin with default codec
|
13
|
+
|
14
|
+
require "logstash/plugin_mixins/plugin_factory_support"
|
15
|
+
|
16
|
+
describe LogStash::PluginMixins::PluginFactorySupport do
|
17
|
+
let(:plugin_factory_support) { described_class }
|
18
|
+
|
19
|
+
context 'included into a class' do
|
20
|
+
context 'that does not inherit from `LogStash::Plugin`' do
|
21
|
+
let(:plugin_class) { Class.new }
|
22
|
+
it 'fails with an ArgumentError' do
|
23
|
+
expect do
|
24
|
+
plugin_class.send(:include, plugin_factory_support)
|
25
|
+
end.to raise_error(ArgumentError, /LogStash::Plugin/)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
[
|
30
|
+
LogStash::Inputs::Base,
|
31
|
+
LogStash::Filters::Base,
|
32
|
+
LogStash::Codecs::Base,
|
33
|
+
LogStash::Outputs::Base
|
34
|
+
].each do |base_class|
|
35
|
+
context "that inherits from `#{base_class}`" do
|
36
|
+
native_support_for_plugin_factory = base_class.method_defined?(:plugin_factory)
|
37
|
+
|
38
|
+
let(:plugin_base_class) { base_class }
|
39
|
+
|
40
|
+
subject(:plugin_class) do
|
41
|
+
Class.new(plugin_base_class) do
|
42
|
+
config_name 'test'
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
context 'the result' do
|
47
|
+
before(:each) do
|
48
|
+
plugin_class.send(:include, plugin_factory_support)
|
49
|
+
end
|
50
|
+
|
51
|
+
it 'defines an `plugin_factory` method' do
|
52
|
+
expect(plugin_class.method_defined?(:plugin_factory)).to be true
|
53
|
+
end
|
54
|
+
|
55
|
+
# depending on which version of Logstash is running, we either expect
|
56
|
+
# to include or to _NOT_ include the legacy adapter.
|
57
|
+
if native_support_for_plugin_factory
|
58
|
+
context 'since base class provides plugin_factory method' do
|
59
|
+
its(:ancestors) { is_expected.to_not include(plugin_factory_support::LegacyAdapter) }
|
60
|
+
end
|
61
|
+
else
|
62
|
+
context 'since base class does not plugin_factory method' do
|
63
|
+
its(:ancestors) { is_expected.to include(plugin_factory_support::LegacyAdapter) }
|
64
|
+
end
|
65
|
+
|
66
|
+
# TODO: Remove once Plugin Factory is included in one or
|
67
|
+
# more Logstash release branches. This speculative spec is meant
|
68
|
+
# to prove that this implementation will not override an existing
|
69
|
+
# implementation.
|
70
|
+
context 'if base class were to include a plugin_factory method' do
|
71
|
+
let(:plugin_base_class) do
|
72
|
+
Class.new(super()) do
|
73
|
+
def plugin_factory
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
77
|
+
before(:each) do
|
78
|
+
expect(plugin_base_class.method_defined?(:plugin_factory)).to be true
|
79
|
+
end
|
80
|
+
its(:ancestors) { is_expected.to_not include(plugin_factory_support::LegacyAdapter) }
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
context 'when intialized' do
|
85
|
+
let(:plugin_options) { Hash.new }
|
86
|
+
subject(:instance) do
|
87
|
+
plugin_class.new(plugin_options).tap do |i|
|
88
|
+
i.execution_context = outer_execution_context
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
let(:outer_execution_context) do
|
93
|
+
# Logstash's Plugin Contextualizer needs a real-deal
|
94
|
+
# ExecutionContext due to java type-casting.
|
95
|
+
::LogStash::ExecutionContext.new(nil, nil)
|
96
|
+
end
|
97
|
+
|
98
|
+
describe '#plugin_factory' do
|
99
|
+
it 'returns a plugin factory' do
|
100
|
+
pf = instance.plugin_factory
|
101
|
+
|
102
|
+
aggregate_failures do
|
103
|
+
expect(pf).to respond_to(:input)
|
104
|
+
expect(pf).to respond_to(:output)
|
105
|
+
expect(pf).to respond_to(:codec)
|
106
|
+
expect(pf).to respond_to(:filter)
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
context 'PluginFactory' do
|
111
|
+
|
112
|
+
describe '#codec("plain").new' do
|
113
|
+
let(:plain_codec_proxy) { instance.plugin_factory.codec('plain') }
|
114
|
+
before(:each) do
|
115
|
+
allow(plain_codec_proxy).to receive(:logger).and_return(double('Logger').as_null_object)
|
116
|
+
end
|
117
|
+
|
118
|
+
let(:inner_params) { Hash.new }
|
119
|
+
|
120
|
+
subject(:inner_plugin) { plain_codec_proxy.new(inner_params) }
|
121
|
+
|
122
|
+
shared_examples 'contextualized instance' do
|
123
|
+
alias_matcher :same_instance_as, :equal
|
124
|
+
it 'has access to the execution_context' do
|
125
|
+
expect(inner_plugin).to have_attributes(execution_context: same_instance_as(outer_execution_context))
|
126
|
+
end
|
127
|
+
it 'logs a breadcrumb linking the inner plugin to its outer wrapper' do
|
128
|
+
inner_plugin # eager instantiate
|
129
|
+
|
130
|
+
expect(plain_codec_proxy.logger).to have_received(:debug).with(a_string_including('initializing inner plain codec'),
|
131
|
+
a_hash_including(inner_plugin_id: inner_plugin.id, outer_plugin_id: instance.id))
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
shared_examples 'params propagation' do
|
136
|
+
it 'propagates the explicitly-passed parameters' do
|
137
|
+
expect(inner_plugin).to have_attributes(original_params: a_hash_including(inner_params))
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
shared_examples 'sensible generated id' do
|
142
|
+
it 'has a sensible generated id' do
|
143
|
+
expect(inner_plugin).to have_attributes(id: a_string_starting_with("#{instance.id}/inner-codec-plain@"))
|
144
|
+
end
|
145
|
+
context 'when multiple plugin instances are generated from the same factory' do
|
146
|
+
subject(:inner_plugins) do
|
147
|
+
instance # eager init outer instance in main thread
|
148
|
+
10.times.map do
|
149
|
+
Thread.new(inner_params.dup) do |isolated_inner_params|
|
150
|
+
100.times.map do
|
151
|
+
instance.plugin_factory.codec('plain').new(isolated_inner_params)
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end.map(&:value).flatten
|
155
|
+
end
|
156
|
+
it 'generates distinct ids' do
|
157
|
+
expect(inner_plugins.map(&:id)).to_not contain_duplicates
|
158
|
+
end
|
159
|
+
|
160
|
+
matcher :contain_duplicates do
|
161
|
+
match do |actual|
|
162
|
+
actual.uniq != actual
|
163
|
+
end
|
164
|
+
failure_message_when_negated do |actual|
|
165
|
+
actual_formatted = RSpec::Support::ObjectFormatter.format(actual)
|
166
|
+
duplicate_counts = actual.each_with_object(Hash.new{0}) { |id,m| m[id] += 1 }
|
167
|
+
.reject {|value, count| count <= 1 }
|
168
|
+
"expected #{actual_formatted} to not contain duplicates but found #{duplicate_counts}"
|
169
|
+
end
|
170
|
+
end
|
171
|
+
end
|
172
|
+
end
|
173
|
+
|
174
|
+
shared_examples 'explicit id propagation' do
|
175
|
+
let(:explicit_id) { inner_params.fetch("id") }
|
176
|
+
it 'propagates the explicitly-given id' do
|
177
|
+
expect(inner_plugin).to have_attributes(id: explicit_id)
|
178
|
+
end
|
179
|
+
end
|
180
|
+
|
181
|
+
context 'with params `"format" => "foo/bar"`' do
|
182
|
+
let(:inner_params) { super().merge("format" => "foo/bar") }
|
183
|
+
|
184
|
+
include_examples "contextualized instance"
|
185
|
+
include_examples "params propagation"
|
186
|
+
include_examples "sensible generated id"
|
187
|
+
|
188
|
+
context 'and explicit id' do
|
189
|
+
let(:inner_params) { super().merge("id" => "explicitly-given-id") }
|
190
|
+
|
191
|
+
include_examples "contextualized instance"
|
192
|
+
include_examples "params propagation"
|
193
|
+
include_examples "explicit id propagation"
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
197
|
+
context 'with explicit id' do
|
198
|
+
let(:inner_params) { super().merge("id" => "explicitly-given-id") }
|
199
|
+
|
200
|
+
include_examples "contextualized instance"
|
201
|
+
include_examples "params propagation"
|
202
|
+
include_examples "explicit id propagation"
|
203
|
+
end
|
204
|
+
end
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
metadata
ADDED
@@ -0,0 +1,120 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: logstash-mixin-plugin_factory_support
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: java
|
6
|
+
authors:
|
7
|
+
- Elastic
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-11-04 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
15
|
+
requirements:
|
16
|
+
- - ">="
|
17
|
+
- !ruby/object:Gem::Version
|
18
|
+
version: 7.13.0
|
19
|
+
name: logstash-core
|
20
|
+
prerelease: false
|
21
|
+
type: :runtime
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 7.13.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
29
|
+
requirements:
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '0'
|
33
|
+
name: logstash-devutils
|
34
|
+
prerelease: false
|
35
|
+
type: :development
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '3.9'
|
47
|
+
name: rspec
|
48
|
+
prerelease: false
|
49
|
+
type: :development
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.9'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '1.3'
|
61
|
+
name: rspec-its
|
62
|
+
prerelease: false
|
63
|
+
type: :development
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.3'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
requirement: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 3.1.0
|
75
|
+
name: logstash-codec-plain
|
76
|
+
prerelease: false
|
77
|
+
type: :development
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 3.1.0
|
83
|
+
description: This gem is meant to be a dependency of any Logstash plugin that wishes
|
84
|
+
to use a Plugin Factory to instantiate inner plugins that are fully-contextualized
|
85
|
+
in the pipeline that the outer plugin is running in
|
86
|
+
email: info@elastic.co
|
87
|
+
executables: []
|
88
|
+
extensions: []
|
89
|
+
extra_rdoc_files: []
|
90
|
+
files:
|
91
|
+
- CHANGELOG.md
|
92
|
+
- LICENSE
|
93
|
+
- README.md
|
94
|
+
- lib/logstash/plugin_mixins/plugin_factory_support.rb
|
95
|
+
- spec/logstash/plugin_mixins/plugin_factory_support_spec.rb
|
96
|
+
homepage: https://github.com/logstash-plugins/logstash-mixin-plugin_factory_support
|
97
|
+
licenses:
|
98
|
+
- Apache-2.0
|
99
|
+
metadata: {}
|
100
|
+
post_install_message:
|
101
|
+
rdoc_options: []
|
102
|
+
require_paths:
|
103
|
+
- lib
|
104
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - ">="
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '0'
|
109
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
110
|
+
requirements:
|
111
|
+
- - ">="
|
112
|
+
- !ruby/object:Gem::Version
|
113
|
+
version: '0'
|
114
|
+
requirements: []
|
115
|
+
rubygems_version: 3.1.6
|
116
|
+
signing_key:
|
117
|
+
specification_version: 4
|
118
|
+
summary: API-stable Plugin Factory support adapter for Logstash plugins
|
119
|
+
test_files:
|
120
|
+
- spec/logstash/plugin_mixins/plugin_factory_support_spec.rb
|