fluent-plugin-detect-exceptions 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3fc8ac42bca6d07ddc0c8131203df18a0e5eb2bf
4
+ data.tar.gz: ac0298c30ec7cc47eca96ccf29dcd13b47b56bcc
5
+ SHA512:
6
+ metadata.gz: 57aa45c609ccecc24362272b55f99a58d5fa27b7c3eb85b73f52643755585c0a700917914b4c0e8d75b21f986df27b8fddf457a8604a0a0c4f0e1090cd8da204
7
+ data.tar.gz: 7d20fbf7734e321285738856b022663764440090dc4cfaef21e38b6850863af9b1b9cfa28a9821ae21a2a7c1121f0b6f4d8320e611dfcea6424553d0db3ee357
data/CONTRIBUTING ADDED
@@ -0,0 +1,24 @@
1
+ Want to contribute? Great! First, read this page (including the small print at the end).
2
+
3
+ ### Before you contribute
4
+ Before we can use your code, you must sign the
5
+ [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
6
+ (CLA), which you can do online. The CLA is necessary mainly because you own the
7
+ copyright to your changes, even after your contribution becomes part of our
8
+ codebase, so we need your permission to use and distribute your code. We also
9
+ need to be sure of various other things—for instance that you'll tell us if you
10
+ know that your code infringes on other people's patents. You don't have to sign
11
+ the CLA until after you've submitted your code for review and a member has
12
+ approved it, but you must do it before we can put your code into our codebase.
13
+ Before you start working on a larger contribution, you should get in touch with
14
+ us first through the issue tracker with your idea so that we can help out and
15
+ possibly guide you. Coordinating up front makes it much easier to avoid
16
+ frustration later on.
17
+
18
+ ### Code reviews
19
+ All submissions, including submissions by project members, require review. We
20
+ use Github pull requests for this purpose.
21
+
22
+ ### The small print
23
+ Contributions made by corporations are covered by a different agreement than
24
+ the one above, the Software Grant and Corporate Contributor License Agreement.
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,60 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ fluent-plugin-detect-exceptions (0.0.1)
5
+ fluentd (~> 0.10, <= 0.13)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ ast (2.3.0)
11
+ cool.io (1.4.5)
12
+ fluentd (0.12.29)
13
+ cool.io (>= 1.2.2, < 2.0.0)
14
+ http_parser.rb (>= 0.5.1, < 0.7.0)
15
+ json (>= 1.4.3)
16
+ msgpack (>= 0.5.11, < 0.6.0)
17
+ sigdump (~> 0.2.2)
18
+ string-scrub (>= 0.0.3, <= 0.0.5)
19
+ tzinfo (>= 1.0.0)
20
+ tzinfo-data (>= 1.0.0)
21
+ yajl-ruby (~> 1.0)
22
+ http_parser.rb (0.6.0)
23
+ json (2.0.2)
24
+ msgpack (0.5.12)
25
+ parser (2.3.1.4)
26
+ ast (~> 2.2)
27
+ power_assert (0.3.1)
28
+ powerpack (0.1.1)
29
+ rainbow (2.1.0)
30
+ rake (10.5.0)
31
+ rubocop (0.42.0)
32
+ parser (>= 2.3.1.1, < 3.0)
33
+ powerpack (~> 0.1)
34
+ rainbow (>= 1.99.1, < 3.0)
35
+ ruby-progressbar (~> 1.7)
36
+ unicode-display_width (~> 1.0, >= 1.0.1)
37
+ ruby-progressbar (1.8.1)
38
+ sigdump (0.2.4)
39
+ string-scrub (0.0.5)
40
+ test-unit (3.2.2)
41
+ power_assert
42
+ thread_safe (0.3.5)
43
+ tzinfo (1.2.2)
44
+ thread_safe (~> 0.1)
45
+ tzinfo-data (1.2016.9)
46
+ tzinfo (>= 1.0.0)
47
+ unicode-display_width (1.1.1)
48
+ yajl-ruby (1.3.0)
49
+
50
+ PLATFORMS
51
+ ruby
52
+
53
+ DEPENDENCIES
54
+ fluent-plugin-detect-exceptions!
55
+ rake (~> 10.3)
56
+ rubocop (= 0.42.0)
57
+ test-unit (~> 3.0)
58
+
59
+ BUNDLED WITH
60
+ 1.13.6
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.rdoc ADDED
@@ -0,0 +1,86 @@
1
+ = Exception detector plugin for {fluentd}[http://github.com/fluent/fluentd]
2
+
3
+ fluent-plugin-detect-exceptions is an
4
+ {output plugin for fluentd}[http://docs.fluentd.org/articles/output-plugin-overview]
5
+ which scans a log stream text messages or JSON records for multi-line exception
6
+ stack traces: If a consecutive sequence of log messages forms an exception stack
7
+ trace, the log messages are forwarded as a single, combined log message.
8
+ Otherwise, the input log data is forwarded as is.
9
+
10
+ Text log messages are assumed to contain single lines and are combined by
11
+ concatenating them.
12
+
13
+ For JSON records, the log message is taken from a configurable message field
14
+ of the log record. The message field is assumed to contain a single line of
15
+ text. If the message fields of a consecutive sequence of logs records
16
+ form an exception stack, they are combined to a single log record by taking
17
+ the first log record of the sequence and replacing the content of the message
18
+ field with the concatenated content of all message fields in the sequence.
19
+ Note that the content of other fields in the records of the sequence are thus
20
+ not reflected in the combined output. This plugin is intended to be used in
21
+ cases where the content of log records that belong to a single exception stack
22
+ are so similar (e.g. because they contain the timestamp of the log entry) that
23
+ this loss of information is irrelevant.
24
+
25
+ This is NOT an official Google product.
26
+
27
+ {<img src="https://badge.fury.io/rb/fluent-plugin-detect-exceptions.svg" alt="Gem Version" />}[http://badge.fury.io/rb/fluent-plugin-detect-exceptions]
28
+ {<img src="https://secure.travis-ci.org/GoogleCloudPlatform/fluent-plugin-detect-exceptions.png" alt="Build Status" />}[https://travis-ci.org/GoogleCloudPlatform/fluent-plugin-detect-exceptions]
29
+
30
+ == Installation
31
+
32
+ This gem is hosted at
33
+ {RubyGems.org}[https://rubygems.org/gems/fluent-plugin-detect-exceptions]
34
+ and can be installed using:
35
+
36
+ $ gem install fluent-plugin-detect-exceptions
37
+
38
+ Installing {google-fluentd}[https://cloud.google.com/logging/docs/agent/]
39
+ will also install and configure the gem.
40
+
41
+ == Configuration
42
+
43
+ The plugin supports the following parameters:
44
+
45
+ [message] Name of the field in the JSON record that contains the
46
+ single-line log messages that shall be scanned for exceptions.
47
+ Default: 'message'.
48
+
49
+ [remove_tag_prefix] The prefix to remove from the input tag when outputting
50
+ a record. A prefix has to be a complete tag part.
51
+ Example: If remove_tag_prefix is set to 'foo', the input tag
52
+ foo.bar.baz is transformed to bar.baz and the input tag
53
+ 'foofoo.bar' is not modified. Default: empty string.
54
+
55
+ [languages] A list of language for which exception stack traces shall be
56
+ detected. The values in the list can be separated by commas or
57
+ written as JSON list.
58
+ Supported values: java, js, csharp, python, go, ruby, php, all.
59
+ Default: all.
60
+
61
+ [multiline_flush_interval] Interval in seconds after which a (possibly not
62
+ yet complete) buffered exception stack shall be
63
+ forwarded. If not set, incomplete exceptions stacks
64
+ are not flushed.
65
+
66
+ [max_lines] Maximum number of lines in a detected exception stack trace.
67
+ If this maximum number is exceeded, the detected exception stack
68
+ trace that has been detected so far will be output as a single
69
+ log message and the detection will start from scratch.
70
+ This is intended as a safeguard against buffering very large
71
+ amounts of data before outputting them to the log stream.
72
+ Default: 1000.
73
+
74
+ Example configuration:
75
+
76
+ <match **>
77
+ remove_tag_prefix foo
78
+ message log
79
+ languages java, python
80
+ multiline_flush_interval 0.1
81
+ </match>
82
+
83
+ == Copyright
84
+
85
+ Copyright:: Copyright 2016 Google Inc. All rights reserved.
86
+ License:: Apache License, Version 2.0
data/Rakefile ADDED
@@ -0,0 +1,38 @@
1
+ #!/usr/bin/env rake
2
+
3
+ require 'bundler'
4
+ Bundler::GemHelper.install_tasks
5
+
6
+ require 'rake/testtask'
7
+ require 'rubocop/rake_task'
8
+
9
+ desc 'Run Rubocop to check for style violations'
10
+ RuboCop::RakeTask.new
11
+
12
+ desc 'Run benchmark tests'
13
+ Rake::TestTask.new(:bench) do |test|
14
+ test.libs << 'lib' << 'test'
15
+ test.test_files = FileList['test/plugin/bench*.rb']
16
+ test.verbose = true
17
+ end
18
+
19
+ desc 'Run unit tests'
20
+ Rake::TestTask.new(:test) do |test|
21
+ test.libs << 'lib' << 'test'
22
+ test.test_files = FileList['test/plugin/test*.rb']
23
+ test.verbose = true
24
+ end
25
+
26
+ # Building the gem will use the local file mode, so ensure it's world-readable.
27
+ desc 'Check plugin file permissions'
28
+ task :check_perms do
29
+ plugin = 'lib/fluent/plugin/out_detect_exceptions.rb'
30
+ mode = File.stat(plugin).mode & 0o777
31
+ raise "Unexpected mode #{mode.to_s(8)} for #{plugin}" unless
32
+ mode & 0o444 == 0o444
33
+ end
34
+
35
+ desc 'Run unit tests and RuboCop to check for style violations'
36
+ task all: [:test, :rubocop, :check_perms]
37
+
38
+ task default: :all
@@ -0,0 +1,28 @@
1
+ Gem::Specification.new do |gem|
2
+ gem.name = 'fluent-plugin-detect-exceptions'
3
+ gem.description = <<-eos
4
+ Fluentd output plugin which detects exception stack traces in a stream of
5
+ JSON log messages and combines all single-line messages that belong to the
6
+ same stack trace into one multi-line message.
7
+ This is an official Google Ruby gem.
8
+ eos
9
+ gem.summary = \
10
+ 'fluentd output plugin for combining stack traces as multi-line JSON logs'
11
+ gem.homepage = \
12
+ 'https://github.com/GoogleCloudPlatform/fluent-plugin-detect-exceptions'
13
+ gem.license = 'Apache-2.0'
14
+ gem.version = '0.0.1'
15
+ gem.authors = ['Thomas Schickinger']
16
+ gem.email = ['schickin@google.com']
17
+ gem.required_ruby_version = Gem::Requirement.new('>= 2.0')
18
+
19
+ gem.files = Dir['**/*'].keep_if { |file| File.file?(file) }
20
+ gem.test_files = gem.files.grep(/^(test)/)
21
+ gem.require_paths = ['lib']
22
+
23
+ gem.add_runtime_dependency 'fluentd', '~> 0.10', '<= 0.13'
24
+
25
+ gem.add_development_dependency 'rake', '~> 10.3'
26
+ gem.add_development_dependency 'rubocop', '= 0.42.0'
27
+ gem.add_development_dependency 'test-unit', '~> 3.0'
28
+ end