fluent-plugin-gamobile 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fluent-plugin-boundio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2012- Kentaro Yoshida
+
+   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,72 @@
+fluent-plugin-gamobile
+=====================
+
+## Component
+Fluentd Output plugin to send access report with "Google Analytics for mobile".
+
+## Installation
+
+### native gem
+`````
+gem install fluent-plugin-gamobile
+`````
+
+### td-agent gem
+`````
+/usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-gamobile
+`````
+
+## Configuration
+
+### Sample
+Please setup "gem install fluent-plugin-rewrite-tag-filter" before trying this sample.
+`````
+<source>
+  type tail
+  path /var/log/httpd/access_log
+  format /^(?<domain>[^ ]*) (?<host>[^ ]*) [^ ]* (?<user>[^ ]*) \[(?<time>[^\]]*)\] "(?<method>\S+)(?: +(?<path>[^ ]*) +\S*)?" (?<status>[^ ]*) (?<size>[^ ]*)(?: "(?<referer>[^\"]*)" "(?<agent>[^\"]*)" (?<response_time>[^ ]*))?$/
+  time_format %d/%b/%Y:%H:%M:%S %z
+  tag td.apache.access
+  pos_file /var/log/td-agent/apache_access.pos
+</source>
+
+<match td.apache.access>
+  type copy
+  <store>
+    type rewrite_tag_filter
+    rewriterule1 agent (spider|bot|crawler|\+http\:) apache.access.robot
+  </store>
+</match>
+
+<match apache.access.robot>
+  type gamobile
+  ga_account     MO-12345678-1
+  # set UserVar from record
+  set_var        agent         # Optional (default none)
+  # mapping internal name with record
+  map_domain     domain        # Optional (default: domain)
+  map_remoteaddr host          # Optional (default: host)
+  map_path       path          # Optional (default: path)
+  map_referer    referer       # Optional (default: referer)
+  map_useragent  agent         # Optional (default: agent)
+  map_guid       guid          # Optional (default: guid)
+  map_acceptlang lang          # Optional (default: lang)
+</match>
+`````
+
+## Use Case
+* track crawler access activity
+* track internal api access activity
+
+## Backend Service
+http://www.google.com/intl/ja/analytics/
+
+## TODO
+patches welcome!
+
+## Copyright
+Copyright © 2012- Kentaro Yoshida (@yoshi_ken)
+
+## License
+Apache License, Version 2.0
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+

data/fluent-plugin-gamobile.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-gamobile"
+  s.version     = "0.0.1"
+  s.authors     = ["Kentaro Yoshida"]
+  s.email       = ["y.ken.studio@gmail.com"]
+  s.homepage    = "https://github.com/y-ken/fluent-plugin-gamobile"
+  s.summary     = %q{Fluentd Output plugin to send access report with "Google Analytics for mobile".}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "fluentd"
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "active_support"
+  s.add_runtime_dependency "i18n"
+end

data/lib/fluent/plugin/out_gamobile.rb

@@ -0,0 +1,93 @@
+class Fluent::GamobileOutput < Fluent::Output
+  Fluent::Plugin.register_output('gamobile', self)
+
+  config_param :ga_account, :string
+  config_param :set_var, :string, :default => nil
+  config_param :map_domain, :string, :default => 'domain'
+  config_param :map_remoteaddr, :string, :default => 'host'
+  config_param :map_path, :string, :default => 'path'
+  config_param :map_referer, :string, :default => 'referer'
+  config_param :map_useragent, :string, :default => 'agent'
+  config_param :map_guid, :string, :default => 'guid'
+  config_param :map_acceptlang, :string, :default => 'lang'
+
+  def initialize
+    super
+    require 'net/http'
+    require 'active_support/core_ext'
+    Net::HTTP.version_1_2
+  end
+
+  def configure(conf)
+    super
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time,record|
+      report(record)
+    end
+
+    chain.next
+  end
+
+  def set_record(record)
+    @record = record
+  end
+
+  def get_record(key)
+    return @record[key] unless @record[key].blank?
+  end
+
+  def get_remote_address
+    if get_record(@map_remoteaddr) =~ /^([^.]+\.[^.]+\.[^.]+\.).*/
+      return "#{$1}0"
+    else
+      return ''
+    end
+  end
+
+  def get_visitor_id
+    if get_record(@map_guid).blank?
+      message = "#{get_record(@map_useragent)}#{Digest::SHA1.hexdigest(rand.to_s)}#{Time.now.to_i}"
+    else
+      message = "#{get_record(@map_guid)}#{@ga_account}"
+    end
+    md5string = Digest::MD5.hexdigest(message)
+    return "0x#{md5string[0,16]}"
+  end
+
+  def get_utmv
+     return ERB::Util.u("+__utmv=999#{get_record(@set_var)};") unless get_record(@set_var).blank?
+  end
+
+  def build_query
+    utm_gif_location = 'http://www.google-analytics.com/__utm.gif'
+    queries = Array.new
+    queries << "utmwv=4.4sh"
+    queries << "utmn=#{rand(1000000*1000000)}"
+    queries << "utmhn=#{ERB::Util.u(get_record(@map_domain))}"
+    queries << "utmr=#{ERB::Util.u(get_record(@map_referer))}"
+    queries << "utmp=#{ERB::Util.u(get_record(@map_path))}"
+    queries << "utmac=#{@ga_account}"
+    queries << "utmcc=__utma%3D999.999.999.999.999.1%3B#{get_utmv}"
+    queries << "utmvid=#{get_visitor_id}"
+    queries << "utmip=#{get_remote_address}"
+    return URI.parse(utm_gif_location + '?' + queries.join('&'))
+  end
+
+  def report(record)
+    set_record(record)
+    begin
+      uri = build_query
+      $log.info "gamobile sending report: #{uri.to_s}"
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        http.get(uri.request_uri, {
+          "user_agent" => get_record(@map_useragent).to_s,
+          "Accepts-Language" => get_record(@map_acceptlang).to_s
+        })
+      end
+    rescue => e
+      $log.error("gamobile Error: #{e.message}")
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_gamobile'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_gamobile.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class GamobileOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    ga_account MO-1234567-1
+    set_var    agent
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::GamobileOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    d = create_driver %[
+      ga_account MO-1234567-1
+      set_var    agent
+    ]
+    d.instance.inspect
+    assert_equal 'MO-1234567-1', d.instance.ga_account
+    assert_equal 'agent', d.instance.set_var
+  end
+
+  def test_emit
+    d1 = create_driver(CONFIG, 'input.access')
+    time = Time.parse("2012-01-02 13:14:15").to_i
+    d1.run do
+      d1.emit({'message' => 'sample message'})
+    end
+    emits = d1.emits
+    assert_equal 0, emits.length
+  end
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-gamobile
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Yoshida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &19257400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19257400
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &19256960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19256960
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &19256540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19256540
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &19256120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19256120
+description: 
+email:
+- y.ken.studio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-gamobile.gemspec
+- lib/fluent/plugin/out_gamobile.rb
+- test/helper.rb
+- test/plugin/test_out_gamobile.rb
+homepage: https://github.com/y-ken/fluent-plugin-gamobile
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Fluentd Output plugin to send access report with "Google Analytics for mobile".
+test_files:
+- test/helper.rb
+- test/plugin/test_out_gamobile.rb