logstash-filter-java_stack_digest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0dd81d1918a7eb930634c65283b9716c753c3721f87659aff1ff471ed40f6db
+  data.tar.gz: 174b1436664b23d69003d2ad96423e9162b60e62e16ede20173ae2f996c98732
+SHA512:
+  metadata.gz: 0d95b2391c05acea7d7da3fad911930d9ef2d69cb95f61d6d643685b15c7a1b946c8c89ef4a509efc291d954d3f9e16dcc018a6840e151dd8c6967b2df7bd884
+  data.tar.gz: 412c45a60b44075a197c714bcbe3ec2b18ae91569ec98393d1e44a4afc467fee7ea81d3e2068bb208290fc4eb714f07e453705738adffaecbfd3e4e2ac122747

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Pierre Smeyers - pismy
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-filter-java_stack_digest
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,11 @@
+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.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/java_stack_digest.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# If the input event contains a Java stack trace, this filter computes a stable digest of it and adds it
+# in a field of the output event
+class LogStash::Filters::JavaStackDigest < LogStash::Filters::Base
+
+  # Setting the config_name here is required. This is how you
+  # configure this filter from your Logstash config.
+  #
+  # java_stack_digest {
+  #   {
+  #     source => "stack_trace"
+  #   }
+  # }
+  #
+  config_name "java_stack_digest"
+
+  # activates debug traces
+  config :debug, :validate => :boolean, :default => false
+
+  # The name of the input field supposed to contain the Java stack trace (default 'stack_trace').
+  config :source, :validate => :string, :default => "stack_trace"
+
+  # The name of the output field to assign the computed stack trace digest (default 'stack_digest').
+  config :target, :validate => :string, :default => "stack_digest"
+
+  # Determines whether stack trace elements without source info (no filename or line number) should be excluded from the digest (default 'true')
+  config :exclude_no_source, :validate => :boolean, :default => true
+
+  # Array of regular expressions to exclude stack trace elements
+  # defaults to standard dynamic classes and method invocations
+  # config :excludes, :validate => :array, :default => %w["\\$\\$FastClassByCGLIB\\$\\$", "\\$\\$EnhancerBySpringCGLIB\\$\\$", "^sun\\.reflect\\..*\\.invoke", "^com\\.sun\\.", "^sun\\.net\\.", "^java\\.lang\\.reflect\\.Method\\.invoke", "^net\\.sf\\.cglib\\.proxy\\.MethodProxy\\.invoke", "^java\\.util\\.concurrent\\.ThreadPoolExecutor\\.runWorker","^java\\.lang\\.Thread\\.run$" ]
+  config :excludes, :validate => :array, :default => [/\$\$FastClassByCGLIB\$\$/, /\$\$EnhancerBySpringCGLIB\$\$/, /^sun\.reflect\..*\.invoke/, /^com\.sun\./, /^sun\.net\./, /^java\.lang\.reflect\.Method\.invoke/, /^net\.sf\.cglib\.proxy\.MethodProxy\.invoke/, /^java\.util\.concurrent\.ThreadPoolExecutor\.runWorker/, /^java\.lang\.Thread\.run$/ ]
+
+  public
+  def register
+    # Add instance variables
+
+    # Regexp to capture the Error classname from the first stack trace line
+    # group 1: error classname
+    @error_pattern = /((?:[\w$]+\.){2,}[\w$]+):/
+
+    # Regexp to extract stack trace elements information
+    # group 1: classname+method
+    # group 2: filename (optional)
+    # group 3: line number (optional)
+    @stack_element_pattern = /^\s+at\s+((?:[\w$]+\.){2,}[\w$]+)\((?:([^:]+)(?::(\d+))?)?\)/
+
+    # coerce excludes to an array of Regexp
+    @excludes = @excludes.collect {|pattern| Regexp::new(pattern)}
+  end # def register
+
+  public
+  def filter(event)
+
+    stack_trace = event.get(@source)
+
+    return if stack_trace.nil? || stack_trace.empty?
+
+    event.set(@target, compute_digest(stack_trace.split("\n"), 0))
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+
+  # computes a Java stack trace digest
+  def compute_digest(stack_trace, level)
+
+    # 1: extract error class from first line
+    error_class = @error_pattern.match(stack_trace.shift)
+    puts "Error (#{level}) #{error_class}:" if @debug
+    md5 = Digest::MD5.new
+    # digest: error classname
+    md5.update error_class[1]
+
+    # 2: read all stack trace elements until stack trace is empty or we hit the next error
+    ste_count = 0
+    while not stack_trace.empty?
+      if stack_trace.first.start_with?(' ') or stack_trace.first.start_with?("\t")
+        # current line starts with a whitespace: is it a stack trace element ?
+        stack_element = @stack_element_pattern.match(stack_trace.first)
+        if stack_element
+          # current line is a stack trace element
+          ste_count+=1
+          if is_excluded?(stack_element)
+            puts "  (-) at #{stack_element[1]}(#{stack_element[2]}:#{stack_element[3]})" if @debug
+          else
+            puts "  (+) at #{stack_element[1]}(#{stack_element[2]}:#{stack_element[3]})" if @debug
+            # digest: STE classname and method
+            md5.update stack_element[1]
+            # digest: line number (if present)
+            if not (stack_element[3].nil? or stack_element[3].empty?)
+              md5.update stack_element[3]
+            end
+          end
+        end
+      elsif(ste_count > 0)
+        # current line doesn't start with a whitespace and we've already read stack trace elements: is it the next error in the stack
+        break
+      end
+      # move to next line
+      stack_trace.shift
+    end
+
+    # 3: if stack trace not empty, compute digest for next error
+    if not stack_trace.empty?
+      md5.update compute_digest(stack_trace, level+1)
+    end
+
+    return md5.hexdigest
+  end
+
+  def is_excluded?(stack_element)
+    # 1: exclude elements without source info ?
+    if @exclude_no_source and (stack_element[2].nil? or stack_element[2].empty?) and (stack_element[3].nil? or stack_element[3].empty?)
+      return true
+    end
+    # 2: Regex based exclusion
+    @excludes.each do |pattern|
+      if pattern.match(stack_element[1])
+        return true
+      end
+    end
+    return false
+  end
+
+end # class LogStash::Filters::JavaStackDigest

