Adding "plugins" : proposed pull request

[ghost]

I have extended Kibana with a simple "plugin" mechanism modeled after the existing panel mechanism. The purpose is to support injecting new modules in a way that only has to touch config.js, rather than having to modify app.js . Since the intent is to support arbitrary modules, "panels" did not seem appropriate, but usage is the same.

As part of this, in order to allow plugins to register to handle routes without dashboard loading, I am also proposing to replace the "$routeChangeSuccess" listener in the services.js/dashboard with a proper controller.

The changes preserve all existing behavior, including the loading of the default dashboard if a nonsense fragment is entered. The difference is that I can also now add my own module that registers new routes with the $routeProvider, and I won't always get the dash loading behavior (since this is implemented in a "global" event listener).

The essential changes are below, but if you are favorable I'll submit a pull request so you can see the complete changes.

services.js: remove
$rootScope.$on('$routeChangeSuccess',function(){
// Clear the current dashboard to prevent reloading
self.current = {};
self.indices = [];
route();
});

controllers.js: add

_.each(config.plugins, function(v) {
labjs = labjs.script('plugins/'+v+'/module.js');
modules.push('kibana.'+v);
});

...

.controller('DashRouteCtrl', function (dashboard) {
// Invoked whenever the route changes in order to load the correct dashboard
dashboard.current = {};
dashboard.indices = [];
dashboard.route();
})

app.js: change

  var route = { templateUrl: 'partials/dashboard.html', controller: 'DashRouteCtrl' };

  $routeProvider
    .when('/dashboard', route)
    .when('/dashboard/:type/:id', route)
    .when('/dashboard/:type/:id/:params', route)
    .otherwise({
      redirectTo: 'dashboard'
    });

[ghost]

See description of changes here:
https://github.com/packetvideo/kibana-dj/commit/0dec84b024dfc3f458b8e4bdc5aaca910dd6582f

(Ignore the '[dj]' plugin, this should be an empty list)

[rashidkpc]

Given that this doesn't modify any existing behavior, I think its probably a good idea. Might also make sense to change 'modules' to 'panels' in the config and document the different.

What sort of new routes are you thinking of adding?

[ghost]

Thanks for the reply, Rashid.

The markdown in the original ticket got munged; the comment I added afterward links to a commit that makes the change clearer.

In my fork, if Kibana gets a route of #/dj/(id) rather than #/dashboard/(type)/(id), then my controller constructs a dashboard model using a particular JSON format. I added some documentation to my fork’s README:
https://github.com/packetvideo/kibana-dj/blob/master/README.md

The module implementation is here, still a work in progress:
https://github.com/packetvideo/kibana-dj/blob/master/plugins/dj/module.js
In essence the dashboard in DJ JSON format is loaded and manipulated into the model Kibana is expecting.

--Andy

From: Rashid Khan [mailto:notifications@github.com]
Sent: Tuesday, August 13, 2013 8:10 PM
To: elasticsearch/kibana
Cc: Andy Jenkins
Subject: Re: [kibana] Adding "plugins" : proposed pull request (#344)

Given that this doesn't modify any existing behavior, I think its probably a good idea. Might also make sense to change 'modules' to 'panels' in the config and document the different.

What sort of new routes are you thinking of adding?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/344#issuecomment-22607011.

[rashidkpc]

Closing this, we're heading down a different path for being able to inject other applications besides the dashboard.