logstash-filter-schema_validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b0fd330702ae7941577dc6adaf29fac086f19f0
+  data.tar.gz: 3411d1f9869a505a72c38d26308bc98c84911df4
+SHA512:
+  metadata.gz: 41bed013add021de3d5632347d748de9afa58f9c7a793d7753821e1062b1582d0479628d8066fad98ce552c9dc6934f64b385e640b97d1fac28b213ad58eb666
+  data.tar.gz: b7125e9d39da9f8662244dfb75da599d0e83f1db7ef251ef1da2228e471002ba2cbe1e09862d07f352d2a82b180bd6e2c2438b5ebec5e8828e85af12a1aa03aa

data/CHANGELOG.md

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

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Thomas Decaux @Qwant
+* Carlo Dosso @SubitoLabs
+
+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-schema-validator
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

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,89 @@
+[![Build Status](https://travis-ci.org/ebuildy/logstash-filter-schema_validation.svg?branch=master)](https://travis-ci.org/ebuildy/logstash-filter-schema_validation)
+
+
+# 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/schema_validation.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "json-schema"
+
+# This  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 .
+class LogStash::Filters::SchemaValidation < LogStash::Filters::Base
+
+  config_name "schema_validation"
+
+  # The path to JSON schema.
+  config :schema, :validate => :string, :required => true
+
+  # Retrieve errors.
+  config :report_field, :validate => :string, :default => nil
+
+  # JSON Schema option
+  # with the `:strict` option, all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`
+  config :strict, :validate => :boolean, :default => false
+
+  # JSON Schema option
+  # with the `:fragment` option, only a fragment of the schema is used for validation
+  config :fragment, :validate => :string
+
+  # JSON Schema option
+  # with the `:version` option, schemas conforming to older drafts of the json schema spec can be used
+  config :spec_version, :validate => :string, :default => "draft2"
+
+  # Tags the event on failure to look up geo information. This can be used in later analysis.
+  config :tag_on_failure, :validate => :array, :default => ["_schema_validation_failure"]
+
+  public
+  def register
+    @schema = File.expand_path(@schema)
+  end # def register
+
+  public
+  def filter(event)
+
+    schemaFilePath = generate_filepath(event)
+
+    if File.exists?(schemaFilePath)
+
+      validationErrors = JSON::Validator.fully_validate(schemaFilePath, event.to_hash, :strict => @strict, :fragment => @fragment, :parse_data => false)
+
+      if validationErrors.empty?
+        filter_matched(event)
+      else
+        tag_unsuccessful_lookup(event)
+
+        unless @report_field.nil? || @report_field.empty?
+          event.set(@report_field, validationErrors)
+        end
+      end
+
+    else
+
+      @logger.fatal? && @logger.fatal("Schema file '" + schemaFilePath + "' does not exists!")
+
+      tag_unsuccessful_lookup(event)
+
+      unless @report_field.nil? || @report_field.empty?
+        event.set(@report_field, ["Schema file '" + schemaFilePath + "' does not exists!"])
+      end
+
+    end
+
+  end
+
+  def tag_unsuccessful_lookup(event)
+    @logger.debug? && @logger.debug("Event data is not valide!", :event => event)
+    @tag_on_failure.each{|tag| event.tag(tag)}
+  end
+
+  private
+  def generate_filepath(event)
+    event.sprintf(@schema)
+  end
+
+end

data/logstash-filter-schema_validation.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-schema_validation'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Validate event schema with JSON Schema.'
+  s.description   = 'Validate event schema with JSON Schema.'
+  s.homepage      = 'https://github.com'
+  s.authors       = ['Thomas Decaux']
+  s.email         = 't.decaux@qwant.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_runtime_dependency "json-schema", "~> 2.6"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/schema-validator_spec.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/schema_validation"
+
+describe LogStash::Filters::SchemaValidation do
+
+  before do
+    srand(RSpec.configuration.seed)
+  end
+
+  describe "With not existing schema file I should see the failure tag" do
+    let(:config) do <<-CONFIG
+      filter {
+        schema_validation {
+          schema => "/wrong_file.json"
+          report_field => "_errors"
+          tag_on_failure => "fail"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject).to include("tags")
+      expect(subject).to include("_errors")
+      expect(subject.get("tags")).to eq(["fail"])
+      expect(subject.get("_errors")).to eq(["Schema file '" + "/wrong_file.json" + "' does not exists!"])
+    end
+  end
+
+  describe "With a valid schema I should not see the failure tag" do
+    let(:config) do <<-CONFIG
+      filter {
+        schema_validation {
+          schema => "./spec/schemas/simple.json"
+          report_field => "_errors"
+        }
+      }
+    CONFIG
+    end
+
+    sample("firstName" => "tom", "lastName" => "Decaux", "age" => 34) do
+      expect(subject).not_to include("tags")
+    end
+  end
+
+  describe "With fragment I should not see the failure tag" do
+    let(:config) do <<-CONFIG
+      filter {
+        schema_validation {
+          schema => "./spec/schemas/simple0.json"
+          report_field => "_errors"
+          fragment => "#/properties/name"
+        }
+      }
+    CONFIG
+    end
+
+    sample("first" => "tom", "last" => "Decaux") do
+#      puts subject.to_hash.to_s
+      expect(subject).not_to include("tags")
+    end
+  end
+
+  describe "Without respecting the schema I should see the failure tag and the error details" do
+    let(:config) do <<-CONFIG
+      filter {
+        schema_validation {
+          schema => "./spec/schemas/simple.json"
+          report_field => "_errors"
+        }
+      }
+    CONFIG
+    end
+
+    sample("firstName" => "tom", "lastame" => "Decaux", "age" => 34) do
+      puts subject.to_hash.to_s
+      expect(subject).to include("tags")
+      expect(subject.get("_errors")[0]).to include("The property '#/' did not contain a required property of 'lastName'")
+    end
+  end
+
+  describe "With strict mode and an extra field I should get an error" do
+    let(:config) do <<-CONFIG
+      filter {
+        schema_validation {
+          schema => "./spec/schemas/simple.json"
+          strict => true
+        }
+      }
+    CONFIG
+    end
+
+    sample("firstName" => "tom", "lastName" => "Decaux", "age" => 34, "sex" => "enormous") do
+      expect(subject).to include("tags")
+    end
+  end
+end

data/spec/schemas/simple.json

@@ -0,0 +1,17 @@
+{
+  "type" : "object",
+  "required": ["firstName", "lastName"],
+  "properties" : {
+    "firstName": {
+        "type": "string"
+    },
+    "lastName": {
+        "type": "string"
+    },
+    "age": {
+        "description": "Age in years",
+        "type": "integer",
+        "minimum": 0
+    }
+  }
+}

data/spec/schemas/simple0.json

@@ -0,0 +1,22 @@
+{
+  "type" : "object",
+  "properties" : {
+    "name" : {
+      "type" : "object",
+      "properties" : {
+        "first": {
+            "type": "string"
+        },
+        "last": {
+            "type": "string"
+        }
+      },
+      "required": ["first", "last"]
+    },
+    "age": {
+        "description": "Age in years",
+        "type": "integer",
+        "minimum": 0
+    }
+  }
+}

data/spec/schemas/wrong.json

@@ -0,0 +1,14 @@
+{
+    "firstName": {
+        "type": "toto"
+    },
+    "lastName": {
+        "dsdsds": "string"
+    },
+    "age": {
+        "description": "Age in years",
+        "type": "integer",
+        "minimum": 0
+    },
+    "required": []
+}

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-schema_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Decaux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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: Validate event schema with JSON Schema.
+email: t.decaux@qwant.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/schema_validation.rb
+- logstash-filter-schema_validation.gemspec
+- spec/filters/schema-validator_spec.rb
+- spec/schemas/simple.json
+- spec/schemas/simple0.json
+- spec/schemas/wrong.json
+- spec/spec_helper.rb
+homepage: https://github.com
+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.14
+signing_key: 
+specification_version: 4
+summary: Validate event schema with JSON Schema.
+test_files:
+- spec/filters/schema-validator_spec.rb
+- spec/schemas/simple.json
+- spec/schemas/simple0.json
+- spec/schemas/wrong.json
+- spec/spec_helper.rb