Skip to content
This repository has been archived by the owner on Mar 31, 2024. It is now read-only.

Commit

Permalink
[server/status] implement generic status tracking
Browse files Browse the repository at this point in the history 
In elastic#7333 we needed the ability to set the server status from outside of a plugin, but statuses were implemented in a way that coupled them to plugins. This let to reaching in and setting the status of a plugin from the server. Rather than extending the undesirable coupling of status & plugin I've instead made the server status service support creating more generic status tracker objects, and extended it's API to include plugin-specific methods like `createForPluginId(pluginId)` and `getStateForPluginId(pluginId)`.

With the new API the settings service will be able to create it's own status object with `kbnServer.status.create('settings')` rather than reaching into the kibana plugin and setting its status.
  • Loading branch information
spalger committed Jun 15, 2016
1 parent dbfee59 commit e6a8da0
Show file tree
Hide file tree
Showing 9 changed files with 190 additions and 84 deletions.
39 changes: 30 additions & 9 deletions src/plugins/status_page/public/status_page.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,48 @@ <h1>
</div>
</div>

<div class="row plugin_status_wrapper">
<h3>Installed Plugins</h3>
<div class="row status_status_wrapper">
<h3>Status Breakdown</h3>

<div ng-if="!ui.statuses && ui.loading" class="loading_statuses">
<span class="spinner"></span>
</div>

<h4 ng-if="!ui.statuses && !ui.loading" class="missing_statuses">
No plugin status information available
No status information available
</h4>

<table class="plugin_status_breakdown" ng-if="ui.statuses">
<table class="status_status_breakdown" ng-if="ui.statuses.services">
<tr class="row">
<th class="col-xs-2">Service</th>
<th class="col-xs-8">Status</th>
</tr>
<tr
ng-repeat="status in ui.statuses.services"
class="status_row status_state_default status_state_{{status.state}} row">

<td class="col-xs-2 status_name">{{status.id}}</td>
<td class="col-xs-8 status_message">
<i class="fa status_state_color status_state_icon" />
{{status.message}}
</td>
</tr>
</table>

<table class="status_status_breakdown" ng-if="ui.statuses.plugins">
<tr class="row">
<th class="col-xs-2">Name</th>
<th class="col-xs-2">Plugin</th>
<th class="col-xs-2">Version</th>
<th class="col-xs-8">Status</th>
</tr>
<tr ng-repeat="status in ui.statuses" class="status_row plugin_state_default plugin_state_{{status.state}} row">
<td class="col-xs-2 status_name">{{status.name}}</td>
<td class="col-xs-2 status_version">{{status.version}}</td>
<tr
ng-repeat="status in ui.statuses.plugins"
class="status_row status_state_default status_state_{{status.state}} row">

<td class="col-xs-2 status_name">{{status.plugin.id}}</td>
<td class="col-xs-2 status_version">{{status.plugin.version}}</td>
<td class="col-xs-8 status_message">
<i class="fa plugin_state_color plugin_state_icon" />
<i class="fa status_state_color status_state_icon" />
{{status.message}}
</td>
</tr>
Expand Down
4 changes: 3 additions & 1 deletion src/plugins/status_page/public/status_page.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ const chrome = require('ui/chrome')

const data = resp.data;
ui.metrics = data.metrics;
ui.statuses = data.status.statuses;
ui.name = data.name;

ui.statuses = _.groupBy(data.status.statuses, s => s.plugin ? 'plugins' : 'services');
if (!_.size(ui.statuses)) ui.statuses = null;

const overall = data.status.overall;
if (!ui.serverState || (ui.serverState !== overall.state)) {
ui.serverState = overall.state;
Expand Down
46 changes: 23 additions & 23 deletions src/plugins/status_page/public/status_page.less
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
@status-metric-border: #aaa;
@status-metric-title-color: #666;

@status-plugins-bg: #fff;
@status-plugins-border: #bbb;
@status-plugins-headings-color: #666;
@status-statuses-bg: #fff;
@status-statuses-border: #bbb;
@status-statuses-headings-color: #666;

@status-default: #7c7c7c;
@status-green: #94c63d;
Expand Down Expand Up @@ -58,13 +58,13 @@
}
}