data/logstash-filter-java_stack_digest.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-java_stack_digest'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash filter that computes a digest of Java stack traces.'
+  s.description   = 'Logstash filter that computes a digest of Java stack traces.'
+  s.homepage      = 'https://github.com/pismy/logstash-filter-java_stack_digest'
+  s.authors       = ['Pierre Smeyers']
+  s.email         = 'pierre.smeyers@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/java_stack_digest_spec.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/java_stack_digest"
+
+describe LogStash::Filters::JavaStackDigest do
+  stack_trace = %q(com.xyz.MyApp$MyClient$MyClientException: An error occurred while getting Alice's things
+and the error message wraps on
+ several lines
+  at com.xyz.MyApp$MyClient.getTheThings(MyApp.java:26)
+  at com.xyz.MyApp$MyService.displayThings(MyApp.java:16)
+  at com.xyz.MyApp$MyService$$FastClassByCGLIB$$e7645040.invoke()
+  at net.sf.cglib.proxy.MethodProxy.invoke()
+  at org.springframework.aop.framework.Cglib2AopProxy$CglibMethodInvocation.invokeJoinpoint()
+  at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed()
+  at org.springframework.aop.aspectj.MethodInvocationProceedingJoinPoint.proceed()
+  at sun.reflect.NativeMethodAccessorImpl.invoke0()
+  at sun.reflect.NativeMethodAccessorImpl.invoke()
+  at sun.reflect.DelegatingMethodAccessorImpl.invoke()
+  at java.lang.reflect.Method.invoke()
+  at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethodWithGivenArgs()
+  at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethod()
+  at org.springframework.aop.aspectj.AspectJAroundAdvice.invoke()
+  at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed()
+  at org.springframework.aop.interceptor.AbstractTraceInterceptor.invoke()
+  at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed()
+  at org.springframework.transaction.interceptor.TransactionInterceptor.invoke()
+  at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed()
+  at org.springframework.aop.interceptor.ExposeInvocationInterceptor.invoke()
+  at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed()
+  at org.springframework.aop.framework.Cglib2AopProxy$DynamicAdvisedInterceptor.intercept()
+  at com.xyz.MyApp$MyService$$EnhancerBySpringCGLIB$$c673c675.displayThings(<generated>)
+  at sun.reflect.GeneratedMethodAccessor647.invoke(Unknown Source)
+  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
+  at java.lang.reflect.Method.invoke(Method.java:498)
+  at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
+  at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:133)
+  at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:116)
+  at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:827)
+  at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:738)
+  at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)
+  at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:963)
+  at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:897)
+  at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:970)
+  at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:861)
+  at javax.servlet.http.HttpServlet.service(HttpServlet.java:624)
+  at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:846)
+  at javax.servlet.http.HttpServlet.service(HttpServlet.java:731)
+  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:303)
+  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208)
+  at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)
+  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241)
+  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208)
+  ...
+  at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:331)
+  at org.springframework.security.web.FilterChainProxy.doFilterInternal(FilterChainProxy.java:214)
+  at org.springframework.security.web.FilterChainProxy.doFilter(FilterChainProxy.java:177)
+  at org.springframework.web.filter.DelegatingFilterProxy.invokeDelegate(DelegatingFilterProxy.java:346)
+  at org.springframework.web.filter.DelegatingFilterProxy.doFilter(DelegatingFilterProxy.java:262)
+  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241)
+  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208)
+  ...
+  at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:116)
+  at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:436)
+  at org.apache.coyote.http11.AbstractHttp11Processor.process(AbstractHttp11Processor.java:1078)
+  at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:625)
+  at org.apache.tomcat.util.net.JIoEndpoint$SocketProcessor.run(JIoEndpoint.java:316)
+  at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
+  at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
+  at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
+  at java.lang.Thread.run(Thread.java:748)
+  ...
+Caused by: com.xyz.MyApp$HttpStack$HttpError: I/O error on GET http://dummy/user/alice/things
+  at com.xyz.MyApp$HttpStack.get(MyApp.java:40)
+  at com.xyz.MyApp$MyClient.getTheThings(MyApp.java:24)
+  ... 23 common frames omitted
+Caused by: java.net.SocketTimeoutException: Read timed out
+  at com.xyz.MyApp$HttpStack.get(MyApp.java:38)
+  ... 24 common frames omitted)
+
+  # ---------------------------------------------------------------------
+  describe "Digest should be computed if stack trace present" do
+    let(:config) do <<-CONFIG
+      filter {
+        java_stack_digest {
+        }
+      }
+    CONFIG
+    end
+
+    sample("stack_trace" => stack_trace) do
+      expect(subject).to include("stack_digest")
+      expect(subject.get('stack_digest')).to eq('e801d2223555804c354eba382af40487')
+    end
+  end
+
+  # ---------------------------------------------------------------------
+  describe "Digest should not be computed if stack not trace present" do
+    let(:config) do <<-CONFIG
+      filter {
+        java_stack_digest {
+        }
+      }
+    CONFIG
+    end
+
+    sample("field" => "value") do
+      expect(subject).not_to include("stack_digest")
+    end
+  end
+
+  # ---------------------------------------------------------------------
+  describe "Digest with exclusion config 1" do
+    let(:config) do <<-CONFIG
+      filter {
+        java_stack_digest {
+          exclude_no_source => false
+        }
+      }
+    CONFIG
+    end
+
+    sample("stack_trace" => stack_trace) do
+      expect(subject).to include("stack_digest")
+      expect(subject.get('stack_digest')).to eq('498f8151629971495ed5dd8c3713d45e')
+    end
+  end
+
+  # ---------------------------------------------------------------------
+  describe "Digest with exclusion config 2" do
+    let(:config) do <<-CONFIG
+      filter {
+        java_stack_digest {
+          exclude_no_source => false
+          excludes => ['\\$\\$FastClassByCGLIB\\$\\$', '\\$\\$EnhancerBySpringCGLIB\\$\\$']
+        }
+      }
+    CONFIG
+    end
+
+    sample("stack_trace" => stack_trace) do
+      expect(subject).to include("stack_digest")
+      expect(subject.get('stack_digest')).to eq('ff887f4f5d9e588df37afbb4ceee6980')
+    end
+  end
+
+  # ---------------------------------------------------------------------
+  describe "Digest should be computed if stack trace present with non default config" do
+    let(:config) do <<-CONFIG
+      filter {
+        java_stack_digest {
+          source => "java_stack"
+          target => "stack_md5"
+        }
+      }
+    CONFIG
+    end
+
+    sample("java_stack" => stack_trace) do
+      expect(subject).to include("stack_md5")
+      expect(subject.get('stack_md5')).to eq('e801d2223555804c354eba382af40487')
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-java_stack_digest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre Smeyers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Logstash filter that computes a digest of Java stack traces.
+email: pierre.smeyers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/java_stack_digest.rb
+- logstash-filter-java_stack_digest.gemspec
+- spec/filters/java_stack_digest_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pismy/logstash-filter-java_stack_digest
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: Logstash filter that computes a digest of Java stack traces.
+test_files:
+- spec/filters/java_stack_digest_spec.rb
+- spec/spec_helper.rb