fluent-plugin-jsonish 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
data.tar.gz.sig ADDED
Binary file
data/.gitignore ADDED
@@ -0,0 +1,4 @@
1
+ /certs/*key*
2
+ /certs/*priv*
3
+ **.gem
4
+ **.gem.sha*
data/LICENSE ADDED
@@ -0,0 +1,13 @@
1
+ Copyright 2017 Red Book Connect LLC. operating as HotSchedules
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
@@ -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,99 @@
1
+ # jsonish, nginx_jsonish, and nodejs_bunyan parser plugins for Fluentd
2
+
3
+ ## Overview
4
+ The jsonish [parser plugin](http://docs.fluentd.org/articles/parser-plugin-overview) for fluentd. It subclasses the JSONParser to allow for modifications to be made to input test before it is deserialized. It subclasses the TimeParser to allow time format specifications using Ruby Time class method names instead of strftime format strings -- in particular, the iso8601 method.
5
+ :
6
+ Two other plugins -- nginx_jsonish and inodejs_bunyan -- are provided, which are simple subclasses of the jsonish parser. Beyond providing ability to manipulate JSON inputs prior to deserialization, the jsonish parser plugin is a proper extension of the json parser: it can be used wherever the json parser is used with no configuration change required.
7
+ The original use case which prompted this work was for parsing nxing access logs in a custom log format attempting to output JSON. However, this cannot done in a reliable way with with nginx custom log formats, since:
8
+
9
+ - nginx uses ASCII (ISO-LATIN-1) encoding, using '\xHH' codes whenever it encounters non-ASCII values (or literal '"' characters) which makes for invalid JSON, and
10
+ - nginx uses a '-' as a null, so any time a value is not present it ends up creating an invalid key/value pair when the datatype is numeric.
11
+
12
+ The format is so close to JSON -- all it requires is a couple of gsubs be run on the text before the JSON parser is applied -- that it seemed a saner solution than coming up with a completely different log_format and then have to figure out how to text parse it.
13
+
14
+ ## Installation
15
+ ```bash
16
+ gem install fluent-plugin-jsonish
17
+ ```
18
+
19
+ ## Configuration
20
+
21
+ ### jsonish
22
+
23
+ ```
24
+ <source>
25
+ type [tail|tcp|udp|syslog|http] # any input type which takes a format
26
+ format jsonish
27
+ maps <mappings for text processing prior to the JSON parse>
28
+ null_pattern <the pattern used for nulls in the text>
29
+ null_maps <how the patterns specified by null_pattern should be replaced>
30
+ message_key <key to use for setting the 'message' key in the record>
31
+ add_full_message <whether to the record 'full_message' key to the raw input>
32
+ </source>
33
+ ```
34
+
35
+ `add_full_message`: whether to set the record "full_message" to the raw input prior to performing any transforms (Boolean: defaults to false)
36
+
37
+ `message_key`: the hash key to use to set the "message" in the record.
38
+ `time_format`: this will accept Time class method names (in particular, "iso8601") in addition to the strftime strings expected by the JsonParser clasee (String: default "iso8601")
39
+
40
+ `maps`: an array containing "nulls", "slashes", or two-valued arrays containg (regex,replacement_text) pairs. Defaults to [].
41
+
42
+ `null_pattern`: the pattern for how nulls are represented in the text. Defaults to "-" (what nginx uses).
43
+
44
+ `null_maps`: the an JSON array of two-valued arrays containing a sprintf regex string and substitution text (JSON: default [ [ \"(:\\s+)\"%s\"(\\s*[,}])\", \"\\1null\\2\" ], [ \"(:\\s+)%s(\\s*[,}])\", \"\\1null\\2\" ], [ \"(:\\s+)\\[\\s*%s\\s*\\](\\s*[,}])\", \"\\1[]\\2\" ], [ \"(:\\s+){\\s*%s\\*}(\\s*[,}])\", \"\\1{}\\2\" ] ])
45
+
46
+ As an example, the nginx_jsonish subclasses the jsonish parser which really only serves to set the needed defaults for nginx access log parsing. The nginx_jsonish configuration in the next section is essentially equivalent to:
47
+
48
+ ```
49
+ <source>
50
+ type tail
51
+ format jsonish
52
+ path <nginx access log file>
53
+ maps ([ "slashes", "nulls" ] automatically prepended to anything set here)
54
+ message_key (set to "request", by default)
55
+ [ standard parser or jsonish arguments ]
56
+ </source>
57
+ ```
58
+
59
+ The nodejs_bunyan plugin is similar in its behavior in setting needed defaults, although it also performs some needed processing after the JSON deserialization.
60
+
61
+ ### nginx_jsonish
62
+ The nginx configuration must be configured to output a "JSONish" format. As mentioned above, a true JSON format cannot be reliably emitted using an nginx custom log format. The "time" key, at a minimum, must be set with an ISO-8601 time stamp. By default, the parser will look for a "request" key and set the "message" to this value.
63
+
64
+ Something like the following is probably overkill for most, but it does work:
65
+
66
+ ```
67
+ log_format extended "{ \"time\": \"$time_iso8601\", \"proxy_http_x_forwarded_for\": \"$proxy_add_x_forwarded_for\", \"proxy_x_forwarded_host\": \"$host\", \"proxy_x_forwarded_proto\": \"$scheme\", \"proxy_host\": \"$proxy_host\", \"remote_addr\": \"$remote_addr\", \"remote_port\": \"$remote_port\", \"request\": \"$request\", \"request_method\": \"$request_method\", \"request_uri\": \"$request_uri\", \"request_protocol\": \"$server_protocol\", \"http_accept\": \"$http_accept\", \"http_accept_encoding\": \"$http_accept_encoding\", \"http_accept_language\": \"$http_accept_language\", \"http_connection\": \"$http_connection\", \"sent_http_connection\": \"$sent_http_connection\", \"http_host\": \"$http_host\", \"http_user_agent\": \"$http_user_agent\", \"http_x_forwarded_for\": \"$http_x_forwarded_for\", \"body_bytes_sent\": $body_bytes_sent, \"connection_requests\": $connection_requests, \"proxy_internal_body_length\": $proxy_internal_body_length, \"request_length\": $request_length, \"request_time\": $request_time, \"status\": $status, \"upstream_response_time\": [$upstream_response_time], \"upstream_response_length\": [$upstream_response_length], \"upstream_status\": [$upstream_status], \"gzip_ratio\": $gzip_ratio }";
68
+ ```
69
+
70
+ After defining the custom log format, the access log for any virtual host where it's needed must be configured to use it.
71
+
72
+ ```
73
+ access_log <log file name> extended;
74
+ ```
75
+
76
+ The fluentd parser configuration for this input is straight-forward:
77
+
78
+ ```
79
+ <source>
80
+ type tail
81
+ format nginx_jsonish
82
+ path <nginx access log file>
83
+ [ standard parser or jsonish arguments ]
84
+ </source>
85
+ ```
86
+
87
+ ### nodejs_bunyan
88
+ This is a parser for Node.js applicatons which use [node-bunyan](https://github.com/trentm/node-bunyan) for logging. It pretty much takes care of everything, including mapping the "level" from this format to standard [syslog severity levels](https://en.wikipedia.org/wiki/Syslog#Severity_level).
89
+
90
+ The fluentd parser configuration for this input is straight-forward:
91
+
92
+ ```
93
+ <source>
94
+ type tail
95
+ format nodejs_bunyan
96
+ path <application log file name>
97
+ [ standard parser or jsonish arguments ]
98
+ </source>
99
+ ```
@@ -0,0 +1,25 @@
1
+ -----BEGIN CERTIFICATE-----
2
+ MIIELzCCAxGgAwIBAgIJAMOoRmNuvAZcMA0GCSqGSIb3DQEBCwUAMIGnMQswCQYD
3
+ VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
4
+ aXNjbzEVMBMGA1UECgwMSG90c2NoZWR1bGVzMQ4wDAYDVQQLDAVJbmZyYTEfMB0G
5
+ A1UEAwwWaW5mcmEuaG90c2NoZWR1bGVzLmNvbTEjMCEGCSqGSIb3DQEJARYUb3Nz
6
+ QGhvdHNjaGVkdWxlcy5jb20wHhcNMTcwMjE4MDA1NDU4WhcNMjEwMjE4MDA1NDU4
7
+ WjCBpzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcM
8
+ DVNhbiBGcmFuY2lzY28xFTATBgNVBAoMDEhvdHNjaGVkdWxlczEOMAwGA1UECwwF
9
+ SW5mcmExHzAdBgNVBAMMFmluZnJhLmhvdHNjaGVkdWxlcy5jb20xIzAhBgkqhkiG
10
+ 9w0BCQEWFG9zc0Bob3RzY2hlZHVsZXMuY29tMIIBKDANBgkqhkiG9w0BAQEFAAOC
11
+ ARUAMIIBEAKCAQcAutTytHjHFb5yK/29POqMS3DyxRSRRbKvBus/rEL3reeKDVlf
12
+ eO9a/9U3oUcxHFHeISF9uOBSvL88svxhLqxkKLVA0vMbVgDFoGsOlh93nA5Lmw+H
13
+ SEzG3+Z6JqH8YfAIqVyp1nZcdtC7u8xYpDD65ayjRALLuvOUXORGeqgedlgiwwLp
14
+ 2tZ7A9tCzBZnDjcNenD8zXLCOdRjJiBPq/XQS9h4POWvpom0z+jyUkRj3ojqOoXW
15
+ bKKdXzdZ3s5BSwgxlWJo+lK/50+xLpjJe4mEJwySkrluy8GOG/UR/j+Y4I1j1FbY
16
+ RwT9SUSairjh0zgiDC0LTjAJBIenuxxuM9jhRyoiu+YYVwIDAQABo1AwTjAdBgNV
17
+ HQ4EFgQUtlFsvLIJ59o2GyoRTXKEIPEgnn8wHwYDVR0jBBgwFoAUtlFsvLIJ59o2
18
+ GyoRTXKEIPEgnn8wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQcAdELJ
19
+ QdrR55Xak3q5IhLnIdOLJC6ZEdHI2173SSmytInyDX6fe9uZION4I9WCCm/hCp+t
20
+ QILh4feu14iDWmBxzy6F6tiyuEjhaU5Ud9wZ/YDBQhP2AHquoPAufxXZAUFlA5er
21
+ wIYVupToBrWavfbjgRqRHAZ6vwrLwoIiomh2/wv06HLrFmSzj5q6BVp7FFMKDail
22
+ QWzJ4aQl786RMwPa776eVaKQTmQuTUUppvhVq9QdKyxwGPibAYGbYKZwmmtx+BV2
23
+ GJevNV8BSuhh6m2AHCxEzMaD7WKNbewTTgGLUlvppaR9SE2V/yUZ7x1Vp8/mGeO6
24
+ 2Zk648Ep9HVPKmwoVuB75+xEQw==
25
+ -----END CERTIFICATE-----
@@ -0,0 +1,20 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |gem|
4
+ gem.name = 'fluent-plugin-jsonish'
5
+ gem.version = '1.0.0'
6
+ gem.authors = ['Alex Yamauchi']
7
+ gem.email = ['oss@hotschedules.com']
8
+ gem.homepage = 'https://github.com/bodhi-space/fluent-plugin-jsonish'
9
+ gem.description = %q{Input parser for records which require minor text processing before they can be parsed as JSON}
10
+ gem.summary = %q{Input parser for records which require minor text processing before they can be parsed as JSON. Also allows names of standard Time parser methods to be passed as time_format arguments and sets a reasonable default (iso8601).}
11
+ gem.homepage = 'https://github.com/bodhi-space/fluent-plugin-jsonish'
12
+ gem.license = 'Apache-2.0'
13
+ gem.add_runtime_dependency 'fluentd', '>= 0.10.0'
14
+ gem.files = `git ls-files`.split("\n")
15
+ gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
16
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
17
+ gem.require_paths = ['lib']
18
+ gem.signing_key = File.expand_path('~/certs/oss@hotschedules.com.key') if $0 =~ /gem\z/
19
+ gem.cert_chain = %w[certs/oss@hotschedules.com.cert]
20
+ end
@@ -0,0 +1,126 @@
1
+ module Fluent
2
+ class TextParser
3
+ class StdFormatTimeParser < TimeParser
4
+
5
+ # Extend the standard TimeParser to be able to use methods for
6
+ # standard formats -- in particular, for formats which can be
7
+ # represented by muliple hard-coded formats. For instance, the
8
+ # iso8601 format can be represented by either of the following
9
+ # formats (probably more) which are *not* interchangable as
10
+ # arguments to strptime -- whether or not the tiemstamp has
11
+ # millisecond precision must be treated as two distinct formats
12
+ # if the available iso8601 method is not used:
13
+ #
14
+ # * '%y-%m-%dT%H:%M:%S%Z' (no fractional seconds)
15
+ # * '%y-%m-%dT%H:%M:%S.%L%Z' (fractional seconds)
16
+
17
+ def initialize(time_format)
18
+
19
+ if not time_format.nil? and time_format.empty?
20
+ # Set a reasonable default.
21
+ time_format = 'iso8601'
22
+ end
23
+
24
+ if not time_format.nil? and not /%/.match(time_format)
25
+ super(nil)
26
+
27
+ @parser = Proc.new { |v| Time.method(time_format).call(v) }
28
+
29
+ else
30
+ super(time_format)
31
+ end
32
+ end
33
+ end
34
+
35
+ class JSONishParser < JSONParser
36
+
37
+ Plugin.register_parser('jsonish', self)
38
+
39
+ config_param :maps, :array, :default => []
40
+ config_param :null_pattern, :string, :default => '-'
41
+ config_param :null_maps, :array, :default => [
42
+ [ '(:\s+)"%s"(\s*[,}])', '\1null\2' ],
43
+ [ '(:\s+)%s(\s*[,}])', '\1null\2' ],
44
+ [ '(:\s+)\[\s*%s\s*\](\s*[,}])', '\1[]\2' ],
45
+ [ '(:\s+){\s*%s\*}(\s*[,}])', '\1{}\2' ]
46
+ ]
47
+ config_param :message_key, :string, :default => nil
48
+ config_param :add_full_message, :bool, :default => false
49
+
50
+ def initialize
51
+ super
52
+ end
53
+
54
+ def configure(conf)
55
+
56
+ if conf['time_format']
57
+ # Remove the time_format key before the super call
58
+ # so the it does as little as possible as possible
59
+ # (ie. less that we'll have to override).
60
+ tmp_time_format = conf['time_format']
61
+ conf.delete('time_format')
62
+ end
63
+
64
+ super(conf)
65
+
66
+ @time_parser = StdFormatTimeParser.new(tmp_time_format)
67
+ @mutex = Mutex.new
68
+
69
+ # This may look stupid (it actually is really stupid),
70
+ # but this *must* be set back to a non-null string
71
+ # prior to the return, since the superclass parser
72
+ # method checks for this and them implements its
73
+ # own ad hoc parser, in-line. This is a necessary
74
+ # kludge to bypass a more egregious kludge.
75
+ @time_format = 'ignore_me'
76
+
77
+ @transforms = []
78
+
79
+ @maps.each do |elem|
80
+ if elem.is_a?(Array)
81
+ @transforms << [ Regexp.new(elem[0]), elem[1] ]
82
+ elsif elem.is_a?(String)
83
+ if elem == 'slashes'
84
+ @transforms << [ Regexp.new("\\\\"), "\\\\\\" ]
85
+ elsif elem == 'nulls'
86
+ @null_maps.each do |e|
87
+ @transforms << [ Regexp.new(sprintf(e[0],@null_pattern)), e[1] ]
88
+ end
89
+ else
90
+ raise ConfigError, "Unknown transform #{elem}."
91
+ end
92
+ else
93
+ raise ConfigError, "Unknown transform data type."
94
+ end
95
+ end
96
+
97
+ @message_key = conf['message_key']
98
+ @add_full_message = conf['add_full_message']
99
+
100
+ end
101
+
102
+ def parse(text)
103
+
104
+ full_message = @add_full_message ? text : nil
105
+
106
+ @transforms.each do |args|
107
+ text.gsub!(*args)
108
+ end
109
+
110
+ super(text) do |time,record|
111
+ if @message_key
112
+ record['message'] = record[@message_key]
113
+ end
114
+
115
+ if full_message
116
+ record['full_message'] = full_message
117
+ end
118
+
119
+ yield time, record
120
+ end
121
+
122
+ end
123
+
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,27 @@
1
+ require_relative 'parser_jsonish'
2
+
3
+ module Fluent
4
+ class TextParser
5
+ class NginxJSONishParser < JSONishParser
6
+ Plugin.register_parser('nginx_jsonish', self)
7
+
8
+
9
+ def configure(conf)
10
+
11
+ if conf['maps'].is_a?(Array)
12
+ conf['maps'] = ([ 'slashes', 'nulls' ] + conf['maps']).uniq
13
+ else
14
+ conf['maps'] = [ 'slashes', 'nulls' ]
15
+ end
16
+
17
+ if not (conf['message_key'] and conf['message_key'].is_empty?)
18
+ conf['message_key'] = 'request'
19
+ end
20
+
21
+ super(conf)
22
+
23
+ end
24
+
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,31 @@
1
+ require_relative 'parser_jsonish'
2
+
3
+ module Fluent
4
+ class TextParser
5
+ class NodejsBunyanParser < JSONishParser
6
+ Plugin.register_parser('nodejs_bunyan', self)
7
+
8
+ def configure(conf)
9
+ super(conf.update({ 'time_key' => 'time', 'message_key' => 'msg'}))
10
+ end
11
+
12
+ def parse(text)
13
+ super(text) do |time, record|
14
+ # Map the developer-defined levels to syslog levels.
15
+ record['level'] = 8+(record['level']<=30?1:0)-(record['level']/10)
16
+ # Cannot be disabled in the library and serves no purpose,
17
+ # since it never varies.
18
+ record.delete('v')
19
+ # Fluent expects the host to be keyed with 'host', not 'hostname'.
20
+ record['host'] = record.delete('hostname')
21
+ record.delete('hostname')
22
+ # Passing 'message_key' only duplicates the key to 'message' --
23
+ # it does not delete the original key (which is unneeded).
24
+ record.delete(@message_key)
25
+ yield time, record
26
+ end
27
+ end
28
+
29
+ end
30
+ end
31
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fluent-plugin-jsonish
3
+ version: !ruby/object:Gem::Version
4
+ hash: 23
5
+ prerelease:
6
+ segments:
7
+ - 1
8
+ - 0
9
+ - 0
10
+ version: 1.0.0
11
+ platform: ruby
12
+ authors:
13
+ - Alex Yamauchi
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain:
17
+ - |
18
+ -----BEGIN CERTIFICATE-----
19
+ MIIELzCCAxGgAwIBAgIJAMOoRmNuvAZcMA0GCSqGSIb3DQEBCwUAMIGnMQswCQYD
20
+ VQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5j
21
+ aXNjbzEVMBMGA1UECgwMSG90c2NoZWR1bGVzMQ4wDAYDVQQLDAVJbmZyYTEfMB0G
22
+ A1UEAwwWaW5mcmEuaG90c2NoZWR1bGVzLmNvbTEjMCEGCSqGSIb3DQEJARYUb3Nz
23
+ QGhvdHNjaGVkdWxlcy5jb20wHhcNMTcwMjE4MDA1NDU4WhcNMjEwMjE4MDA1NDU4
24
+ WjCBpzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcM
25
+ DVNhbiBGcmFuY2lzY28xFTATBgNVBAoMDEhvdHNjaGVkdWxlczEOMAwGA1UECwwF
26
+ SW5mcmExHzAdBgNVBAMMFmluZnJhLmhvdHNjaGVkdWxlcy5jb20xIzAhBgkqhkiG
27
+ 9w0BCQEWFG9zc0Bob3RzY2hlZHVsZXMuY29tMIIBKDANBgkqhkiG9w0BAQEFAAOC
28
+ ARUAMIIBEAKCAQcAutTytHjHFb5yK/29POqMS3DyxRSRRbKvBus/rEL3reeKDVlf
29
+ eO9a/9U3oUcxHFHeISF9uOBSvL88svxhLqxkKLVA0vMbVgDFoGsOlh93nA5Lmw+H
30
+ SEzG3+Z6JqH8YfAIqVyp1nZcdtC7u8xYpDD65ayjRALLuvOUXORGeqgedlgiwwLp
31
+ 2tZ7A9tCzBZnDjcNenD8zXLCOdRjJiBPq/XQS9h4POWvpom0z+jyUkRj3ojqOoXW
32
+ bKKdXzdZ3s5BSwgxlWJo+lK/50+xLpjJe4mEJwySkrluy8GOG/UR/j+Y4I1j1FbY
33
+ RwT9SUSairjh0zgiDC0LTjAJBIenuxxuM9jhRyoiu+YYVwIDAQABo1AwTjAdBgNV
34
+ HQ4EFgQUtlFsvLIJ59o2GyoRTXKEIPEgnn8wHwYDVR0jBBgwFoAUtlFsvLIJ59o2
35
+ GyoRTXKEIPEgnn8wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQcAdELJ
36
+ QdrR55Xak3q5IhLnIdOLJC6ZEdHI2173SSmytInyDX6fe9uZION4I9WCCm/hCp+t
37
+ QILh4feu14iDWmBxzy6F6tiyuEjhaU5Ud9wZ/YDBQhP2AHquoPAufxXZAUFlA5er
38
+ wIYVupToBrWavfbjgRqRHAZ6vwrLwoIiomh2/wv06HLrFmSzj5q6BVp7FFMKDail
39
+ QWzJ4aQl786RMwPa776eVaKQTmQuTUUppvhVq9QdKyxwGPibAYGbYKZwmmtx+BV2
40
+ GJevNV8BSuhh6m2AHCxEzMaD7WKNbewTTgGLUlvppaR9SE2V/yUZ7x1Vp8/mGeO6
41
+ 2Zk648Ep9HVPKmwoVuB75+xEQw==
42
+ -----END CERTIFICATE-----
43
+
44
+ date: 2017-03-15 00:00:00 Z
45
+ dependencies:
46
+ - !ruby/object:Gem::Dependency
47
+ name: fluentd
48
+ prerelease: false
49
+ requirement: &id001 !ruby/object:Gem::Requirement
50
+ none: false
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ hash: 55
55
+ segments:
56
+ - 0
57
+ - 10
58
+ - 0
59
+ version: 0.10.0
60
+ type: :runtime
61
+ version_requirements: *id001
62
+ description: Input parser for records which require minor text processing before they can be parsed as JSON
63
+ email:
64
+ - oss@hotschedules.com
65
+ executables: []
66
+
67
+ extensions: []
68
+
69
+ extra_rdoc_files: []
70
+
71
+ files:
72
+ - .gitignore
73
+ - LICENSE
74
+ - LICENSE-Apache-2.0.txt
75
+ - README.md
76
+ - certs/oss@hotschedules.com.cert
77
+ - fluent-plugin-jsonish.gemspec
78
+ - lib/fluent/plugin/parser_jsonish.rb
79
+ - lib/fluent/plugin/parser_nginx_jsonish.rb
80
+ - lib/fluent/plugin/parser_nodejs_bunyan.rb
81
+ homepage: https://github.com/bodhi-space/fluent-plugin-jsonish
82
+ licenses:
83
+ - Apache-2.0
84
+ post_install_message:
85
+ rdoc_options: []
86
+
87
+ require_paths:
88
+ - lib
89
+ required_ruby_version: !ruby/object:Gem::Requirement
90
+ none: false
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ hash: 3
95
+ segments:
96
+ - 0
97
+ version: "0"
98
+ required_rubygems_version: !ruby/object:Gem::Requirement
99
+ none: false
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ hash: 3
104
+ segments:
105
+ - 0
106
+ version: "0"
107
+ requirements: []
108
+
109
+ rubyforge_project:
110
+ rubygems_version: 1.8.25
111
+ signing_key:
112
+ specification_version: 3
113
+ summary: Input parser for records which require minor text processing before they can be parsed as JSON. Also allows names of standard Time parser methods to be passed as time_format arguments and sets a reasonable default (iso8601).
114
+ test_files: []
115
+
metadata.gz.sig ADDED
Binary file