logstash-filter-google_appengine 0.10.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1b96291088f900e14df382bc7129fe213a8afc9
-  data.tar.gz: 326f38a243387ed4cd3cafbe2c467ef3f2a6d121
+  metadata.gz: 577b86574c1d0bb8d3f8eae10c88b57cc7314b1c
+  data.tar.gz: 8ccf5230a7fa21e4255b2fca765e6f224d9475c3
 SHA512:
-  metadata.gz: 81471cd56ff64740ecdffaf60b4e449a6619d5152e84851236166d30a210bee2e79c3685a1a38a491b417bf2972f79dbf7fcfd959d6d92da674f657aeb018342
-  data.tar.gz: c68cea84c050ec9c3fb0534451a57e8d259b1ca26cdc36ceca96e04dd0c9e0c9fe48dbac81b6d1b1c5dbb8afb514993f66921bd5ce659298777d5e9933fa0550
+  metadata.gz: 7d83ed9a6456a4401ab379b9854c1a22d113eb4853682c2760e93864586d96b0857a6e14478e56c28a1be4eea6aa3c14ba9d40f4e8a1876ae9a64064fb5d7184
+  data.tar.gz: 95428d179177159334903fcd033a2dbf2d1eed033bf927a1504ddf791cbf7992443a6e13cb933414cc586f4d0631c4acab6fd667e63733058f17595581d1bb8e

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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/Rakefile

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

data/lib/logstash/filters/google_appengine.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "logstash/environment"
+require 'digest'
+
+class LogStash::Filters::GoogleAppengine < LogStash::Filters::Base
+
+  config_name "google_appengine"
+
+  public
+  def register
+    @md5 = Digest::MD5.new
+  end
+
+  def filter(event)
+    begin
+      payload = event['protoPayload']
+      payload.delete '@type'
+      lines = payload.delete 'line'
+      if lines
+        lines.map.with_index { |line, i|
+          line_data = payload.merge line
+          line_data['_id'] = @md5.hexdigest line_data['requestId'] + i.to_s
+          line_data['message'] = line_data.delete 'logMessage'
+
+          new_event = LogStash::Event::new(line_data)
+          filter_matched(new_event)
+          yield new_event
+        }
+      else
+        payload['_id'] = @md5.hexdigest payload['requestId']
+        payload['time'] = payload['endTime']
+
+        new_event = LogStash::Event::new(payload)
+        filter_matched(new_event)
+        yield new_event
+      end
+      event.cancel
+    rescue => e
+      @logger.error "Failed to process event", :error => e, :data => event
+    end
+  end
+end

data/logstash-filter-google_appengine.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+
+  s.name = 'logstash-filter-google_appengine'
+  s.version = '0.20.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This filter may be used to decode via inputs appengine logs"
+  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 = ["Small Improvements"]
+  s.email = 'mruhwedel@small-improvements.com'
+  s.homepage = "https://github.com/MichaelRuhwedel/logstash-filter-google-appengine"
+  s.require_paths = ["lib"]
+
+  s.files = `git ls-files`.split($\)
+
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.metadata = {"logstash_plugin" => "true", "logstash_group" => "filter"}
+
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/filters/appengine.logs-without-lines.jsonl

@@ -0,0 +1 @@
+{"metadata":{"serviceName":"appengine.googleapis.com","zone":"us9","labels":{"appengine.googleapis.com/module_id":"default","appengine.googleapis.com/request_id":"55e80a9c00ff096e0f91589f3f0001737e73686f7070696e672d67616d652d68726400013100010103","appengine.googleapis.com/version_id":"1"},"timestamp":"2015-09-03T08:53:48.617999Z"},"protoPayload":{"@type":"type.googleapis.com/google.appengine.logging.v1.RequestLog","appId":"s~shopping-game-hrd","versionId":"1","requestId":"NTVlODBhOWMwMGZmMDk2ZTBmOTE1ODlmM2YwMDAxNzM3ZTczNjg2ZjcwNzA2OTZlNjcyZDY3NjE2ZDY1MmQ2ODcyNjQwMDAxMzEwMDAxMDEwMw==","ip":"78.55.216.42","startTime":"2015-09-03T08:53:48.617999Z","endTime":"2015-09-03T08:53:48.671351Z","latency":"0.053352s","method":"GET","resource":"/images/website/welcome/keyFeatures/objectives.jpg","httpVersion":"HTTP/1.1","status":200,"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2439.0 Safari/537.36","host":"shopping-game.small-improvements.com","instanceIndex":-1,"appEngineRelease":"1.9.25"},"insertId":"2015-09-03|01:53:50.387721-07|10.106.166.136|1292431933","log":"appengine.googleapis.com/request_log","httpRequest":{"status":200}}

data/spec/filters/appengine.logs.jsonl