// plugin status table section
.plugin_status_wrapper {
// status status table section
.status_status_wrapper {
margin-top: 25px;
margin-left: -5px;
margin-right: -5px;
border-top:2px solid;
background-color: @status-plugins-bg;
background-color: @status-statuses-bg;
padding: 10px;

h3 {
Expand All @@ -78,24 +78,24 @@
text-align: center;
}

.plugin_status_breakdown {
.status_status_breakdown {
margin-left: 0;
margin-right: 0;

.status_row {
height:30px;
line-height:30px;
border-bottom:1px solid;
border-bottom-color: @status-plugins-border;
border-bottom-color: @status-statuses-border;
}

th {
color:@status-plugins-headings-color;
color:@status-statuses-headings-color;
font-weight: normal;
height:25px;
line-height:25px;
border-bottom:1px solid;
border-bottom-color: @status-plugins-border;
border-bottom-color: @status-statuses-border;
}

.status_name {
Expand All @@ -111,13 +111,13 @@
}
}

//plugin state
.plugin_state(@color, @icon) {
.plugin_state_color {
//status state
.status_state(@color, @icon) {
.status_state_color {
color: @color;
}

.plugin_state_icon:before {
.status_state_icon:before {
content: @icon;
}

Expand All @@ -130,20 +130,20 @@
}
}

.plugin_state_default {
.plugin_state(@status-default, @icon-default);
.status_state_default {
.status_state(@status-default, @icon-default);
}

.plugin_state_green {
.plugin_state(@status-green, @icon-green);
.status_state_green {
.status_state(@status-green, @icon-green);
}

.plugin_state_yellow {
.plugin_state(@status-yellow, @icon-yellow);
.status_state_yellow {
.status_state(@status-yellow, @icon-yellow);
}

.plugin_state_red {
.plugin_state(@status-red, @icon-red);
.status_state_red {
.status_state(@status-red, @icon-red);
}

//server state
Expand All @@ -156,7 +156,7 @@
content: @icon;
}

.plugin_status_wrapper {
.status_status_wrapper {
border-top-color: @color;
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/server/plugins/plugin.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ module.exports = class Plugin {
server.exposeStaticDir(`/plugins/${id}/{path*}`, this.publicDir);
}

this.status = kbnServer.status.create(this);
this.status = kbnServer.status.createForPlugin(this);
server.expose('status', this.status);

return await attempt(this.externalInit, [server, options], this);
Expand Down
85 changes: 58 additions & 27 deletions src/server/status/__tests__/server_status.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import _ from 'lodash';
import { find } from 'lodash';
import expect from 'expect.js';
import sinon from 'sinon';

Expand All @@ -17,31 +17,63 @@ describe('ServerStatus class', function () {
serverStatus = new ServerStatus(server);
});

describe('#create(plugin)', function () {
describe('#create(id)', () => {
it('should create a new plugin with an id', () => {
const status = serverStatus.create('someid');
expect(status).to.be.a(Status);
});
});

describe('#createForPlugin(plugin)', function () {
it('should create a new status by plugin', function () {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
expect(status).to.be.a(Status);
});
});

describe('#get(name)', function () {
it('exposes plugins by its id/name', function () {
let status = serverStatus.create(plugin);
expect(serverStatus.get('name')).to.be(status);
describe('#get(id)', () => {
it('exposes statuses by their id', () => {
const status = serverStatus.create('statusid');
expect(serverStatus.get('statusid')).to.be(status);
});

it('does not get the status for a plugin', () => {
serverStatus.createForPlugin(plugin);
expect(serverStatus.get(plugin)).to.be(undefined);
});
});

describe('#getForPluginId(plugin)', function () {
it('exposes plugin status for the plugin', function () {
let status = serverStatus.createForPlugin(plugin);
expect(serverStatus.getForPluginId(plugin.id)).to.be(status);
});

it('does not get plain statuses by their id', function () {
serverStatus.create('someid');
expect(serverStatus.getForPluginId('someid')).to.be(undefined);
});
});

describe('#getState(id)', function () {
it('should expose the state of a status by id', function () {
let status = serverStatus.create('someid');
status.green();
expect(serverStatus.getState('someid')).to.be('green');
});
});

describe('#getState(name)', function () {
it('should expose the state of the plugin by name', function () {
let status = serverStatus.create(plugin);
describe('#getStateForPluginId(plugin)', function () {
it('should expose the state of a plugin by id', function () {
let status = serverStatus.createForPlugin(plugin);
status.green();
expect(serverStatus.getState('name')).to.be('green');
expect(serverStatus.getStateForPluginId(plugin.id)).to.be('green');
});
});

describe('#overall()', function () {
it('considers each status to produce a summary', function () {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);

expect(serverStatus.overall().state).to.be('uninitialized');

Expand Down Expand Up @@ -69,25 +101,24 @@ describe('ServerStatus class', function () {
it('serializes to overall status and individuals', function () {
const pluginOne = {id: 'one', version: '1.0.0'};
const pluginTwo = {id: 'two', version: '2.0.0'};
const pluginThree = {id: 'three', version: '3.0.0'};

let one = serverStatus.create(pluginOne);
let two = serverStatus.create(pluginTwo);
let three = serverStatus.create(pluginThree);
let service = serverStatus.create('some service');
let p1 = serverStatus.createForPlugin(pluginOne);
let p2 = serverStatus.createForPlugin(pluginTwo);

one.green();
two.yellow();
three.red();
service.green();
p1.yellow();
p2.red();

let obj = JSON.parse(JSON.stringify(serverStatus));
expect(obj).to.have.property('overall');
expect(obj.overall.state).to.eql(serverStatus.overall().state);
expect(obj.statuses).to.have.length(3);
let json = JSON.parse(JSON.stringify(serverStatus));
expect(json).to.have.property('overall');
expect(json.overall.state).to.eql(serverStatus.overall().state);
expect(json.statuses).to.have.length(3);

let outs = _.indexBy(obj.statuses, 'name');
expect(outs.one).to.have.property('state', 'green');
expect(outs.two).to.have.property('state', 'yellow');
expect(outs.three).to.have.property('state', 'red');
const out = status => find(json.statuses, { id: status.id });
expect(out(service)).to.have.property('state', 'green');
expect(out(p1)).to.have.property('state', 'yellow');
expect(out(p2)).to.have.property('state', 'red');
});
});

Expand Down
22 changes: 11 additions & 11 deletions src/server/status/__tests__/status.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ describe('Status class', function () {
});

it('should have an "uninitialized" state initially', function () {
expect(serverStatus.create(plugin)).to.have.property('state', 'uninitialized');
expect(serverStatus.createForPlugin(plugin)).to.have.property('state', 'uninitialized');
});

it('emits change when the status is set', function (done) {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);

status.once('change', function (prev, prevMsg) {
expect(status.state).to.be('green');
Expand All @@ -42,7 +42,7 @@ describe('Status class', function () {
});

it('should only trigger the change listener when something changes', function () {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
let stub = sinon.stub();
status.on('change', stub);
status.green('Ready');
Expand All @@ -52,18 +52,18 @@ describe('Status class', function () {
});

it('should create a JSON representation of the status', function () {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
status.green('Ready');

let json = status.toJSON();
expect(json.name).to.eql(plugin.id);
expect(json.version).to.eql(plugin.version);
expect(json.id).to.eql(status.id);
expect(json.plugin).to.eql({ id: plugin.id, version: plugin.version });
expect(json.state).to.eql('green');
expect(json.message).to.eql('Ready');
});

it('should call on handler if status is already matched', function (done) {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
let msg = 'Test Ready';
status.green(msg);

Expand All @@ -77,7 +77,7 @@ describe('Status class', function () {
});

it('should call once handler if status is already matched', function (done) {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
let msg = 'Test Ready';
status.green(msg);

Expand All @@ -92,15 +92,15 @@ describe('Status class', function () {

function testState(color) {
it(`should change the state to ${color} when #${color}() is called`, function () {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
let message = 'testing ' + color;
status[color](message);
expect(status).to.have.property('state', color);
expect(status).to.have.property('message', message);
});

it(`should trigger the "change" listner when #${color}() is called`, function (done) {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
let message = 'testing ' + color;
status.on('change', function (prev, prevMsg) {
expect(status.state).to.be(color);
Expand All @@ -114,7 +114,7 @@ describe('Status class', function () {
});

it(`should trigger the "${color}" listner when #${color}() is called`, function (done) {
let status = serverStatus.create(plugin);
let status = serverStatus.createForPlugin(plugin);
let message = 'testing ' + color;
status.on(color, function (prev, prevMsg) {
expect(status.state).to.be(color);
Expand Down
Loading

0 comments on commit e6a8da0

Please sign in to comment.