kibana-rack 0.1.0

data/examples/rails/config/environments/test.rb

@@ -0,0 +1,11 @@
+Rails.application.configure do
+  config.cache_classes = true
+  config.consider_all_requests_local = true
+  config.eager_load = false
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
+  config.action_controller.allow_forgery_protection = false
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.active_support.deprecation = :stderr
+end

data/examples/rails/config/initializers/cookies_serializer.rb

@@ -0,0 +1 @@
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/examples/rails/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1 @@
+Rails.application.config.filter_parameters += %i(password)

data/examples/rails/config/initializers/kibana.rb

@@ -0,0 +1,3 @@
+Kibana.configure do |config|
+  config.kibana_dashboards_path = Rails.root.join('app/kibana')
+end

data/examples/rails/config/initializers/session_store.rb

@@ -0,0 +1 @@
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/examples/rails/config/initializers/wrap_parameters.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end

data/examples/rails/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount Kibana::Rack::Web => '/kibana'
+end

data/examples/rails/config/secrets.yml

@@ -0,0 +1,9 @@
+---
+development:
+  secret_key_base: f8fbe13331f2261f989b0bffbe72a3255bff3a76d1b2061c6672a2addc5a4d68bf91ff969c7444d013c1d0ff2bd4c205bfe0f25564408d82cb99fbc42aa83150
+
+test:
+  secret_key_base: d8aa6adba6ef61735c328af28544248524437fafdf251fcb040bbdeeec188124df4abe15b6f9672a10dfb556c8d3fd89395a94ecdab7f7d35e5600c75e672ac4
+
+production:
+  secret_key_base: <%= ENV['SECRET_KEY_BASE'] %>

data/examples/sinatra/config.ru

@@ -0,0 +1,27 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'kibana/rack'
+require 'sinatra/base'
+
+ENV['EXAMPLE_NAME'] = 'Rails Example'
+
+Kibana.configure do |config|
+  config.kibana_dashboards_path = File.expand_path('../../dashboards', __FILE__)
+end
+
+class SinatraExample < Sinatra::Base
+  get '/' do
+    'kibana-rack Sinatra example'
+  end
+end
+
+app = Rack::Builder.app do
+  map '/kibana' do
+    use Kibana::Rack::Web
+  end
+
+  run SinatraExample
+end
+
+run app

data/examples/sinatra/dashboards/default.json

@@ -0,0 +1,90 @@
+{
+  "title": "kibana-rack Sinatra Example",
+  "services": {
+    "query": {
+      "list": {
+        "0": {
+          "query": "*",
+          "alias": "",
+          "color": "#7EB26D",
+          "id": 0,
+          "pin": false,
+          "type": "lucene"
+        }
+      },
+      "ids": [
+        0
+      ]
+    },
+    "filter": {
+      "list": {},
+      "ids": []
+    }
+  },
+  "rows": [
+    {
+      "title": "Intro",
+      "height": "700px",
+      "editable": false,
+      "collapse": false,
+      "collapsable": false,
+      "panels": [
+        {
+          "error": false,
+          "span": 4,
+          "editable": false,
+          "group": [
+            "default"
+          ],
+          "type": "text",
+          "mode": "markdown",
+          "content": "![kibana](img/kibana.png)  \n\n##### Did you just upgrade? Not expecting this screen?\nIf you were using the old default page you might not be expecting this screen. I understand, change can be awkward. Let me explain. \n\n##### Setting a global default dashboard\nKibana has always shipped with an interface for Logstash, still does! You can access it [here](index.html#dashboard/file/logstash.json). However, if you want to make it your default again, all you need to do is rename a file!\nIn your Kibana installation directory: \n\nRename *logstash.json* to *default.json* and refresh. Should be all set.\n\n##### But wait, there's more!\nIn fact, you can add any exported dashboard to that directory and access it as *http://YOUR-HOST -HERE/index.html#dashboard/file/YOUR-DASHBOARD.json*. Neat trick eh?",
+          "style": {},
+          "title": "",
+          "status": "Stable"
+        },
+        {
+          "error": false,
+          "span": 8,
+          "editable": false,
+          "group": [
+            "default"
+          ],
+          "type": "text",
+          "mode": "markdown",
+          "content": "### Welcome to Kibana. \nGlad you could make it. Happy to have you here! Lets get started, shall we?\n##### Requirements\n* **A good browser.**  \n    The latest version of Chrome or Firefox is recommended. Safari (latest version) and Internet Explorer 9 and above are also supported.\n* **A webserver.**  \n    Just somewhere to host the HTML and Javascript. Basically any webserver will work.\n* **Elasticsearch**  \n   0.90.9 or above. \n\n##### Configuration\nIf Kibana and Elasticsearch are on the same host, and you're using the default Elasticsearch port, then you're all set. Kibana is configured to use that setup by default!  \n\nIf not, you need to edit *config.js* and set the *elasticsearch* parameter with the URL (including port, probably 9200) of your Elasticsearch server. The host part should be the entire, fully qualified domain name, or IP, **not localhost**.\n#### Are you a Logstash User?\n+ **YES** - Great! We have a prebuilt dashboard: [(Logstash Dashboard)](index.html#/dashboard/file/logstash.json). See the note to the right about making it your global default  \n\n+ **NO** - Hey, no problem, you just have a bit of setup to do. You have a few choices:  \n\n    1. [Sample Dashboard](index.html#/dashboard/file/guided.json) *I don't have much data yet, please extract some basics for me*  \n    2. [Unconfigured Dashboard](index.html#/dashboard/file/noted.json) *I have a lot of data and I don't want Kibana to query it at once*\n    3. [Blank Dashboard](index.html#/dashboard/file/blank.json) *I'm comfortable figuring it out on my own*",
+          "style": {},
+          "status": "Stable"
+        }
+      ],
+      "notice": false
+    }
+  ],
+  "editable": false,
+  "index": {
+    "interval": "none",
+    "pattern": "[logstash-]YYYY.MM.DD",
+    "default": "_all",
+    "warm_fields": false
+  },
+  "style": "dark",
+  "failover": false,
+  "panel_hints": true,
+  "pulldowns": [],
+  "nav": [],
+  "loader": {
+    "save_gist": false,
+    "save_elasticsearch": true,
+    "save_local": true,
+    "save_default": true,
+    "save_temp": true,
+    "save_temp_ttl_enable": true,
+    "save_temp_ttl": "30d",
+    "load_gist": true,
+    "load_elasticsearch": true,
+    "load_elasticsearch_size": 20,
+    "load_local": true,
+    "hide": false
+  },
+  "refresh": false
+}