@@ -0,0 +1 @@
+{"metadata":{"severity":"INFO","serviceName":"appengine.googleapis.com","zone":"us9","labels":{"appengine.googleapis.com/clone_id":"00c61b117cf5a23b1278e3feeb2520a35bb82f","appengine.googleapis.com/module_id":"default","appengine.googleapis.com/request_id":"55e8281c00ff08ebd0149c00ffc30001737e73686f7070696e672d67616d652d68726400013100010101","appengine.googleapis.com/version_id":"1"},"timestamp":"2015-09-03T10:59:40.584656Z"},"protoPayload":{"@type":"type.googleapis.com/google.appengine.logging.v1.RequestLog","appId":"s~shopping-game-hrd","versionId":"1","requestId":"NTVlODI4MWMwMGZmMDhlYmQwMTQ5YzAwZmZjMzAwMDE3MzdlNzM2ODZmNzA3MDY5NmU2NzJkNjc2MTZkNjUyZDY4NzI2NDAwMDEzMTAwMDEwMTAx","ip":"0.1.0.2","startTime":"2015-09-03T10:59:40.584656Z","endTime":"2015-09-03T10:59:40.700408Z","latency":"0.115752s","megaCycles":"57","method":"POST","resource":"/admin/tasks/executeThrottledTasks","httpVersion":"HTTP/1.1","status":200,"responseSize":"933","referrer":"http://shopping-game-hrd.appspot.com/admin/tasks/executeThrottledTasks/master/true","userAgent":"AppEngine-Google; (+http://code.google.com/appengine)","urlMapEntry":"unused","host":"shopping-game-hrd.appspot.com","cost":1.0426999999999999e-07,"taskQueueName":"throttledtasks","taskName":"0366082792844325968","instanceIndex":-1,"instanceId":"MDBjNjFiMTE3Y2Y1YTIzYjEyNzhlM2ZlZWIyNTIwYTM1YmI4MmY=","line":[{"time":"2015-09-03T10:59:40.589Z","severity":"INFO","logMessage":"IdentityFilter logUserIdentity: [[meta]] <anonymous:true>\n"},{"time":"2015-09-03T10:59:40.65Z","severity":"INFO","logMessage":"HttpOnlyFilter getSession: add additional Set-Cookie with httpOnly-flag for JSESSIONID\n"},{"time":"2015-09-03T10:59:40.652Z","severity":"INFO","logMessage":"SessionSafeAccessor reset: clearing the session safe\n"}],"appEngineRelease":"1.9.25","traceId":"17e8867d8b819bc7eb2fc2d26e006462"},"insertId":"2015-09-03|03:59:45.683978-07|10.106.187.131|33909730","log":"appengine.googleapis.com/request_log","httpRequest":{"status":200}}

data/spec/filters/google_appengine_spec.rb

@@ -0,0 +1,51 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/google_appengine"
+require "logstash/json"
+require 'digest'
+
+describe LogStash::Filters::GoogleAppengine do
+
+  md5 = Digest::MD5.new
+
+  describe "should merge the request payload with the reuest lines data" do
+    config <<-CONFIG
+        filter {
+          google_appengine { }
+         }
+    CONFIG
+
+    test_sample = LogStash::Json::load(File.open("spec/filters/appengine.logs.jsonl", "rb").read)
+    sample (test_sample) do
+      insist { subject.length } == 3
+
+      insist { subject[0]["message"] }=="IdentityFilter logUserIdentity: [[meta]] <anonymous:true>\n"
+      insist { subject[0]["_id"] }== md5.hexdigest(subject[0]["requestId"] + "0")
+      insist { subject[0]["time"] } == "2015-09-03T10:59:40.589Z"
+
+      insist { subject[0]["@type"] } == nil
+
+      insist { subject[1]["message"] }=="HttpOnlyFilter getSession: add additional Set-Cookie with httpOnly-flag for JSESSIONID\n"
+      insist { subject[1]["_id"] } == md5.hexdigest(subject[1]["requestId"] + "1")
+      insist { subject[1]["@type"] } == nil
+      insist { subject[1]["time"] } =="2015-09-03T10:59:40.65Z"
+    end
+  end
+
+  describe "should handle logs even when they have no lines" do
+    config <<-CONFIG
+        filter {
+          google_appengine { }
+         }
+    CONFIG
+    test_sample = LogStash::Json.load(File.open("spec/filters/appengine.logs-without-lines.jsonl", "rb").read)
+    sample (test_sample) do
+
+      insist { subject["resource"] }=="/images/website/welcome/keyFeatures/objectives.jpg"
+      insist { subject["_id"] }==md5.hexdigest(subject["requestId"])
+      insist { subject["time"] }==subject["endTime"]
+      insist { subject["@type"] } == nil
+    end
+  end
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-google_appengine
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Small Improvements
@@ -49,7 +49,16 @@ email: mruhwedel@small-improvements.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/filters/google_appengine.rb
+- logstash-filter-google_appengine.gemspec
+- spec/filters/appengine.logs-without-lines.jsonl
+- spec/filters/appengine.logs.jsonl
+- spec/filters/google_appengine_spec.rb
 homepage: https://github.com/MichaelRuhwedel/logstash-filter-google-appengine
 licenses:
 - Apache License (2.0)
@@ -76,4 +85,7 @@ rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: This filter may be used to decode via inputs appengine logs
-test_files: []
+test_files:
+- spec/filters/appengine.logs-without-lines.jsonl
+- spec/filters/appengine.logs.jsonl
+- spec/filters/google_appengine_spec.rb