logstash-input-varnishncsa 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92cfd4712bce564f03d74d66698d594756468938
+  data.tar.gz: f61dbfeeafd939de2256f3be27b0d56b99f53115
+SHA512:
+  metadata.gz: 6326e0364864b985d44927e649c7f2408436f06202e46c5a6ce64c308730d71560bff2df5728c81b71d27e791d60f591942a0a19a9ff29d8d629573362d2ed96
+  data.tar.gz: b9718c14c33946c52be7b0ffc8e9e5bf42477eb01b30bd84da59144bb8900d333b954d0931f0373de73db9492f402d27bdfe0370cf3ac03d1396ce50879f178f

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Francetelevisions <http://www.francetelevisions.fr>
+
+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/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/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/inputs/varnishncsa.rb

@@ -0,0 +1,336 @@
+# encoding: utf-8
+require "scanf"
+require "logstash/inputs/threadable"
+require "logstash/namespace"
+require "socket" # for Socket.gethostname
+
+# Read from varnish cache's shared memory log
+class LogStash::Inputs::Varnishncsa < LogStash::Inputs::Threadable
+  config_name "varnishncsa"
+
+  config :instance, :validate => :string, :default => "default"
+
+  trap("SIGINT") { @@reopen = 1}
+
+  Logline = Struct.new(
+    :df_H,     # %H, Protocol version
+    :df_U,     # %U, URL path
+    :df_q,     # %q, query string
+    :df_b,     # %b, Bytes
+    :df_h,     # %h (host name / IP adress)
+    :df_m,     # %m, Request metho
+    :df_s,     # %s, Status
+    :df_t,     # %t, Date and time, received
+    :df_u,     # %u, Remote user
+    :df_ttfb,  # Time to first byte
+    :df_D,     # %D, time taken to serve the request,
+              # in microseconds, also used for %T
+    :df_hitmiss,   # Whether this is a hit or miss
+    :df_handling,  # How the request was handled (hit/miss/pass/pipe)
+    :active,     # Is log line in an active trans
+    :complete,     # Is log line complete
+    :bitmap,    # Bitmap for regex matches
+    :req_headers, # Request headers
+    :resp_headers, # Response headers
+    :vcl_log,     # VLC_Log entries
+  )
+
+  public
+  def register
+    require 'varnish'
+    @lp = Logline.new
+    clean_logline
+    @lp[:df_hitmiss] = nil
+    @lp[:df_handling] = nil
+    @lp[:active] = false
+    @lp[:complete] = false
+    @vd = Varnish::VSM.VSM_New
+    @@reopen = 0
+    Varnish::VSL.VSL_Setup(@vd)
+    if Varnish::VSM.VSM_n_Arg(@vd, @instance) != 1
+      @logger.warn("varnishlog exception: #{e.inspect}")
+    end
+    Varnish::VSL.VSL_Open(@vd, 1)
+  end # def register
+
+  def run(queue)
+    @q = queue
+    @hostname = Socket.gethostname
+    # callback = Proc.new { |*args| h_ncsa(*args) }
+    Varnish::VSL.VSL_Dispatch(@vd, self.method(:h_ncsa).to_proc, FFI::MemoryPointer.new(:pointer))
+  end # def run
+
+  private
+  def clean_logline(tag = '')
+    @lp[:df_H]         = nil
+    @lp[:df_U]         = nil
+    @lp[:df_q]         = nil
+    @lp[:df_b]         = nil
+    @lp[:df_h]         = nil
+    @lp[:df_m]         = nil
+    @lp[:df_s]         = nil
+    @lp[:df_u]         = nil
+    @lp[:df_ttfb]      = nil
+    @lp[:req_headers]  = []
+    @lp[:resp_headers] = []
+    @lp[:vcl_log]      = []
+  end
+
+  def collect_client(tag, str)
+    case tag
+    # Collect Client
+    when :reqstart
+      if @lp[:active] || @lp[:df_h] != nil
+        clean_logline(tag)
+      end
+      @lp[:active] = true;
+      @lp[:df_h] = str.split(' ').first
+    when :rxrequest
+      if @lp[:active]
+        if @lp[:df_m] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_m] = str
+        end
+      end
+    when :rxurl
+      if @lp[:active]
+        if @lp[:df_U] != nil || @lp[:df_q] != nil
+          clean_logline(tag)
+        else
+          qs = str.index('?')
+          if qs
+            @lp[:df_U] =  str[0, qs]
+            @lp[:df_q] =  str[qs, str.length]
+          else
+            @lp[:df_U] =  str
+          end
+        end
+      end
+    when :rxprotocol
+      if @lp[:active]
+        if @lp[:df_H] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_H] = str
+        end
+      end
+    when :txstatus
+      if @lp[:active]
+        if @lp[:df_s] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_s] = str
+        end
+      end
+    when :rxheader || :txheader
+      if @lp[:active]
+        split = str.index(':')
+        if !split == nil
+          if tag == :rxheader && str[0, split] == "Authorization" && str[split+2, str.length] == "basic"
+            @lp[:df_u] = str
+          end
+        else
+          if tag == :rxheader
+            @lp[:req_headers].push({str[0, split] => str[split+2, str.length]})
+          else
+            @lp[:resp_headers].push({str[0, split] => str[split+2, str.length]})
+          end
+        end
+      end
+    when :vcl_log
+      if @lp[:active]
+        split = str.index(':')
+        if !split == nil
+          @lp[:vcl_log].push({str[0, split] => str[split+2, str.length]})
+        end
+      end
+    when :vcl_call
+      if @lp[:active]
+        if str == "hit"
+          @lp[:df_hitmiss] = "hit"
+          @lp[:df_handling] = "hit"
+        elsif str == "miss"
+          @lp[:df_hitmiss] = "miss"
+          @lp[:df_handling] = "miss"
+        elsif str == "pass"
+          @lp[:df_hitmiss] = "miss"
+          @lp[:df_handling] = "pass"
+        elsif str == "pipe"
+          clean_logline(tag)
+        end
+      end
+    when :length
+      if @lp[:active]
+        if @lp[:df_b] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_b] = str
+        end
+      end
+    when :sessionclose
+      if @lp[:active]
+        if str ==  "pipe" || str ==  "error"
+          clean_logline(tag)
+        end
+      end
+    when :reqend
+      t_req   = str.scanf("%*u %f %f %*u.%*u %s")
+      t_start = t_req[0]
+      t_end   = t_req[1]
+      ttfb    = t_req[2]
+      if @lp[:active]
+        @lp[:df_ttfb] = ttfb
+        @lp[:df_D] = t_end - t_start
+        @lp[:df_t] = Time.at(t_start)
+        @lp[:complete] = true
+      end
+    end
+  end
+
+  def collect_backend(tag, str)
+    case tag
+    # Collect Backend
+    when :backendopen
+      if @lp[:active] || @lp[:df_h] != nil
+        clean_logline(tag)
+      end
+      @lp[:active] = true;
+      @lp[:df_h]   = str.split(' ')[1]
+    when :txrequest
+      if @lp[:active]
+        if @lp[:df_m] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_m] = str
+        end
+      end
+    when :txurl
+      if @lp[:active]
+        if @lp[:df_U] != nil || @lp[:df_q] != nil
+          clean_logline(tag)
+        else
+          qs = str.index('?')
+          if qs
+            @lp[:df_U] =  str[0, qs]
+            @lp[:df_q] =  str[qs, str.length]
+          else
+            @lp[:df_U] =  str
+          end
+        end
+      end
+    when :txprotocol
+      if @lp[:active]
+        if @lp[:df_H] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_H] = str
+        end
+      end
+    when :rxstatus
+      if @lp[:active]
+        if @lp[:df_s] != nil
+          clean_logline(tag)
+        else
+          @lp[:df_s] = str
+        end
+      end
+    when :rxheader
+      if @lp[:active]
+        split = str.index(':')
+        if str[0, split] == 'Content-Length'
+          @lp[:df_b] = str[split+2, str.length]
+        elsif str[0, split] == 'Date'
+          @lp[:df_t] = DateTime.strptime(str[split+2, str.length], "%a, %d %b %Y %T %Z")
+          if @lp[:df_t] == nil
+            clean_logline(tag)
+          end
+        end
+      end
+    when :txheader
+      if @lp[:active]
+        split = str.index(':')
+        @lp[:req_headers].push({str[0, split] => str[split+2, str.length]})
+      end
+    when :backendclose || :backendreuse
+      if @lp[:active]
+        @lp[:complete] = true
+      end
+    end
+  end
+
+  def h_ncsa(priv, tag, fd, len, spec, ptr, bitmap)
+    begin
+      str = ptr.read_string(len)
+      if spec == :spec_client
+        collect_client(tag, str)
+      elsif spec == :spec_backend
+        collect_backend(tag, str)
+      else
+        return @@reopen
+      end
+      if !@lp[:complete]
+        return @@reopen
+      end
+      # We have a complete data set - log a line
+      headers = Hash.new
+      if @lp[:resp_headers] != []
+        headers = @lp[:resp_headers].reduce Hash.new, :merge
+      elsif @lp[:req_headers] != []
+        headers = @lp[:req_headers].reduce Hash.new, :merge
+      end
+      if !@lp[:df_h].nil?
+        event = LogStash::Event.new("message" => "[#{@lp[:df_t].to_s}] http://#{headers['Host'].to_s}#{@lp[:df_U].to_s}#{@lp[:df_q]} #{@lp[:df_h]}", "host" => @hostname)
+        decorate(event)
+
+        event["varnish_spec"]    = spec.to_s
+        event["clientip"]        = headers['X-Client-IP'].nil? ? headers['X-Forwarded-For'].nil? ? '' : headers['X-Forwarded-For'].split(',').first : headers['X-Client-IP']
+        event["timestamp"]       = @lp[:df_t].to_s
+        event["vhost"]           = headers['Host']
+        event["ident"]           = '-'
+        event["auth"]            = @lp[:df_u].to_s
+        event["verb"]            = @lp[:df_m].to_s
+        event["request"]         = "#{@lp[:df_U].to_s}#{@lp[:df_q]}"
+        event["httpversion"]     = @lp[:df_H].to_s
+        event["rawrequest"]      = "#{@lp[:df_m]} #{@lp[:df_U].to_s}#{@lp[:df_q]} #{@lp[:df_s]}"
+        event["response"]        = @lp[:df_s].to_s
+        event["bytes"]           = @lp[:df_b].to_s
+        event["referrer"]        = headers['Referer']
+        event["agent"]           = headers['User-Agent']
+        event["X-Forwarded-For"] = headers['X-Forwarded-For']
+        event["hitmiss"]         = @lp[:df_hitmiss]
+        event["handling"]        = @lp[:df_handling]
+        event["headers"]         = headers.map {|header| header.lowercase}
+        begin
+          payload = event.to_json
+        rescue Encoding::UndefinedConversionError, ArgumentError
+          puts "FAILUREENCODING : #{@lp[:df_m]} #{@lp[:df_U].to_s}#{@lp[:df_q]} #{@lp[:df_s]}"
+          @logger.error("Failed to convert event to JSON. Invalid UTF-8, maybe?",
+                        :event => event.inspect)
+          return @@reopen
+        end
+
+        @q << event
+
+      end
+      # clean up
+      clean_logline
+      @lp[:df_hitmiss] = nil
+      @lp[:df_handling] = nil
+      @lp[:active] = false
+      @lp[:complete] = false
+    rescue => e
+      @logger.warn("varnishlog exception: #{e.inspect} #{e.backtrace}")
+    ensure
+      return @@reopen
+    end
+  end
+
+  public
+  def close
+    finished
+  end # def close
+  def teardown
+    finished
+  end # def teardown
+end # class LogStash::Inputs::Stdin

data/logstash-input-varnishncsa.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-varnishncsa'
+  s.version         = '2.0.2'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Read from varnish cache's shared memory log and return all value in a logstash field (rewrite of varnishlog in ruby)"
+  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["hans moulron"]
+  s.email           = 'hans.moulron@francetv.fr'
+  s.homepage        = "https://github.com/francetv/logstash-input-varnishncsa"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+
+  # 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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.1.0", "< 3.0.0"
+
+  s.add_runtime_dependency 'varnish-wrapper'
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/inputs/varnishlog_spec.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-varnishncsa
+version: !ruby/object:Gem::Version
+  version: 2.0.2
+platform: ruby
+authors:
+- hans moulron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: varnish-wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
+  a stand-alone program
+email: hans.moulron@francetv.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/varnishncsa.rb
+- logstash-input-varnishncsa.gemspec
+- spec/inputs/varnishlog_spec.rb
+homepage: https://github.com/francetv/logstash-input-varnishncsa
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Read from varnish cache's shared memory log and return all value in a logstash
+  field (rewrite of varnishlog in ruby)
+test_files:
+- spec/inputs/varnishlog_spec.rb