logstash-filter-wmts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44694d87f4b63abe2ed619baeba14c0e58f9f2fe
+  data.tar.gz: 8602fd4b761150cc36b959c5b4f94f28010925ba
+SHA512:
+  metadata.gz: f1b065d4f423d87ec462edd406d8d5329bc81f8df57fefa6373ac1bfa68c086735c7187fe51f0c868d2aff87157f099e747b5dbfea4faa9c22c9b1fb5b8ff204
+  data.tar.gz: c08aa10dfebe73c0c95d68df903c57a9490623bd128f17e5831b748afa6b0b87da08909297fac22ee3c63fc8238de06f398d6c36a4cf48befef0a9e5b8048447

data/.gitignore

@@ -0,0 +1,36 @@
+*.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CONTRIBUTORS

@@ -0,0 +1,12 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* François Van Der Biest (fvanderbiest)
+* Pierre Mauduit (pmauduit)
+* Philippe Weber (wiibaa)
+
+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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem "concurrent-ruby", "0.9.1"
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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/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. 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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/filters/wmts.rb

@@ -0,0 +1,145 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+#
+# This filter converts data from OGC WMTS (Web Map Tile Service) URLs to
+# geospatial information, and expands the logstash event accordingly. See
+# http://www.opengeospatial.org/standards/wmts for more information about WMTS. 
+#
+# Given a grid, WMTS urls contain all the necessary information to find out
+# which coordinates a requested tile belongs to.  Using a simple grok filter
+# you can extract all the relevant information. This plugin then translates
+# these information into coordinates in LV03 and WGS84.
+#
+# Here is an example of such a request: 
+# http://wmts4.geo.admin.ch/1.0.0/ch.swisstopo.pixelkarte-farbe/default/20130213/21781/23/470/561.jpeg
+#
+# The current filter can be configured as follows in the configuration file:
+# [source,ruby]
+# filter {
+#   # First, waiting for varnish log file formats (combined apache logs)
+#   grok { match => [ "message", "%{COMBINEDAPACHELOG}" ] }
+#   # Then, parameters
+#   grok {
+#     match => {
+#       "request" => "https?://%{IPORHOST}/%{DATA:[wmts][version]}/%{DATA:[wmts][layer]}/default/%{POSINT:[wmts][release]}/%{DATA:[wmts][reference-system]}/%{POSINT:[wmts][zoomlevel]}/%{POSINT:[wmts][row]}/%{POSINT:[wmts][col]}\.%{WORD:[wmts][filetype]}" 
+#     }
+#   }
+#   # actually passes the previously parsed message to the wmts plugin
+#   wmts { }
+#  }
+#
+# By default, the filter is configured to parse requests made on WMTS servers
+# configured with the Swisstopo WMTS grid, but this can be customized through 
+# the `x_origin`,`y_origin`,`tile_width`,`tile_height` and `resolutions` parameters.
+#
+class LogStash::Filters::Wmts < LogStash::Filters::Base
+
+  config_name "wmts"
+
+  # Specify the abscissa origin of the WMTS grid
+  #(by default, it is set to Swisstopo's WMTS grid)
+  config :x_origin, :validate => :number, :default => 420000
+  
+  # Specify the ordinate origin of the WMTS
+  #(by default, it is set to Swisstopo's WMTS grid)
+  config :y_origin, :validate => :number, :default => 350000
+  
+  # Specify the width of the produced image tiles
+  config :tile_width, :validate => :number, :default => 256
+
+  # Specify the height of the produced image tiles
+  config :tile_height, :validate => :number, :default => 256
+  
+  # Specify the array of resolutions for this WMTS grid
+  config :resolutions, :validate => :array, :default => [ 4000, 3750, 3500, 3250, 3000, 2750, 2500, 2250, 2000,
+        1750, 1500, 1250, 1000, 750, 650, 500, 250, 100, 50, 20, 10, 5, 2.5, 2, 1.5, 1, 0.5, 0.25, 0.1 ]
+
+  # Specify the field into which Logstash should store the wms data.
+  config :target, :validate => :string, :default => "wmts"
+
+  # Specify the output projection to be used when setting the x/y
+  # coordinates, default to regular lat/long wgs84 ('epsg:4326')
+  config :output_epsg, :validate => :string, :default => "epsg:4326"
+
+  # Specify the name of the field where the filter can find the WMTS zoomlevel
+  config :zoomlevel_field, :validate => :string, :default => "[wmts][zoomlevel]"
+
+  # Specify the name of the field where the filter can find the WMTS column
+  config :column_field, :validate => :string, :default => "[wmts][col]"
+
+  # Specify the name of the field where the filter can find the WMTS row
+  config :row_field, :validate => :string, :default => "[wmts][row]"
+
+  # Specify the name of the field where the filter can find the WMTS reference system
+  # Note: if the reference system is different from the output_epsg, 
+  # a reprojection of the coordinates will take place.
+  config :refsys_field, :validate => :string, :default => "[wmts][reference-system]"
+  
+  # Specify mapping between named projections and their actual EPSG code.
+  # Sometimes, the reference-system can be given as a string ('swissgrid' for instance). 
+  # This parameter allows to set a mapping between 
+  # a regular name and the epsg number of a projection, e.g.:
+  # [source;ruby]
+  #   { "swissgrid" => 21781 }
+  #
+  config :epsg_mapping, :validate => :hash, :default => {} 
+
+  public
+  def register
+    require "geoscript"
+  end
+
+  public
+  def filter(event)
+    begin
+      # cast values extracted upstream into integers
+      zoomlevel = Integer(event[@zoomlevel_field])
+      col = Integer(event[@column_field])
+      row = Integer(event[@row_field])
+
+      # checks if a mapping exists for the reference system extracted
+      translated_epsg = @epsg_mapping[event[@refsys_field]] || event[@refsys_field] 
+      input_epsg = "epsg:#{translated_epsg}"
+
+      resolution = @resolutions[zoomlevel]
+      raise ArgumentError if resolution.nil?
+    rescue ArgumentError, TypeError, NoMethodError
+      event["[#{@target}][errmsg]"] = "Bad parameter received from upstream filter"
+      return
+    end
+
+    begin
+      input_x = @x_origin + (((col+0.5)*@tile_width*resolution).floor)
+      input_y = @y_origin - (((row+0.5)*@tile_height*resolution).floor)
+
+      event["[#{@target}][service]"] = "wmts"
+
+      event["[#{@target}][input_epsg]"] = input_epsg
+      event["[#{@target}][input_x]"] = input_x
+      event["[#{@target}][input_y]"] = input_y
+      # add a combined field to the event. used for elaticsearch facets (heatmap!)
+      event["[#{@target}][input_xy]"] = "#{input_x},#{input_y}"
+
+      # convert from input_epsg to output_epsg (if necessary)
+      event["[#{@target}][output_epsg]"] = @output_epsg
+
+      unless input_epsg == @output_epsg
+        input_p = GeoScript::Geom::Point.new input_x, input_y
+        output_p = GeoScript::Projection.reproject input_p, input_epsg, @output_epsg
+        event["[#{@target}][output_xy]"] = "#{output_p.x},#{output_p.y}"
+        event["[#{@target}][output_x]"] = output_p.x
+        event["[#{@target}][output_y]"] = output_p.y
+      else
+        # no reprojection needed
+        event["[#{@target}][output_xy]"] = "#{input_x},#{input_y}"
+        event["[#{@target}][output_x]"] = input_x
+        event["[#{@target}][output_y]"] = input_y
+      end
+    rescue 
+      event["[#{@target}][errmsg]"] = "Unable to reproject tile coordinates"
+    end
+    filter_matched(event)
+  end # def filter
+end

