fluent-plugin-unix-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: cc18f5099028958215b671685ea41ebcd5c6754c0b1ee0eb46b3fc87f0b08226
4
+ data.tar.gz: a0d5bbe77d1ccd49d9c5c7a452a3702397fdfd9c41da6f81fd7a35e509b43ba5
5
+ SHA512:
6
+ metadata.gz: f28da19e7f6291fad09fd1a19373d241db41c9d29eedc53b79e0f6432b7d9ad499dea0d5ba5d65440a2f1030e88888f63cbe3086f94eff21334c40811c2fb5c2
7
+ data.tar.gz: 22b091803d9db3ae70d1df0fcf3d9a2e7077bbf83b62274b54512a3c9b9900f304e75308396e8f3742536f15dfac540a489da2f1c575c74d7734c389d9c00658
data/.gitignore ADDED
@@ -0,0 +1,5 @@
1
+ *.gem
2
+ .bundle
3
+ Gemfile.lock
4
+ pkg/*
5
+ vendor/*
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
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 [yyyy] [name of copyright owner]
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,79 @@
1
+ # fluent-plugin-unix-client
2
+
3
+ [Fluentd](https://fluentd.org/) input plugin to receive data from UNIX domain socket.
4
+ This is a **client version** of [the default `unix` plugin](https://docs.fluentd.org/input/unix).
5
+
6
+ ## Installation
7
+
8
+ ### RubyGems
9
+
10
+ ```
11
+ $ gem install fluent-plugin-unix-client
12
+ ```
13
+
14
+ ### Bundler
15
+
16
+ Add following line to your Gemfile:
17
+
18
+ ```ruby
19
+ gem "fluent-plugin-unix-client"
20
+ ```
21
+
22
+ And then execute:
23
+
24
+ ```
25
+ $ bundle
26
+ ```
27
+
28
+ ## Configuration
29
+
30
+ ### tag (string) (required)
31
+
32
+ Tag of output events.
33
+
34
+ ### path (string) (required)
35
+
36
+ The path to Unix Domain Socket.
37
+
38
+ Note: This is a client side application, so you need to set the path which **is opened by another server side application**.
39
+
40
+ ### parse (section) (required)
41
+
42
+ This plugin use Fluentd parser plugin as a helper.
43
+ See [Config: Parse Section](https://docs.fluentd.org/configuration/parse-section).
44
+
45
+ ### delimiter (string) (optional)
46
+
47
+ The payload is read up to this character.
48
+
49
+ Default value: `"\n"` (newline).
50
+
51
+ ## Sample
52
+
53
+ ```
54
+ <source>
55
+ @type unix_client
56
+ tag debug.unix_client
57
+ path /tmp/unix.sock
58
+ <parse>
59
+ @type json
60
+ </parse>
61
+ delimiter "\n"
62
+ </source>
63
+
64
+ <match debug.**>
65
+ @type stdout
66
+ </match>
67
+ ```
68
+
69
+ ## Specification
70
+
71
+ * This recieves data from UNIX domain socket which **is opened by another application**.
72
+ * If you need other applications to send data to the socket you opened, you can use [the default `unix` plugin](https://docs.fluentd.org/input/unix).
73
+ * If this can't connect to the socket, this trys to reconnect later.
74
+
75
+ ## Copyright
76
+
77
+ * Copyright(c) 2021- daipom
78
+ * License
79
+ * Apache License, Version 2.0
data/Rakefile ADDED
@@ -0,0 +1,13 @@
1
+ require "bundler"
2
+ Bundler::GemHelper.install_tasks
3
+
4
+ require "rake/testtask"
5
+
6
+ Rake::TestTask.new(:test) do |t|
7
+ t.libs.push("lib", "test")
8
+ t.test_files = FileList["test/**/test_*.rb"]
9
+ t.verbose = true
10
+ t.warning = true
11
+ end
12
+
13
+ task default: [:test]
@@ -0,0 +1,26 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+
4
+ Gem::Specification.new do |spec|
5
+ spec.name = "fluent-plugin-unix-client"
6
+ spec.version = "0.1.0"
7
+ spec.authors = ["daipom"]
8
+ spec.email = ["reangoapyththeorem@gmail.com"]
9
+
10
+ spec.summary = %q{Fluentd Input plugin to receive data from UNIX domain socket. This is a client version of the default `unix` input plugin.}
11
+ spec.homepage = "https://github.com/daipom/fluent-plugin-unix-client"
12
+ spec.license = "Apache-2.0"
13
+
14
+ test_files, files = `git ls-files -z`.split("\x0").partition do |f|
15
+ f.match(%r{^(test|spec|features)/})
16
+ end
17
+ spec.files = files
18
+ spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
19
+ spec.test_files = test_files
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 2.2.15"
23
+ spec.add_development_dependency "rake", "~> 13.0"
24
+ spec.add_development_dependency "test-unit", "~> 3.3"
25
+ spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
26
+ end
@@ -0,0 +1,173 @@
1
+ #
2
+ # Copyright 2021- daipom
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ require "fluent/plugin/input"
17
+ require 'socket'
18
+
19
+ module Fluent
20
+ module Plugin
21
+ class UnixClientInput < Fluent::Plugin::Input
22
+ Fluent::Plugin.register_input("unix_client", self)
23
+
24
+ helpers :thread, :parser
25
+
26
+ desc 'Tag of output events.'
27
+ config_param :tag, :string
28
+ desc 'The path to Unix Domain Socket.'
29
+ config_param :path, :string
30
+ desc 'The payload is read up to this character.'
31
+ config_param :delimiter, :string, default: "\n"
32
+
33
+ def configure(conf)
34
+ super
35
+ @parser = parser_create
36
+ @socket_handler = SocketHandler.new(@path, delimiter: @delimiter, log: log)
37
+ end
38
+
39
+ def start
40
+ super
41
+ thread_create(:in_unix_client, &method(:keep_receiving))
42
+ end
43
+
44
+ def keep_receiving
45
+ while thread_current_running?
46
+ begin
47
+ receive_and_emit
48
+ rescue => e
49
+ log.error "in_unix_client: error occurred. #{e}"
50
+ sleep 3
51
+ end
52
+ end
53
+ ensure
54
+ @socket_handler.try_close
55
+ end
56
+
57
+ def receive_and_emit
58
+ raw_records = @socket_handler.try_receive
59
+ return if raw_records.nil? || raw_records.empty?
60
+
61
+ raw_records.each do |raw_record|
62
+ @parser.parse(raw_record) do |time, record|
63
+ router.emit(@tag, time, record)
64
+ end
65
+ end
66
+ end
67
+ end
68
+
69
+
70
+ class SocketHandler
71
+ MAX_LENGTH_RECEIVE_ONCE = 10000
72
+
73
+ def initialize(path, delimiter: "\n", log: nil)
74
+ @path = path
75
+ @log = log
76
+ @socket = nil
77
+ @buf = Buffer.new(delimiter)
78
+ end
79
+
80
+ def connected?
81
+ !@socket.nil?
82
+ end
83
+
84
+ def try_receive(timeout: 1)
85
+ unless connected?
86
+ try_open
87
+ return []
88
+ end
89
+ return [] unless exist_data?(timeout)
90
+
91
+ records, has_closed = try_get_records
92
+
93
+ if has_closed
94
+ @log&.warn "in_unix_client: server socket seems to be closed."
95
+ try_close
96
+ return []
97
+ end
98
+
99
+ records
100
+ end
101
+
102
+ def try_close
103
+ @socket&.close
104
+ rescue => e
105
+ @log&.error "in_unix_client: failed to close socket. #{e.message}"
106
+ ensure
107
+ @socket = nil
108
+ end
109
+
110
+ private
111
+
112
+ def try_open
113
+ @socket = UNIXSocket.open(@path)
114
+ @log&.info "in_unix_client: opened socket: #{@path}."
115
+ rescue => e
116
+ @log&.warn "in_unix_client: failed to open socket: #{@path}, due to: #{e.message}"
117
+ @socket = nil
118
+ sleep 3
119
+ end
120
+
121
+ def exist_data?(timeout)
122
+ return true if IO::select([@socket], nil, nil, timeout)
123
+ false
124
+ end
125
+
126
+ def try_get_records
127
+ msg, * = @socket.recvmsg_nonblock(MAX_LENGTH_RECEIVE_ONCE)
128
+ has_closed = msg.empty?
129
+ return [], has_closed if has_closed
130
+
131
+ @buf << msg
132
+ records = @buf.extract_records
133
+ return records, has_closed
134
+ rescue IO::WaitReadable => e
135
+ @log&.debug "in_unix_client: there were no data though the socket was recognized readable by IO::select. #{e.message}"
136
+ sleep 3
137
+ rescue => e
138
+ @log&.error "in_unix_client: failed to receive data. #{e.message}"
139
+ sleep 3
140
+ end
141
+ end
142
+
143
+
144
+ class Buffer
145
+ def initialize(delimiter)
146
+ @buf = ""
147
+ @delimiter = delimiter
148
+ end
149
+
150
+ def add(data)
151
+ @buf << data
152
+ end
153
+
154
+ def <<(data)
155
+ add(data)
156
+ end
157
+
158
+ def extract_records
159
+ records = []
160
+
161
+ pos_read = 0
162
+ while pos_next_delimiter = @buf.index(@delimiter, pos_read)
163
+ records << @buf[pos_read...pos_next_delimiter]
164
+ pos_read = pos_next_delimiter + @delimiter.size
165
+ end
166
+
167
+ @buf.slice!(0, pos_read) if pos_read > 0
168
+
169
+ records
170
+ end
171
+ end
172
+ end
173
+ end
data/test/helper.rb ADDED
@@ -0,0 +1,8 @@
1
+ $LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
2
+ require "test-unit"
3
+ require "fluent/test"
4
+ require "fluent/test/driver/input"
5
+ require "fluent/test/helpers"
6
+
7
+ Test::Unit::TestCase.include(Fluent::Test::Helpers)
8
+ Test::Unit::TestCase.extend(Fluent::Test::Helpers)
@@ -0,0 +1,147 @@
1
+ require "socket"
2
+ require "json"
3
+ require "time"
4
+ require "helper"
5
+ require "fluent/test/driver/input"
6
+ require "fluent/plugin/in_unix_client.rb"
7
+ require_relative "./unix_server.rb"
8
+
9
+ class UnixClientInputTest < Test::Unit::TestCase
10
+ def setup
11
+ Fluent::Test.setup
12
+ @thread = nil
13
+ end
14
+
15
+ def teardown
16
+ @thread.kill if @thread
17
+ @thread = nil
18
+ FileUtils.rm_rf(TMP_DIR)
19
+ end
20
+
21
+ TMP_DIR = File.dirname(__FILE__) + "/../tmp/socket"
22
+
23
+ BASE_CONFIG = %[
24
+ @type unix_client
25
+ tag unix_client
26
+ path #{TMP_DIR}/socket.sock
27
+ ]
28
+
29
+ DEFAULT_MSG = "Hello world."
30
+
31
+ def test_configure
32
+ d = create_driver(config_with_json_parser)
33
+ assert_equal "unix_client", d.instance.tag
34
+ assert_equal "#{TMP_DIR}/socket.sock", d.instance.path
35
+ end
36
+
37
+ def test_receive_json
38
+ d = create_driver(config_with_json_parser)
39
+ path = d.instance.path
40
+
41
+ start_server(path)
42
+
43
+ cur_time = Time.now.to_i
44
+
45
+ d.run(expect_records: 1, timeout: 10) do
46
+ sleep 1
47
+ send_json(path, time: cur_time)
48
+ end
49
+
50
+ assert_equal 1, d.events.length
51
+
52
+ d.events.each do |tag, time, record|
53
+ assert_equal "unix_client", tag
54
+ assert_equal cur_time, time
55
+ assert_equal DEFAULT_MSG, record["msg"]
56
+ end
57
+ end
58
+
59
+ def test_receive_json_with_custom_delimiter_newline
60
+ d = create_driver(config_with_json_parser_and_delimiter('\n'))
61
+ path = d.instance.path
62
+
63
+ start_server(path)
64
+
65
+ cur_time = Time.now.to_i
66
+
67
+ d.run(expect_records: 1, timeout: 10) do
68
+ sleep 1
69
+ send_json(path, time: cur_time, delimiter: "\n")
70
+ end
71
+
72
+ assert_equal 1, d.events.length
73
+
74
+ d.events.each do |tag, time, record|
75
+ assert_equal "unix_client", tag
76
+ assert_equal cur_time, time
77
+ assert_equal DEFAULT_MSG, record["msg"]
78
+ end
79
+ end
80
+
81
+ def test_receive_json_with_custom_delimiter_tab
82
+ d = create_driver(config_with_json_parser_and_delimiter('\t'))
83
+ path = d.instance.path
84
+
85
+ start_server(path)
86
+
87
+ cur_time = Time.now.to_i
88
+
89
+ d.run(expect_records: 1, timeout: 10) do
90
+ sleep 1
91
+ send_json(path, time: cur_time, delimiter: "\t")
92
+ end
93
+
94
+ assert_equal 1, d.events.length
95
+
96
+ d.events.each do |tag, time, record|
97
+ assert_equal "unix_client", tag
98
+ assert_equal cur_time, time
99
+ assert_equal DEFAULT_MSG, record["msg"]
100
+ end
101
+ end
102
+
103
+ private
104
+
105
+ def create_driver(conf)
106
+ Fluent::Test::Driver::Input.new(Fluent::Plugin::UnixClientInput).configure(conf)
107
+ end
108
+
109
+ def config_with_json_parser
110
+ BASE_CONFIG + %!
111
+ <parse>
112
+ @type json
113
+ </parse>
114
+ !
115
+ end
116
+
117
+ def config_with_json_parser_and_delimiter(delimiter)
118
+ BASE_CONFIG + %[
119
+ delimiter \"#{delimiter}\"
120
+ ] + %!
121
+ <parse>
122
+ @type json
123
+ </parse>
124
+ !
125
+ end
126
+
127
+ def start_server(path)
128
+ @thread = Thread.new do
129
+ server = UnixBroadcastServer.new(path)
130
+ server.run
131
+ end
132
+ sleep 1
133
+ end
134
+
135
+ def send_json(path, time: nil, msg: DEFAULT_MSG, delimiter: "\n")
136
+ msg = JSON.generate(
137
+ {
138
+ "time" => time.nil? ? Time.now.to_i : time,
139
+ "msg" => msg
140
+ }
141
+ )
142
+ UNIXSocket.open(path) do |sock|
143
+ sock.write(msg)
144
+ sock.write(delimiter)
145
+ end
146
+ end
147
+ end
@@ -0,0 +1,114 @@
1
+ require "socket"
2
+ require "fileutils"
3
+
4
+ # When receiving data, this broadcasts the data to all connecting clients by UNIX domain socket.
5
+ class UnixBroadcastServer
6
+ def initialize(path, use_log: false)
7
+ @path = path
8
+ @use_log = use_log
9
+ @all_ids = []
10
+ @data_handler = DataHandler.new(@all_ids)
11
+ @cur_id = 0
12
+ end
13
+
14
+ def run
15
+ if File.exist?(@path)
16
+ log "Found existing '#{@path}'. Remove this file."
17
+ File.unlink(@path)
18
+ end
19
+ FileUtils.mkdir_p(File.dirname(@path))
20
+
21
+ Socket.unix_server_loop(@path) do |sock, addr|
22
+ @cur_id += 1
23
+ sock_id = @cur_id
24
+ @all_ids.append(sock_id)
25
+
26
+ log "#{sock} was newly opened. id: #{sock_id}"
27
+
28
+ create_thread_to_receive(sock, sock_id)
29
+ create_thread_to_send(sock, sock_id)
30
+ rescue Errno::EPIPE => e
31
+ log e.message
32
+ end
33
+ end
34
+
35
+ private
36
+
37
+ def close(sock, sock_id)
38
+ log "#{sock_id}: closed."
39
+ @all_ids.delete(sock_id)
40
+ sock.close
41
+ end
42
+
43
+ def closed?(sock_id)
44
+ !@all_ids.include?(sock_id)
45
+ end
46
+
47
+ def create_thread_to_receive(sock, sock_id)
48
+ Thread.new do
49
+ loop do
50
+ record = sock.gets
51
+ if record.nil?
52
+ close(sock, sock_id)
53
+ break
54
+ end
55
+
56
+ log "#{sock_id}: get #{record}"
57
+
58
+ @data_handler.add_record_for_broadcast(sock_id, record)
59
+ end
60
+ end
61
+ end
62
+
63
+ def create_thread_to_send(sock, sock_id)
64
+ Thread.new do
65
+ loop do
66
+ break if closed?(sock_id)
67
+
68
+ records = @data_handler.get_records(sock_id)
69
+
70
+ records.each do |record|
71
+ log "#{sock_id}: write #{record}"
72
+ sock.write(record)
73
+ end
74
+
75
+ Thread.pass
76
+ sleep 0.5
77
+ end
78
+ end
79
+ end
80
+
81
+ def log(message)
82
+ return unless @use_log
83
+ p message
84
+ end
85
+
86
+ class DataHandler
87
+ # Since this code is just for test, the locking process is not implemented.
88
+ # Unexpected behavior may occur when processing in parallel.
89
+ def initialize(all_ids)
90
+ @all_ids = all_ids
91
+ @buf_per_id = {}
92
+ end
93
+
94
+ def add_record_for_broadcast(from_id, record)
95
+ @all_ids.each do |to_id|
96
+ next if to_id == from_id
97
+ add_record(to_id, record)
98
+ end
99
+ end
100
+
101
+ def get_records(sock_id)
102
+ records = @buf_per_id[sock_id]
103
+ @buf_per_id[sock_id] = []
104
+ return records.nil? ? [] : records
105
+ end
106
+
107
+ private
108
+
109
+ def add_record(to_id, record)
110
+ @buf_per_id[to_id] = [] if @buf_per_id[to_id].nil?
111
+ @buf_per_id[to_id].append(record)
112
+ end
113
+ end
114
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fluent-plugin-unix-client
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - daipom
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-05-31 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 2.2.15
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 2.2.15
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '13.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '13.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: test-unit
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.3'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.3'
55
+ - !ruby/object:Gem::Dependency
56
+ name: fluentd
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: 0.14.10
62
+ - - "<"
63
+ - !ruby/object:Gem::Version
64
+ version: '2'
65
+ type: :runtime
66
+ prerelease: false
67
+ version_requirements: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - ">="
70
+ - !ruby/object:Gem::Version
71
+ version: 0.14.10
72
+ - - "<"
73
+ - !ruby/object:Gem::Version
74
+ version: '2'
75
+ description:
76
+ email:
77
+ - reangoapyththeorem@gmail.com
78
+ executables: []
79
+ extensions: []
80
+ extra_rdoc_files: []
81
+ files:
82
+ - ".gitignore"
83
+ - Gemfile
84
+ - LICENSE
85
+ - README.md
86
+ - Rakefile
87
+ - fluent-plugin-unix-client.gemspec
88
+ - lib/fluent/plugin/in_unix_client.rb
89
+ - test/helper.rb
90
+ - test/plugin/test_in_unix_client.rb
91
+ - test/plugin/unix_server.rb
92
+ homepage: https://github.com/daipom/fluent-plugin-unix-client
93
+ licenses:
94
+ - Apache-2.0
95
+ metadata: {}
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubygems_version: 3.2.15
112
+ signing_key:
113
+ specification_version: 4
114
+ summary: Fluentd Input plugin to receive data from UNIX domain socket. This is a client
115
+ version of the default `unix` input plugin.
116
+ test_files:
117
+ - test/helper.rb
118
+ - test/plugin/test_in_unix_client.rb
119
+ - test/plugin/unix_server.rb