data/kibana-rack.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kibana/rack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kibana-rack'
+  spec.version       = Kibana::Rack::VERSION
+  spec.authors       = ['Tony Burns']
+  spec.email         = ['tony@tabolario.com']
+  spec.summary       = 'Embed Kibana as a Rack application'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/tabolario/kibana-rack'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.cert_chain = %w(tabolario.pem)
+  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME =~ /gem\z/
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'sinatra-contrib'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+end

data/lib/kibana/rack.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'sinatra/base'
+require 'sinatra/multi_route'
+
+require 'kibana/rack/version'
+require 'kibana/rack/web'
+
+module Kibana
+  DEFAULT_ELASTICSEARCH_HOST = 'localhost'
+  DEFAULT_ELASTICSEARCH_PORT = 9200
+  DEFAULT_KIBANA_DASHBOARDS_PATH = File.expand_path('../../../dashboards', __FILE__)
+  DEFAULT_KIBANA_DEFAULT_ROUTE = '/dashboard/file/default.json'
+  DEFAULT_KIBANA_INDEX = 'kibana-int'
+
+  class << self
+    attr_accessor :elasticsearch_host, :elasticsearch_port
+    attr_accessor :kibana_dashboards_path, :kibana_default_route, :kibana_index
+
+    def configure(&block)
+      block.call(self)
+    end
+  end
+
+  configure do |config|
+    config.elasticsearch_host = DEFAULT_ELASTICSEARCH_HOST
+    config.elasticsearch_port = DEFAULT_ELASTICSEARCH_PORT
+    config.kibana_dashboards_path = DEFAULT_KIBANA_DASHBOARDS_PATH
+    config.kibana_default_route = DEFAULT_KIBANA_DEFAULT_ROUTE
+    config.kibana_index = DEFAULT_KIBANA_INDEX
+  end
+
+  module Rack
+  end
+end

data/lib/kibana/rack/version.rb

@@ -0,0 +1,5 @@
+module Kibana
+  module Rack
+    VERSION = '0.1.0'
+  end
+end

data/lib/kibana/rack/web.rb

