logstash-filter-referer 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c421bddc502b8831907b2acf41c045682947b81c
-  data.tar.gz: b1ed44a30d985e152b226ab82cb2590d67ea0882
+  metadata.gz: 2e1ceedb027895c2e0548c82e6a8de5567d630aa
+  data.tar.gz: ff5a4975a0840a2b00cc60d7e1bae07efa376b24
 SHA512:
-  metadata.gz: fc699d638e7605dfbe87b01b5777e1452112494fa2c0590d269c6880b2774b4712ea57f5224fc1fca38385eed0b16383253905772cfe5496da0d7b5cee79dbbd
-  data.tar.gz: 26fdac634255b3472686dd23f452c0964cc40683fb49946e0f123a2fdf0df4f4ffc2f58de84d9618b7eba7d1fa3b12531a6b33a6552adeac37e3ffac3efcfb9b
+  metadata.gz: d3b10591b69824df9077515b5aaa80cf07a5ea60e37b599dbf6295c3695a015c3d866376c9560e1e0cf4d2ce396cd180422236652d66d8b05f883e0cc727e247
+  data.tar.gz: 075cb3a81df2e85b248f9363a613538540150619cce8db45fa989dce620cfd6fb621467b2845fcb6754c8d8acc9f135c1de5081d96fcfe079852a38d55d4e288

data/lib/logstash/filters/referer.rb

@@ -4,31 +4,33 @@ require "logstash/namespace"
 require "yaml"
 require "uri"
 
-# https://github.com/piwik/searchengine-and-social-list
-
-# This example filter will replace the contents of the default
-# message field with whatever you specify in the configuration.
+# Referer plugin get information from the referer field in http logs.
+# This plugin can tell if a website is "social" or "search engine".
+# For Search engine, the query is extracted.
 #
-# It is only intended to be used as an example.
+# Patterns came from the Piwik project :
+# see <https://github.com/piwik/searchengine-and-social-list>
 class LogStash::Filters::Referer < LogStash::Filters::Base
 
   # Setting the config_name here is required. This is how you
   # configure this filter from your Logstash config.
   #
   # filter {
-  #   example {
-  #     message => "My message..."
+  #   referer {
+  #     source => "referer"
   #   }
   # }
   #
-  config_name "referer"
+  config_name 'referer'
 
+  # The field containing the referer url
   config :source, :validate => :string, :required => true
+
+  # Specify the field into which Logstash should store the referer data.
   config :target, :validate => :string, :default => 'referer'
 
   public
   def register
-    # Add instance variables
     path = ::File.expand_path('../../../vendor/Socials.yml', ::File.dirname(__FILE__))
     @social = Hash.new
     YAML.load(File.open(path, 'r').read).each do |key, values|
@@ -109,4 +111,4 @@ class LogStash::Filters::Referer < LogStash::Filters::Base
     # filter_matched should go in the last line of our successful code
     filter_matched(event)
   end # def filter
-end # class LogStash::Filters::Example
+end # class LogStash::Filters::Referer

data/logstash-filter-referer.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-referer'
-  s.version = '0.1'
+  s.version = '0.2'
   s.licenses = ['Apache License (2.0)']
-  s.summary = "Build information about referer"
+  s.summary = "Logstash plugin for getting information from http referer"
   s.description = ""
   s.authors = ["athoune"]
   s.email = 'mathieu@garambrogne.net'
@@ -10,8 +10,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
-   # Tests
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-referer
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - athoune
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2015-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -88,7 +88,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
-summary: Build information about referer
+summary: Logstash plugin for getting information from http referer
 test_files:
 - spec/filters/referer_spec.rb
 - spec/spec_helper.rb