data/logstash-filter-wmts.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-wmts'
+  s.version         = '1.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "The wmts filter is used for parsing WMTS (Web-Map Tile Service) queries from fields."
+  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         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/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 "geoscript", "0.1.0.pre" #(MIT license)
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-filter-grok'
+end

data/spec/filters/wmts_spec.rb

@@ -0,0 +1,186 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/wmts"
+
+# Copy-paste from grok_spec.rb, necessary to run grok filter
+# running the grok code outside a logstash package means
+# LOGSTASH_HOME will not be defined, so let's set it here
+# before requiring the grok filter
+unless LogStash::Environment.const_defined?(:LOGSTASH_HOME)
+  LogStash::Environment::LOGSTASH_HOME = File.expand_path("../../../", __FILE__)
+end
+# End of copy-paste
+
+describe LogStash::Filters::Wmts do
+
+  describe "regular calls logged into Varnish logs (apache combined)" do
+    config <<-CONFIG
+      filter {
+        # First, waiting for varnish log file formats (combined apache logs)
+        grok { match => { "message" => "%{COMBINEDAPACHELOG}" } }
+        # Then, parameters 
+        # Note: the 'wmts.' prefix should match the configuration of the plugin,
+        # e.g if "wmts { 'prefix' => 'gis' }", then you should adapt the grok filter
+        # accordingly.
+        #
+        grok {
+          match => {
+            #"request" => "(?<[wmts][version]\">([0-9\.]{5}))\/(?<[wmts][layer]>([a-z0-9\.-]*))\/default\/(?<[wmts][release]>([0-9]{8}))\/(?<[wmts][reference-system]>([0-9]*))\/(?<[wmts][zoomlevel]>([0-9]*))\/(?<[wmts][row]>([0-9]*))\/(?<[wmts][col]>([0-9]*))\.(?<[wmts][filetype]>([a-zA-Z]*))"
+            "request" => "https?://%{IPORHOST}/%{DATA:[wmts][version]}/%{DATA:[wmts][layer]}/default/%{POSINT:[wmts][release]}/%{POSINT:[wmts][reference-system]}/%{POSINT:[wmts][zoomlevel]}/%{POSINT:[wmts][row]}/%{POSINT:[wmts][col]}\.%{WORD:[wmts][filetype]}"
+          }
+        }
+        wmts { }
+      }
+    CONFIG
+
+    # regular WMTS query from a varnish log
+    sample '127.0.0.1 - - [20/Jan/2014:16:48:28 +0100] "GET http://wmts4.testserver.org/1.0.0/' \
+      'mycustomlayer/default/20130213/21781/23/470/561.jpeg HTTP/1.1" 200 2114 ' \
+      '"http://localhost/ajaxplorer/" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36' \
+      '(KHTML, like Gecko) Ubuntu Chromium/31.0.1650.63 Chrome/31.0.1650.63 Safari/537.36"' do
+        # checks that the query has been successfully parsed  
+        # and the geopoint correctly reprojected into wgs:84 
+        expect(subject["[wmts][version]"]).to eq("1.0.0")
+        expect(subject["[wmts][layer]"]).to eq("mycustomlayer")
+        expect(subject["[wmts][release]"]).to eq("20130213")
+        expect(subject["[wmts][reference-system]"]).to eq("21781")
+        expect(subject["[wmts][zoomlevel]"]).to eq("23")
+        expect(subject["[wmts][row]"]).to eq("470")
+        expect(subject["[wmts][col]"]).to eq("561")
+        expect(subject["[wmts][filetype]"]).to eq("jpeg")
+        expect(subject["[wmts][service]"]).to eq("wmts")
+        expect(subject["[wmts][input_epsg]"]).to eq("epsg:21781")
+        expect(subject["[wmts][input_x]"]).to eq(707488)
+        expect(subject["[wmts][input_y]"]).to eq(109104)
+        expect(subject["[wmts][input_xy]"]).to eq("707488,109104")
+        expect(subject["[wmts][output_epsg]"]).to eq("epsg:4326")
+        expect(subject["[wmts][output_xy]"]).to eq("8.829295858079231,46.12486163053951")
+        expect(subject["[wmts][output_x]"]).to eq(8.829295858079231)
+        expect(subject["[wmts][output_y]"]).to eq(46.12486163053951)
+      end
+
+    # query extracted from a varnish log, but not matching a wmts request
+    sample '83.77.200.25 - - [23/Jan/2014:06:51:55 +0100] "GET http://map.schweizmobil.ch/api/api.css HTTP/1.1"' \
+      ' 200 682 "http://www.schaffhauserland.ch/de/besenbeiz" ' \
+      '"Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko"' do
+        expect(subject["tags"]).to include("_grokparsefailure")
+    end
+
+    # query looking like a legit wmts log but actually contains garbage [1]
+    # - parameters from the grok filter cannot be cast into integers
+    sample '127.0.0.1 - - [20/Jan/2014:16:48:28 +0100] "GET http://wmts4.testserver.org/1.0.0/' \
+      'mycustomlayer/default/12345678////.raw HTTP/1.1" 200 2114 ' \
+      '"http://localhost//" "ozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36' \
+      '(KHTML, like Gecko) Ubuntu Chromium/31.0.1650.63 Chrome/31.0.1650.63 Safari/537.36"' do
+         expect(subject["[wmts][errmsg]"]).to start_with("Bad parameter received")
+    end
+
+    # query looking like a legit wmts log but actually contains garbage
+    # * 99999999 is not a valid EPSG code (but still parseable as an integer)
+    sample '127.0.0.1 - - [20/Jan/2014:16:48:28 +0100] "GET http://wmts4.testserver.org/1.0.0/' \
+      'mycustomlayer/default/20130213/99999999/23/470/561.jpeg HTTP/1.1" 200 2114 ' \
+      '"http://localhost//" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36' \
+      '(KHTML, like Gecko) Ubuntu Chromium/31.0.1650.63 Chrome/31.0.1650.63 Safari/537.36"' do
+         expect(subject['[wmts][errmsg]']).to eq("Unable to reproject tile coordinates")
+    end
+  end
+
+  describe "Testing the epsg_mapping parameter" do
+    config <<-CONFIG
+      filter {
+        grok { match => { "message" => "%{COMBINEDAPACHELOG}" } }
+        grok {
+          match => {
+            # "request" => "(?<wmts.version>([0-9\.]{5}))\/(?<wmts.layer>([a-z0-9\.-]*))\/default\/(?<wmts.release>([0-9]*))\/(?<wmts.reference-system>([a-z0-9]*))\/(?<wmts.zoomlevel>([0-9]*))\/(?<wmts.row>([0-9]*))\/(?<wmts.col>([0-9]*))\.(?<wmts.filetype>([a-zA-Z]*))"
+            "request" => "https?://%{IPORHOST}/%{DATA:[wmts][version]}/%{DATA:[wmts][layer]}/default/%{POSINT:[wmts][release]}/%{DATA:[wmts][reference-system]}/%{POSINT:[wmts][zoomlevel]}/%{POSINT:[wmts][row]}/%{POSINT:[wmts][col]}\.%{WORD:[wmts][filetype]}"
+          }
+        }
+        wmts { epsg_mapping => { 'swissgrid' => 21781 } }
+      }
+    CONFIG
+
+    # regular query needing a mapping
+    sample '11.12.13.14 - - [10/Feb/2014:16:27:26 +0100] "GET http://tile1.wmts.example.org/1.0.0/grundkarte/default/2013/swissgrid/9/371/714.png HTTP/1.1" 200 8334 "http://example.org" "Mozilla/5.0 (Windows NT 6.1; rv:26.0) Gecko/20100101 Firefox/26.0"' do
+      expect(subject["[wmts][version]"]).to eq("1.0.0")
+      expect(subject["[wmts][layer]"]).to eq("grundkarte")
+      expect(subject["[wmts][release]"]).to eq("2013")
+      expect(subject["[wmts][reference-system]"]).to eq("swissgrid")
+      expect(subject["[wmts][zoomlevel]"]).to eq("9")
+      expect(subject["[wmts][row]"]).to eq("371")
+      expect(subject["[wmts][col]"]).to eq("714")
+      expect(subject["[wmts][filetype]"]).to eq("png")
+      expect(subject["[wmts][service]"]).to eq("wmts")
+      # it should have been correctly mapped
+      expect(subject["[wmts][input_epsg]"]).to eq("epsg:21781")
+      expect(subject["[wmts][input_x]"]).to eq(320516000)
+      expect(subject["[wmts][input_y]"]).to eq(-166082000)
+      expect(subject["[wmts][input_xy]"]).to eq("320516000,-166082000")
+      expect(subject["[wmts][output_epsg]"]).to eq("epsg:4326")
+      expect(subject["[wmts][output_xy]"]).to eq("7.438691675813199,-43.38015041464443")
+      expect(subject["[wmts][output_x]"]).to eq(7.438691675813199)
+      expect(subject["[wmts][output_y]"]).to eq(-43.38015041464443)
+    end
+ 
+    # regular query which does not need a mapping
+    sample '11.12.13.14 - - [10/Feb/2014:16:27:26 +0100] "GET http://tile1.wmts.example.org/1.0.0/grundkarte/default/2013/21781/9/371/714.png HTTP/1.1" 200 8334 "http://example.org" "Mozilla/5.0 (Windows NT 6.1; rv:26.0) Gecko/20100101 Firefox/26.0"' do
+      expect(subject["[wmts][version]"]).to eq("1.0.0")
+      expect(subject["[wmts][layer]"]).to eq("grundkarte")
+      expect(subject["[wmts][release]"]).to eq("2013")
+      expect(subject["[wmts][reference-system]"]).to eq("21781")
+      expect(subject["[wmts][zoomlevel]"]).to eq("9")
+      expect(subject["[wmts][row]"]).to eq("371")
+      expect(subject["[wmts][col]"]).to eq("714")
+      expect(subject["[wmts][filetype]"]).to eq("png")
+      expect(subject["[wmts][service]"]).to eq("wmts")
+      expect(subject["[wmts][input_epsg]"]).to eq("epsg:21781")
+      expect(subject["[wmts][input_x]"]).to eq(320516000)
+      expect(subject["[wmts][input_y]"]).to eq(-166082000)
+      expect(subject["[wmts][input_xy]"]).to eq("320516000,-166082000")
+      expect(subject["[wmts][output_epsg]"]).to eq("epsg:4326")
+      expect(subject["[wmts][output_xy]"]).to eq("7.438691675813199,-43.38015041464443")
+      expect(subject["[wmts][output_x]"]).to eq(7.438691675813199)
+      expect(subject["[wmts][output_y]"]).to eq(-43.38015041464443)
+    end
+  end
+  describe "Testing a custom grid sent as parameter to the filter" do
+    config <<-CONFIG
+      filter {
+        grok { match => { "message" => "%{COMBINEDAPACHELOG}" } }
+        grok {
+          match => {
+            #"request" => "(?<wmts.version>([0-9\.]{5}))\/(?<wmts.layer>([a-z0-9\.-]*))\/default\/(?<wmts.release>([0-9]*))\/(?<wmts.reference-system>([a-z0-9]*))\/(?<wmts.zoomlevel>([0-9]*))\/(?<wmts.row>([0-9]*))\/(?<wmts.col>([0-9]*))\.(?<wmts.filetype>([a-zA-Z]*))"
+            "request" => "https?://%{IPORHOST}/%{DATA:[wmts][version]}/%{DATA:[wmts][layer]}/default/%{POSINT:[wmts][release]}/%{DATA:[wmts][reference-system]}/%{POSINT:[wmts][zoomlevel]}/%{POSINT:[wmts][row]}/%{POSINT:[wmts][col]}\.%{WORD:[wmts][filetype]}"
+          }
+        }
+        wmts { 
+          epsg_mapping => { 'swissgrid' => 21781 }
+          x_origin => 420000
+          y_origin => 350000
+          tile_width => 256
+          tile_height => 256
+          resolutions => [ 500, 250, 100, 50, 20, 10, 5, 2.5, 2, 1.5, 1, 0.5, 0.25, 0.1, 0.05 ]
+        }
+      }
+    CONFIG
+
+    sample '1.2.3.4 - - [10/Feb/2014:18:06:12 +0100] "GET http://tile1.example.net/1.0.0/ortho/default/2013/swissgrid/9/374/731.jpeg HTTP/1.1" 200 13872 "http://example.net" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.52 Safari/537.36"' do
+      expect(subject["[wmts][version]"]).to eq("1.0.0")
+      expect(subject["[wmts][layer]"]).to eq("ortho")
+      expect(subject["[wmts][release]"]).to eq("2013")
+      expect(subject["[wmts][reference-system]"]).to eq("swissgrid")
+      expect(subject["[wmts][zoomlevel]"]).to eq("9")
+      expect(subject["[wmts][row]"]).to eq("374")
+      expect(subject["[wmts][col]"]).to eq("731")
+      expect(subject["[wmts][filetype]"]).to eq("jpeg")
+      expect(subject["[wmts][service]"]).to eq("wmts")
+      expect(subject["[wmts][input_epsg]"]).to eq("epsg:21781")
+      expect(subject["[wmts][input_x]"]).to eq(700896)
+      expect(subject["[wmts][input_y]"]).to eq(206192)
+      expect(subject["[wmts][input_xy]"]).to eq("700896,206192")
+      expect(subject["[wmts][output_epsg]"]).to eq("epsg:4326")
+      expect(subject["[wmts][output_xy]"]).to eq("8.765263559441715,46.999112812287045")
+      expect(subject["[wmts][output_x]"]).to eq(8.765263559441715)
+      expect(subject["[wmts][output_y]"]).to eq(46.999112812287045)
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-wmts
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0.pre
+  name: geoscript
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0.pre
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.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'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-filter-grok
+  prerelease: false
+  type: :development
+  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: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/filters/wmts.rb
+- logstash-filter-wmts.gemspec
+- spec/filters/wmts_spec.rb
+homepage: http://www.elastic.co/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.4.8
+signing_key:
+specification_version: 4
+summary: The wmts filter is used for parsing WMTS (Web-Map Tile Service) queries from fields.
+test_files:
+- spec/filters/wmts_spec.rb