@@ -0,0 +1,60 @@
+module Kibana
+  module Rack
+    # Rack application that serves Kibana and proxies requests to Elasticsearch
+    class Web < Sinatra::Base
+      VERSION = '0.1.0'
+
+      register Sinatra::MultiRoute
+
+      set :root, File.expand_path('../../../../web', __FILE__)
+      set :public_folder, -> { "#{root}/assets" }
+      set :views, -> { "#{root}/views" }
+
+      set :elasticsearch_host, -> { Kibana.elasticsearch_host }
+      set :elasticsearch_port, -> { Kibana.elasticsearch_port }
+      set :kibana_dashboards_path, -> { Kibana.kibana_dashboards_path }
+      set :kibana_default_route, -> { Kibana.kibana_default_route }
+      set :kibana_index, -> { Kibana.kibana_index }
+
+      helpers do
+        def proxy
+          es_host = settings.elasticsearch_host
+          es_port = settings.elasticsearch_port
+          @proxy ||= Faraday.new(url: "http://#{es_host}:#{es_port}")
+        end
+      end
+
+      get '/' do
+        erb :index
+      end
+
+      get '/config.js' do
+        content_type 'application/javascript'
+        erb :config
+      end
+
+      get(%r{/app/dashboards/([\w-]+\.js(on)?)}) do
+        dashboard = params[:captures].first
+        dashboard_path = File.join(settings.kibana_dashboards_path, dashboard)
+        halt(404, { 'Content-Type' => 'application/json' }, '{"error":"Not found"}') unless File.exist?(dashboard_path)
+        template = IO.read(dashboard_path)
+        content_type 'application/json'
+        erb template
+      end
+
+      route(:delete, :get, :post, :put, %r{^((/_(aliases|nodes))|(.+/_(aliases|mapping|search)))}) do
+        request.body.rewind
+
+        proxy_method = request.request_method.downcase.to_sym
+        proxy_response = proxy.send(proxy_method) do |proxy_request|
+          proxy_request.url(params[:captures].first)
+          proxy_request.headers['Content-Type'] = 'application/json'
+          proxy_request.params = env['rack.request.query_hash']
+          proxy_request.body = request.body.read if proxy_method == :post
+        end
+
+        [proxy_response.status, proxy_response.headers, proxy_response.body]
+      end
+    end
+  end
+end

data/spec/fixtures/dashboards/default.json

@@ -0,0 +1,90 @@
+{
+  "title": "Introduction",
+  "services": {
+    "query": {
+      "list": {
+        "0": {
+          "query": "*",
+          "alias": "",
+          "color": "#7EB26D",
+          "id": 0,
+          "pin": false,
+          "type": "lucene"
+        }
+      },
+      "ids": [
+        0
+      ]
+    },
+    "filter": {
+      "list": {},
+      "ids": []
+    }
+  },
+  "rows": [
+    {
+      "title": "Intro",
+      "height": "450px",
+      "editable": false,
+      "collapse": false,
+      "collapsable": false,
+      "panels": [
+        {
+          "error": false,
+          "span": 4,
+          "editable": false,
+          "group": [
+            "default"
+          ],
+          "type": "text",
+          "mode": "markdown",
+          "content": "![kibana](img/kibana.png)  \n\n##### Did you just upgrade? Not expecting this screen?\nIf you were using the old default page you might not be expecting this screen. I understand, change can be awkward. Let me explain. \n\n##### Setting a global default dashboard\nKibana has always shipped with an interface for Logstash, still does! You can access it [here](index.html#dashboard/file/logstash.json). However, if you want to make it your default again, all you need to do is rename a file!\nIn your Kibana installation directory: \n\nRename *logstash.json* to *default.json* and refresh. Should be all set.\n\n##### But wait, there's more!\nIn fact, you can add any exported dashboard to that directory and access it as *http://YOUR-HOST -HERE/index.html#dashboard/file/YOUR-DASHBOARD.json*. Neat trick eh?",
+          "style": {},
+          "title": "",
+          "status": "Stable"
+        },
+        {
+          "error": false,
+          "span": 8,
+          "editable": false,
+          "group": [
+            "default"
+          ],
+          "type": "text",
+          "mode": "markdown",
+          "content": "### Welcome to Kibana. \nGlad you could make it. Happy to have you here! Lets get started, shall we?\n##### Requirements\n* **A good browser.**  \n    The latest version of Chrome or Firefox is recommended. Safari (latest version) and Internet Explorer 9 and above are also supported.\n* **A webserver.**  \n    Just somewhere to host the HTML and Javascript. Basically any webserver will work.\n* **Elasticsearch**  \n   0.90.9 or above. \n\n##### Configuration\nIf Kibana and Elasticsearch are on the same host, and you're using the default Elasticsearch port, then you're all set. Kibana is configured to use that setup by default!  \n\nIf not, you need to edit *config.js* and set the *elasticsearch* parameter with the URL (including port, probably 9200) of your Elasticsearch server. The host part should be the entire, fully qualified domain name, or IP, **not localhost**.\n#### Are you a Logstash User?\n+ **YES** - Great! We have a prebuilt dashboard: [(Logstash Dashboard)](index.html#/dashboard/file/logstash.json). See the note to the right about making it your global default  \n\n+ **NO** - Hey, no problem, you just have a bit of setup to do. You have a few choices:  \n\n    1. [Sample Dashboard](index.html#/dashboard/file/guided.json) *I don't have much data yet, please extract some basics for me*  \n    2. [Unconfigured Dashboard](index.html#/dashboard/file/noted.json) *I have a lot of data and I don't want Kibana to query it at once*\n    3. [Blank Dashboard](index.html#/dashboard/file/blank.json) *I'm comfortable figuring it out on my own*",
+          "style": {},
+          "status": "Stable"
+        }
+      ],
+      "notice": false
+    }
+  ],
+  "editable": false,
+  "index": {
+    "interval": "none",
+    "pattern": "[logstash-]YYYY.MM.DD",
+    "default": "_all",
+    "warm_fields": false
+  },
+  "style": "dark",
+  "failover": false,
+  "panel_hints": true,
+  "pulldowns": [],
+  "nav": [],
+  "loader": {
+    "save_gist": false,
+    "save_elasticsearch": true,
+    "save_local": true,
+    "save_default": true,
+    "save_temp": true,
+    "save_temp_ttl_enable": true,
+    "save_temp_ttl": "30d",
+    "load_gist": true,
+    "load_elasticsearch": true,
+    "load_elasticsearch_size": 20,
+    "load_local": true,
+    "hide": false
+  },
+  "refresh": false
+}

