gitlab-fluent-plugin-detect-exceptions 0.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f09ee87a8a03c6b398a42c0bcd4beedc92ed8ae0ea6a22ba5436d92485faeb27
+  data.tar.gz: 21fcb6d72a7d3df71d3087f7bfb0de17807df73670a554f58666049c65c7f81c
+SHA512:
+  metadata.gz: 8aff95c7c068ea0905735bfb76c4577a259cba60685ac25d7f7be3a0c62403c8c7e2bfd4ea4fa6fb7f03362a808da7d36b04305a2b0107c72669dc99615b87c0
+  data.tar.gz: 6b49f2acbc81beb5086fc9ea1190cde7fde9071c7725da812d9c27b932762efa58de30d78f173c2ddecd521342767d53468d19974db0b60693541cdaecb85fd5

data/CONTRIBUTING

@@ -0,0 +1,24 @@
+Want to contribute? Great! First, read this page (including the small print at the end).
+
+### Before you contribute
+Before we can use your code, you must sign the
+[Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
+(CLA), which you can do online. The CLA is necessary mainly because you own the
+copyright to your changes, even after your contribution becomes part of our
+codebase, so we need your permission to use and distribute your code. We also
+need to be sure of various other things—for instance that you'll tell us if you
+know that your code infringes on other people's patents. You don't have to sign
+the CLA until after you've submitted your code for review and a member has
+approved it, but you must do it before we can put your code into our codebase.
+Before you start working on a larger contribution, you should get in touch with
+us first through the issue tracker with your idea so that we can help out and
+possibly guide you. Coordinating up front makes it much easier to avoid
+frustration later on.
+
+### Code reviews
+All submissions, including submissions by project members, require review. We
+use Github pull requests for this purpose.
+
+### The small print
+Contributions made by corporations are covered by a different agreement than
+the one above, the Software Grant and Corporate Contributor License Agreement.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-detect-exceptions (0.0.14)
+      fluentd (>= 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    cool.io (1.7.1)
+    flexmock (2.3.6)
+    fluentd (1.15.3)
+      bundler
+      cool.io (>= 1.4.5, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.9.0)
+      msgpack (>= 1.3.1, < 2.0.0)
+      serverengine (>= 2.3.0, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.4, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      webrick (>= 1.4.2, < 1.8.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.8.0)
+    msgpack (1.6.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    power_assert (2.0.3)
+    powerpack (0.1.3)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.11.0)
+    serverengine (2.3.0)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.5)
+    test-unit (3.5.7)
+      power_assert
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2022.7)
+      tzinfo (>= 1.0.0)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yajl-ruby (1.4.3)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  flexmock (~> 2.0)
+  fluent-plugin-detect-exceptions!
+  rake (~> 10.3)
+  rubocop (= 0.42.0)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,130 @@
+= Exception detector plugin for {fluentd}[http://github.com/fluent/fluentd]
+
+fluent-plugin-detect-exceptions is an
+{output plugin for fluentd}[http://docs.fluentd.org/articles/output-plugin-overview]
+which scans a log stream text messages or JSON records for multi-line exception
+stack traces: If a consecutive sequence of log messages forms an exception stack
+trace, the log messages are forwarded as a single, combined log message.
+Otherwise, the input log data is forwarded as is.
+
+Text log messages are assumed to contain single lines and are combined by
+concatenating them.
+
+For JSON records, the log message is taken from a configurable message field
+of the log record. The message field is assumed to contain a single line of
+text. If the message fields of a consecutive sequence of logs records
+form an exception stack, they are combined to a single log record by taking
+the first log record of the sequence and replacing the content of the message
+field with the concatenated content of all message fields in the sequence.
+Note that the content of other fields in the records of the sequence are thus
+not reflected in the combined output. This plugin is intended to be used in
+cases where the content of log records that belong to a single exception stack
+are so similar (e.g. because they contain the timestamp of the log entry) that
+this loss of information is irrelevant.
+
+This is NOT an official Google product.
+
+{<img src="https://badge.fury.io/rb/fluent-plugin-detect-exceptions.svg" alt="Gem Version" />}[http://badge.fury.io/rb/fluent-plugin-detect-exceptions]
+{<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]
+
+== Installation
+
+This gem is hosted at
+{RubyGems.org}[https://rubygems.org/gems/fluent-plugin-detect-exceptions]
+and can be installed using:
+
+    $ gem install fluent-plugin-detect-exceptions
+
+Installing {google-fluentd}[https://cloud.google.com/logging/docs/agent/]
+will also install and configure the gem.
+
+== Configuration
+
+The plugin supports the following parameters:
+
+=== Required
+
+[remove_tag_prefix]  The prefix to remove from the input tag when outputting
+                     a record. A prefix has to be a complete tag part.
+                     Example: If remove_tag_prefix is set to 'foo', the input
+                     tag foo.bar.baz is transformed to bar.baz and the input tag
+                     'foofoo.bar' is not modified.
+
+=== Optional
+
+[message]  Name of the field in the JSON record that contains the
+           single-line log messages that shall be scanned for exceptions.
+           If this is set to '', the plugin will try 'message' and 'log',
+           in that order.
+           This parameter is only applicable to structured (JSON) log streams.
+           Default: ''.
+
+[languages]  A list of language for which exception stack traces shall be
+             detected. The values in the list can be separated by commas or
+             written as JSON list.
+             Supported values: java, js, csharp, python, go, ruby, php, all.
+             Default: all.
+
+[multiline_flush_interval]  Interval in seconds after which a (possibly not
+                            yet complete) buffered exception stack shall be
+                            forwarded. If not set, incomplete exceptions stacks
+                            are not flushed.
+
+[force_line_breaks]  Force line breaks between each lines when comibining exception stacks.
+                     This is useful if your exception is formatted
+                     as a single line. i.e., logs retrieved from the docker's
+                     logging driver don't have any line break.
+                     Default: false.
+
+[max_lines]  Maximum number of lines in a detected exception stack trace.
+             If this maximum number is exceeded, the exception stack trace
+             that has been detected so far will be output as a single
+             log message and the detection will start from scratch.
+             This is intended as a safeguard against buffering very large
+             amounts of data before outputting them to the log stream.
+             Zero means no limit.
+             Default: 1000.
+
+[max_bytes]  Maximum number of bytes in a detected exception stack trace.
+             If this maximum number is exceeded, the exception stack trace
+             that has been detected so far will be output as a single
+             log message and the detection will start from scratch.
+             This is intended as a safeguard against buffering very large
+             amounts of data before outputting them to the log stream.
+             Zero means no limit.
+             Default: 0.
+
+[stream]  Name of the field in the JSON record that contains the name of a
+          logical log stream within the "real" log stream.
+          The exception detection is handled separately for each logical
+          log stream, i.e., exceptions will be detected even if the messages
+          for the logical log streams are interleaved in the "real" log stream.
+          Consequently, only records in the same logical stream will be
+          combined.
+          This parameter is ignored if set to ''.
+          This parameter is only applicable to structured (JSON) log streams.
+          Default: ''.
+
+Example configuration:
+
+    <match **>
+      @type detect_exceptions
+      remove_tag_prefix foo
+      message log
+      languages java, python
+      multiline_flush_interval 0.1
+    </match>
+
+== Extending language support
+
+Supporting a new language requires new detection rules in this gem and
+additional changes in the
+{Stackdriver Error Reporting}[https://cloud.google.com/error-reporting/]
+service. Please contact our product team by
+{filing a support case}[https://cloud.google.com/support-hub/#google-cloud-platform]
+if you'd like to see support for a new language.
+
+== Copyright
+
+Copyright:: Copyright 2016 Google Inc. All rights reserved.
+License::   Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,48 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+desc 'Run Rubocop to check for style violations'
+RuboCop::RakeTask.new
+
+desc 'Run benchmark tests'
+Rake::TestTask.new(:bench) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/bench*.rb']
+  test.verbose = true
+end
+
+desc 'Run unit tests'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/test*.rb']
+  test.verbose = true
+end
+
+# Building the gem will use the local file mode, so ensure it's world-readable.
+# https://github.com/GoogleCloudPlatform/fluent-plugin-detect-exceptions/issues/32
+desc 'Fix file permissions'
+task :fix_perms do
+  files = [
+    'lib/fluent/plugin/*.rb'
+  ].flat_map do |file|
+    file.include?('*') ? Dir.glob(file) : [file]
+  end
+
+  files.each do |file|
+    mode = File.stat(file).mode & 0o777
+    next unless mode & 0o444 != 0o444
+    puts "Changing mode of #{file} from #{mode.to_s(8)} to "\
+         "#{(mode | 0o444).to_s(8)}"
+    chmod mode | 0o444, file
+  end
+end
+
+desc 'Run unit tests and RuboCop to check for style violations'
+task all: [:test, :rubocop, :fix_perms]
+
+task default: :all

data/gitlab-fluent-plugin-detect-exceptions.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'gitlab-fluent-plugin-detect-exceptions'
+  gem.description   = <<-eos
+   Fluentd output plugin which detects exception stack traces in a stream of
+   JSON log messages and combines all single-line messages that belong to the
+   same stack trace into one multi-line message.
+   This is an official Google Ruby gem.
+eos
+  gem.summary       = \
+    'fluentd output plugin for combining stack traces as multi-line JSON logs'
+  gem.homepage      = \
+    'https://gitlab.com/gitlab-org/ruby/gems/gitlab-fluent-plugin-detect-exceptions'
+  gem.license       = 'Apache-2.0'
+  gem.version       = '0.0.15'
+  gem.authors       = ['Stackdriver Agents']
+  gem.email         = ['stackdriver-agents@google.com']
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.0')
+
+  gem.files         = Dir['**/*'].keep_if { |file| File.file?(file) }
+  gem.test_files    = gem.files.grep(/^(test)/)
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'fluentd', '>= 0.10'
+
+  gem.add_development_dependency 'rake', '~> 10.3'
+  gem.add_development_dependency 'rubocop', '= 0.42.0'
+  gem.add_development_dependency 'test-unit', '~> 3.0'
+  gem.add_development_dependency 'flexmock', '~> 2.0'
+end