kibana-rack 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c84229a0b4a7242afe5be57e2f6f1d2cc4ea87ed
-  data.tar.gz: a16c4495954ff43258e0a0af39219d1de082cfe8
+  metadata.gz: 12a7837cd69c73cf1ea3684d8c6aabfac206bfc0
+  data.tar.gz: 8f9eea65186608e7de897872c231e2b628dc353d
 SHA512:
-  metadata.gz: d3a4c177193bfb9d395b76d813872e9395789ca2b1fde6d265f3d516e1871d0413de59c51df0a6cee072e2b9314f70474ab6abf54b34d0cb2e4bcaf50d409f93
-  data.tar.gz: 7bc37e75f0a1a97187e9e8b742494d545bdd66381306f00e3035f10ae025abccaba1d5622d722586397c020f9c73a75229801c9e4fa90aa5092799c2b23ca209
+  metadata.gz: 3e6aba3b62820eac07a0bd572cd8fd4654cbccb1665723022f43b71bcd54ade4805e27af7a151858b785d7dc85de60536850d27f47b391e41de91e0e9bd7377a
+  data.tar.gz: 6dd53e6cffdc5f291bee6a8c56ef43634430b949363860597c54031d73f76e1ea1fb63c9d810d23bd30ba739996dd0fe551f7237e57628d496607db7b83c0c01

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change history for kibana-rack
 