data/spec/fixtures/dashboards/templated.json

@@ -0,0 +1 @@
+{"title":"<%= ENV['DASHBOARD_TITLE'] %>"}

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'bundler/setup'
+require 'simplecov'
+
+Bundler.require(:test)
+Bundler.require(:debugger) unless ENV.key?('CI')
+
+ENV['RACK_ENV'] = 'test'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'kibana/rack'
+
+require 'rack/test'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.filter_run :focus
+  config.order = :random
+  config.profile_examples = 10
+  config.run_all_when_everything_filtered = true
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  Kernel.srand config.seed
+end

data/spec/unit/kibana/rack/web_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Kibana::Rack::Web do
+  include Rack::Test::Methods
+
+  let(:app) { described_class }
+
+  let(:dashboards_path) { File.expand_path('../../../../fixtures/dashboards', __FILE__) }
+
+  before do
+    app.set(:raise_exceptions, true)
+    app.set(:show_exceptions, false)
+    app.set(:kibana_dashboards_path, dashboards_path)
+  end
+
+  it 'serves the Kibana application' do
+    get '/'
+    expect(last_response.status).to eql(200)
+  end
+
+  it 'serves the Kibana configuration' do
+    get '/config.js'
+    expect(last_response.status).to eql(200)
+  end
+
+  it 'renders dashboards from the dashboard directory' do
+    get '/app/dashboards/default.json'
+
+    expect(last_response.body).to eql(IO.read(File.join(dashboards_path, 'default.json')))
+    expect(last_response.status).to eql(200)
+  end
+
+  it 'processes ERB in dashboards' do
+    ENV['DASHBOARD_TITLE'] = 'My Dashboard'
+    get '/app/dashboards/templated.json'
+
+    expect(last_response.body.strip).to eql('{"title":"My Dashboard"}')
+  end
+
+  it 'returns 404 if a dashboard does not exist' do
+    get '/app/dashboards/nonexistent.json'
+
+    expect(last_response.body.strip).to eql('{"error":"Not found"}')
+    expect(last_response.status).to eql(404)
+  end
+
+  {
+    '/_aliases'                                         => { method: :get },
+    '/_nodes'                                           => { method: :get },
+    '/_all/_aliases'                                    => { method: :get },
+    '/_all/_mapping'                                    => { method: :get },
+    '/_all/_search'                                     => { method: :post, body: '{"j":"s","o":"n"}' },
+    '/logstash-2014.08.08,logstash-2014.08.09/_aliases' => { method: :get, params: { ignore_missing: 'true' } }
+  }.each do |path, options|
+    it "proxies #{options[:method].upcase} #{path} to Elasticsearch" do
+      request_method = options[:method]
+      stub_request(request_method, "localhost:9200#{path}")
+        .with(body: options[:body], query: options[:params])
+        .to_return(body: '{}', headers: { 'foo' => 'bar' }, status: 200)
+
+      request_params = request_method == :post ? options[:body] : options[:params]
+      send(request_method, path, request_params)
+
+      expect(last_response.body).to eql('{}')
+      expect(last_response.status).to eql(200)
+      expect(last_response.headers).to include('foo' => 'bar')
+    end
+  end
+end