fluent-plugin-kibana-server 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg
+.DS_Store
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+# fluent-plugin-kibana-server
+
+Copyright (c) 2013 OKUNO Akihiro
+
+Apache License, Version 2.0
+
+----
+# Kibana
+
+Copyright 2012-2013 Elasticsearch BV
+
+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,44 @@
+# Fluent::Plugin::KibanaServer
+
+Fluent plugin to serve [Kibana](https://github.com/elasticsearch/kibana)
+
+## Installation
+
+`$ fluent-gem install fluent-plugin-kibana-server`
+
+## Configuration
+
+### Example
+
+```
+<source **>
+  type kibana_server
+  bind 0.0.0.0
+  port 24300
+  mount /kibana/
+  access_log_path /Users/okuno/tmp/var/log/kibana/access.log
+  elasticsearch_url http://localhost:9200
+</source>
+```
+
+### Parameter
+
+|parameter|description|default|
+|---|---|---|
+|bind|Local address for the server to bind to|0.0.0.0|
+|port|Port to listen on|24300|
+|mount|Root path of Kibana||
+|access_log_path|Path to access log. No logs will be written if this parameter is ommited.||
+|elasticsearch_url|URL of elasticsearch. This parameter is used in config.js of Kibana.||
+
+## TODO
+
+pathches welcome!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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/example.conf

@@ -0,0 +1,8 @@
+<source>
+  type kibana_server
+  bind 0.0.0.0
+  port 24300
+  mount /kibana/
+  access_log_path /Users/okuno/tmp/var/log/kibana/access.log
+  elasticsearch_url http://localhost:9200
+</source>

data/fluent-plugin-kibana-server.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-kibana-server"
+  s.version     = "0.0.1"
+  s.authors     = ["OKUNO Akihiro"]
+  s.email       = ["choplin.choplin@gmail.com"]
+  s.homepage    = "https://github.com/choplin/fluent-plugin-kibana-server"
+  s.summary     = %q{Fluentd plugin which serves Kibana within fluentd process}
+  s.description = s.summary
+  s.license     = "Apache 2.0"
+
+  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"]
+
+  s.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/in_kibana_server.rb

@@ -0,0 +1,117 @@
+module Fluent
+  class KibanaServerInput < Input
+    Plugin.register_input('kibana_server', self)
+
+    PATH_TO_KIBANA = File.join(File.dirname(__FILE__), '../../../vendor/kibana-3.0.0milestone4')
+    CONFIG_JS_PATH = File.join(PATH_TO_KIBANA, 'config.js')
+
+    require 'webrick'
+
+    config_param :bind, :string, :default => '0.0.0.0'
+    config_param :port, :integer, :default => 24300
+    config_param :mount, :string, :default => '/'
+    config_param :access_log_path, :string, :default => nil
+    config_param :elasticsearch_url, :string, :default => nil
+
+    def start
+      $log.info "listening http server for kinaba on http://#{@bind}:#{@port}#{@mount}"
+
+      @access_log = File.open(@access_log_path, 'a') if @access_log_path
+
+      File.open(CONFIG_JS_PATH, 'w') {|f| f.write(kibana_config)}
+
+      @srv = WEBrick::HTTPServer.new({
+          :BindAddress => @bind,
+          :Port => @port,
+          :Logger => WEBrick::Log.new(STDERR, WEBrick::Log::FATAL),
+          :AccessLog => @access_log ? [[@access_log, WEBrick::AccessLog::CLF]] : [],
+        })
+
+      @srv.mount(@mount, WEBrick::HTTPServlet::FileHandler, PATH_TO_KIBANA)
+
+      @thread = Thread.new { @srv.start }
+    end
+
+    def shutdown
+      if @srv
+        @srv.shutdown
+        @srv = nil
+      end
+
+      if @access_log and (not @access_log.closed?)
+        @access_log.close
+      end
+
+      if @thread
+        @thread.join
+        @thread = nil
+      end
+    end
+
+    private
+
+    def kibana_config
+      elasticsearch = if @elasticsearch_url
+                        %Q{"#{@elasticsearch_url}"}
+                      else
+                        %Q{"http://"+window.location.hostname+":9200"}
+                      end
+      <<-CONFIG
+/**
+ * These is the app's configuration, If you need to configure
+ * the default dashboard, please see dashboards/default
+ */
+define(['settings'],
+function (Settings) {
+  
+
+  return new Settings({
+
+    /**
+     * URL to your elasticsearch server. You almost certainly don't
+     * want 'http://localhost:9200' here. Even if Kibana and ES are on
+     * the same host
+     *
+     * By default this will attempt to reach ES at the same host you have
+     * elasticsearch installed on. You probably want to set it to the FQDN of your
+     * elasticsearch host
+     * @type {String}
+     */
+    elasticsearch: #{elasticsearch},
+
+    /**
+     * The default ES index to use for storing Kibana specific object
+     * such as stored dashboards
+     * @type {String}
+     */
+    kibana_index: "kibana-int",
+
+    /**
+     * Panel modules available. Panels will only be loaded when they are defined in the
+     * dashboard, but this list is used in the "add panel" interface.
+     * @type {Array}
+     */
+    panel_names: [
+      'histogram',
+      'map',
+      'pie',
+      'table',
+      'filtering',
+      'timepicker',
+      'text',
+      'fields',
+      'hits',
+      'dashcontrol',
+      'column',
+      'derivequeries',
+      'trends',
+      'bettermap',
+      'query',
+      'terms'
+    ]
+  });
+});
+      CONFIG
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+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/in_kibana_server'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_kibana_server.rb

@@ -0,0 +1,72 @@
+require 'helper'
+require 'net/http'
+require 'uri'
+require 'fileutils'
+
+class KibanaServerInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  BIND = '0.0.0.0'
+  PORT = 24300
+  MOUNT = '/kibana/'
+  ACCESS_LOG_PATH = File.join(File.dirname(__FILE__), 'access.log')
+
+  ELASTICSEARCH_URL = 'http://localhost:9200'
+
+
+  def create_driver(conf)
+    Fluent::Test::InputTestDriver.new(Fluent::KibanaServerInput).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver(create_config)
+
+    assert_equal BIND, d.instance.bind
+    assert_equal PORT, d.instance.port
+    assert_equal MOUNT, d.instance.mount
+    assert_equal ACCESS_LOG_PATH, d.instance.access_log_path
+    assert_equal ELASTICSEARCH_URL, d.instance.elasticsearch_url
+  end
+
+  def test_listen
+    d = create_driver(create_config(bind:'localhost'))
+
+    d.run do
+      res = Net::HTTP.get_response(URI.parse("http://localhost:#{PORT}#{MOUNT}"))
+      assert_equal Net::HTTPOK, res.class
+    end
+
+    FileUtils.rm_f ACCESS_LOG_PATH
+  end
+
+  def test_access_log
+    d = create_driver(create_config(bind:'localhost'))
+    d.run
+    assert_equal true, File.file?(ACCESS_LOG_PATH)
+    FileUtils.rm_f ACCESS_LOG_PATH
+  end
+
+  private
+
+  def create_config(opts={})
+    merged = {
+      bind: BIND,
+      port: PORT,
+      mount: MOUNT,
+      access_log_path: ACCESS_LOG_PATH,
+      elasticsearch_url: ELASTICSEARCH_URL,
+    }.merge(opts)
+
+    %Q{
+      type kibana_server
+      bind #{merged[:bind]}
+      port #{merged[:port]}
+      mount #{merged[:mount]}
+      access_log_path #{merged[:access_log_path]}
+      elasticsearch_url #{merged[:elasticsearch_url]}
+    }
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kibana-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- OKUNO Akihiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin which serves Kibana within fluentd process
+email:
+- choplin.choplin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- example.conf
+- fluent-plugin-kibana-server.gemspec
+- lib/fluent/plugin/in_kibana_server.rb
+- test/helper.rb
+- test/plugin/test_in_kibana_server.rb
+homepage: https://github.com/choplin/fluent-plugin-kibana-server
+licenses:
+- Apache 2.0
+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.23
+signing_key: 
+specification_version: 3
+summary: Fluentd plugin which serves Kibana within fluentd process
+test_files:
+- test/helper.rb
+- test/plugin/test_in_kibana_server.rb
+has_rdoc: