logstash-filter-tld 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91de2c319b63ec14eb09f213d34891b0714000b6
+  data.tar.gz: cbec7901e34db15005ae32a5655ebdca16ba9503
+SHA512:
+  metadata.gz: e042323730698fb53f299aefdce93cf936614a8eca472b0caf96dc2d1d02718504dd607e77abf465c75baef85c65816f9697cf677eac7ce9c956324a23f6c643
+  data.tar.gz: 38aa85f696e3807593130d18ce65f622da761c48c5c4b8961647a9b04c5d87d5f6d20d27aa71cf8e50d716b8b0173aebb28c85e305aa079458bdd9b240f8a095

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-filter-tld
+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
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+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,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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.elasticsearch.org/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/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## 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.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- 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
+
+- 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 me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/example.conf

@@ -0,0 +1,42 @@
+input {
+
+    # This works
+    generator {
+	message => "www.google.com"
+	count => 1
+	type => "test1"
+    }
+
+    # This will fail
+    generator {
+	message => "google.co.ukf"
+	count => 1
+	type => "test1"
+    }
+
+    # Shows using the source option
+    generator {
+	message => "The domain is www.google.com"
+	count => 1
+	type => "test2"
+    }
+
+}
+
+filter {
+    if [type] == "test1" {
+	tld {}
+    } 
+    if [type] == "test2" {
+	grok {
+	    match => [ "message", "The domain is %{HOST:domain}" ]
+	}
+	tld {
+	    source => "domain"
+	}
+    }
+}
+
+output {
+    stdout { codec => rubydebug }
+}

data/lib/logstash/filters/tld.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# This example filter will replace the contents of the default 
+# message field with whatever you specify in the configuration.
+#
+# It is only intended to be used as an example.
+class LogStash::Filters::Tld < 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..."
+  #   }
+  # }
+  #
+  config_name "tld"
+  milestone 1
+  
+  # The source field to parse
+  config :source, :validate => :string, :default => "message"
+
+  # The target field to place all the data
+  config :target, :validate => :string, :default => "tld"
+
+  public
+  def register
+    # Add instance variables 
+    require 'public_suffix'
+  end # def register
+
+  public
+  def filter(event)
+
+    if @source and PublicSuffix.valid?(event[@source])
+      domain = PublicSuffix.parse(event[@source])
+      # Replace the event message with our message as configured in the
+      # config file.
+      event[@target] = Hash.new
+      event[@target]['tld'] = domain.tld
+      event[@target]['sld'] = domain.sld
+      event[@target]['trd'] = domain.trd
+      event[@target]['domain'] = domain.domain
+      event[@target]['subdomain'] = domain.subdomain
+
+      # filter_matched should go in the last line of our successful code
+      filter_matched(event)
+
+    end
+  end # def filter
+end # class LogStash::Filters::Example

data/logstash-filter-tld.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-tld'
+  s.version         = '0.1.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This example filter replaces the contents of the message field with the specified value."
+  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 = ["Elasticsearch"]
+  s.email = 'info@elasticsearch.com'
+  s.homepage = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # 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', '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'public_suffix', '=1.4.6'
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/tld_spec.rb

@@ -0,0 +1,53 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/tld"
+
+describe LogStash::Filters::Tld do
+  describe "Set to TLD" do
+    config <<-CONFIG
+      filter {
+        tld {
+        }
+      }
+    CONFIG
+
+#{
+#       "message" => "google.com",
+#      "@version" => "1",
+#    "@timestamp" => "2015-01-22T17:33:19.669Z",
+#          "host" => "homer",
+#      "sequence" => 0,
+#           "tld" => {
+#              "tld" => "com",
+#              "sld" => "google",
+#              "trd" => nil,
+#           "domain" => "google.com",
+#        "subdomain" => nil
+#    }
+
+
+    sample("message" => "google.com") do
+      insist { subject["tld"]["tld"] } == "com"
+      insist { subject["tld"]["sld"] } == "google"
+      insist { subject["tld"]["trd"] } == nil
+      insist { subject["tld"]["domain"] } == "google.com"
+      insist { subject["tld"]["subdomain"] } == nil
+    end
+
+    sample("message" => "google.co.uk") do
+      insist { subject["tld"]["tld"] } == "co.uk"
+      insist { subject["tld"]["sld"] } == "google"
+      insist { subject["tld"]["trd"] } == nil
+      insist { subject["tld"]["domain"] } == "google.co.uk"
+      insist { subject["tld"]["subdomain"] } == nil
+    end
+
+    sample("message" => "www.google.com") do
+      insist { subject["tld"]["tld"] } == "com"
+      insist { subject["tld"]["sld"] } == "google"
+      insist { subject["tld"]["trd"] } == "www"
+      insist { subject["tld"]["domain"] } == "google.com"
+      insist { subject["tld"]["subdomain"] } == "www.google.com"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-tld
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Elasticsearch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+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: info@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example.conf
+- lib/logstash/filters/tld.rb
+- logstash-filter-tld.gemspec
+- spec/filters/tld_spec.rb
+homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
+licenses:
+- Apache License (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.1.9
+signing_key:
+specification_version: 4
+summary: This example filter replaces the contents of the message field with the specified value.
+test_files:
+- spec/filters/tld_spec.rb