+## [v0.1.1](https://github.com/tabolario/kibana-rack/releases/tag/v0.1.1)
+
+* [Bug] [Support scripted dashboard endpoint (/dashboard/script/*.js)](https://github.com/tabolario/kibana-rack/issues/8)
+* [Bug] [Dashboard endpoint should return correct content type](https://github.com/tabolario/kibana-rack/issues/2)
+
 ## [v0.1.0](https://github.com/tabolario/kibana-rack/releases/tag/v0.1.0)
 
 * Initial release

data/README.md

@@ -9,16 +9,25 @@
 
 Embed [Kibana](http://www.elasticsearch.org/overview/kibana/) as a [Rack](http://rack.github.io/) application.
 
-Kibana is a beautiful and powerful dashboard built on top of [Elasticsearch](http://www.elasticsearch.org/). It's great for viewing logs indexed by tools like [logstash](http://logstash.net/) and exploring data on Elasticsearch in general.
+From the [Kibana readme](https://github.com/elasticsearch/kibana/blob/master/README.md):
+
+> Kibana is an open source (Apache Licensed), browser based analytics and search interface to Logstash and other timestamped data sets stored in ElasticSearch. With those in place Kibana is a snap to setup and start using (seriously). Kibana strives to be easy to get started with, while also being flexible and powerful
 
 kibana-rack tracks the latest version of Kibana (currently 3.1.0) and embeds it directly in your application, along with a proxy for the Elasticsearch API endpoints that Kibana needs.
 
-Kibana dashboards can be created using ERB-processed JSON files in the directory specified by your kibana-rack configuration.
+[Kibana dashboards](http://www.elasticsearch.org/guide/en/kibana/current/_dashboard_schema.html) can be created using ERB-processed JSON files in the directory specified by your kibana-rack configuration.
 
 ## Requirements
 
 * Ruby 2.1+ (kibana-rack is developed and tested with Ruby 2.1.2)
 
+### Kibana requirements (also from the Kibana readme)
+
+* Elasticsearch 0.90.9 or above
+* A modern web browser. The latest version of Chrome, Safari and Firefox have all been tested to work. IE9 and greater should work. IE8 does not.
+* A webserver. No extensions are required, as long as it can serve plain html it will work
+* A browser reachable Elasticsearch server. Port 9200 must be open, or a proxy configured to allow access to it. (**kibana-rack takes care of this for you!**)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -224,9 +233,7 @@ When a new **Major** version is made, a corresponding branch will be created nam
 
 ## Todo
 
-* kibana-rails gem for easy integration with Ruby on Rails applications
-* A Ruby DSL for defining dashboards
-* Example dashboards for common use cases
+See the [issue tracker](https://github.com/tabolario/kibana-rack/issues?q=is%3Aopen+is%3Aissue+label%3Atodo) for the current list of todos.
 
 ## License
 

data/lib/kibana/rack.rb

@@ -13,9 +13,27 @@ module Kibana
   DEFAULT_KIBANA_INDEX = 'kibana-int'
 
   class << self
-    attr_accessor :elasticsearch_host, :elasticsearch_port
-    attr_accessor :kibana_dashboards_path, :kibana_default_route, :kibana_index
+    # The hostname of the Elasticsearch instance to proxy to.
+    # @return [String]
+    attr_accessor :elasticsearch_host
 
+    # The port of the Elasticsearch instance to proxy to.
+    # @return [Fixnum]
+    attr_accessor :elasticsearch_port
+
+    # The filesystem path to look for Kibana dashboards.
+    # @return [String]
+    attr_accessor :kibana_dashboards_path
+
+    # The default client-side location that Kibana navigates to.
+    # @return [String]
+    attr_accessor :kibana_default_route
+
+    # The name of the internal Elasticsearch index Kibana uses to store metadata and dashboards.
+    # @return [String]
+    attr_accessor :kibana_index
+
+    # Yields the {Kibana} module to allow configuration of global settings.
     def configure(&block)
       block.call(self)
     end

data/lib/kibana/rack/version.rb

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

data/lib/kibana/rack/web.rb

@@ -2,8 +2,6 @@ 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__)
@@ -33,12 +31,15 @@ module Kibana
         erb :config
       end
 
-      get(%r{/app/dashboards/([\w-]+\.js(on)?)}) do
-        dashboard = params[:captures].first
-        dashboard_path = File.join(settings.kibana_dashboards_path, dashboard)
+      get(%r{/app/dashboard/(file|script)/([\w-]+)\.(js(on)?)}) do
+        dashboard_name = params[:captures][1]
+        dashboard_ext = params[:captures][2]
+        dashboard_path = File.join(settings.kibana_dashboards_path, "#{dashboard_name}.#{dashboard_ext}")
+
         halt(404, { 'Content-Type' => 'application/json' }, '{"error":"Not found"}') unless File.exist?(dashboard_path)
+
         template = IO.read(dashboard_path)
-        content_type 'application/json'
+        content_type "application/#{dashboard_ext}"
         erb template
       end
 

data/spec/fixtures/dashboards/js_dashboard.js

@@ -0,0 +1,5 @@
+var dashboard = {
+  title: "A JS dashboard"
+};
+
+return dashboard;

data/spec/fixtures/dashboards/json_dashboard.json

@@ -0,0 +1,3 @@
+{
+  "title": "A JSON dashboard"
+}

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

@@ -23,22 +23,31 @@ describe Kibana::Rack::Web do
     expect(last_response.status).to eql(200)
   end
 
-  it 'renders dashboards from the dashboard directory' do
-    get '/app/dashboards/default.json'
+  it 'renders JavaScript dashboards from the dashboard directory' do
+    get '/app/dashboard/script/js_dashboard.js'
 
-    expect(last_response.body).to eql(IO.read(File.join(dashboards_path, 'default.json')))
+    expect(last_response.body).to eql(IO.read(File.join(dashboards_path, 'js_dashboard.js')))
+    expect(last_response['Content-Type']).to eql('application/js')
+    expect(last_response.status).to eql(200)
+  end
+
+  it 'renders JSON dashboards from the dashboard directory' do
+    get '/app/dashboard/file/json_dashboard.json'
+
+    expect(last_response.body).to eql(IO.read(File.join(dashboards_path, 'json_dashboard.json')))
+    expect(last_response['Content-Type']).to eql('application/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'
+    get '/app/dashboard/file/erb_dashboard.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'
+    get '/app/dashboard/file/nonexistent.json'
 
     expect(last_response.body.strip).to eql('{"error":"Not found"}')
     expect(last_response.status).to eql(404)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kibana-rack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tony Burns
@@ -30,7 +30,7 @@ cert_chain:
   WdK2SktNC0LYNRz+x3DdkcnVGS5BbSE7CYk7ap0J9jTobkmBTZ6tNWhVQiy7eJLr
   pOgabsoLeT6zXAW+EOudMh1S/ZA=
   -----END CERTIFICATE-----
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -151,8 +151,9 @@ files:
 - lib/kibana/rack.rb
 - lib/kibana/rack/version.rb
 - lib/kibana/rack/web.rb
-- spec/fixtures/dashboards/default.json
-- spec/fixtures/dashboards/templated.json
+- spec/fixtures/dashboards/erb_dashboard.json
+- spec/fixtures/dashboards/js_dashboard.js
+- spec/fixtures/dashboards/json_dashboard.json
 - spec/spec_helper.rb
 - spec/unit/kibana/rack/web_spec.rb
 - spec/unit/kibana/rack_spec.rb
@@ -328,8 +329,9 @@ signing_key:
 specification_version: 4
 summary: Embed Kibana as a Rack application
 test_files:
-- spec/fixtures/dashboards/default.json
-- spec/fixtures/dashboards/templated.json
+- spec/fixtures/dashboards/erb_dashboard.json
+- spec/fixtures/dashboards/js_dashboard.js
+- spec/fixtures/dashboards/json_dashboard.json
 - spec/spec_helper.rb
 - spec/unit/kibana/rack/web_spec.rb
 - spec/unit/kibana/rack_spec.rb

data/spec/fixtures/dashboards/default.json

@@ -1,90 +0,0 @@
-{
-  "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
-}