├── assets
    └── images
    │   └── demo.gif
├── index.js
├── package.json
├── public
    ├── index.less
    ├── health_metric_vis.js
    ├── health_metric_vis_controller.js
    └── health_metric_vis_params.html
├── README.md
└── LICENSE


/assets/images/demo.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/clamarque/kibana_health_metric_vis/HEAD/assets/images/demo.gif


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | export default function (kibana) {
2 |     return new kibana.Plugin({
3 |         uiExports: {
4 |             visTypes: [
5 |                 'plugins/health_metric_vis/health_metric_vis'
6 |             ]
7 |         }
8 |     });
9 | };


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "health_metric_vis",
 3 |     "version": "6.8.x",
 4 |     "kibana": {
 5 |         "version": "6.8.x"
 6 |     },
 7 |     "author": "clamarque",
 8 |     "description": "change color of metric depending to the planned state of health",
 9 |     "homepage": "https://github.com/clamarque/kibana_health_metric_vis",
10 |     "main": "index.js"
11 | }
12 | 


--------------------------------------------------------------------------------
/public/index.less:
--------------------------------------------------------------------------------
 1 | .mtrVis__container {
 2 |     display: flex;
 3 |     flex-direction: column;
 4 |     justify-content: center;
 5 |     align-items: center;
 6 |     flex: 1;
 7 |     height: 100%;
 8 | }
 9 | 
10 | input[type=checkbox] {
11 |     margin: 0 5px 0 0;
12 | }
13 | 
14 | .kuiSideBarFormRow .threshold {
15 |     flex-direction: column;
16 |     flex: 1 1 30% !important;
17 | }
18 | 
19 | .kuiSideBarFormRow__label .threshold__info {
20 |     display: block;
21 |     margin: 5px 5px 0 0;
22 |     font-size: 10px;
23 | }
24 | 
25 | .kuiSideBarFormRow__control .view-color {
26 |     width: 80px;
27 |     border: none;
28 |     background: transparent;
29 | }
30 | 
31 | .kuiSideBarFormRow .threshold__number {
32 |     margin: 0 0 0 15px;
33 | }
34 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # kibana_health_metric_vis
 2 | A kibana plugin  to change color of metric depending to the planned state of health 
 3 | 
 4 | This plugin is inspired by the plugin [health_metric_vis](https://github.com/DeanF/health_metric_vis)
 5 | 
 6 | <p align="center">
 7 | <img src="https://rawgit.com/clamarque/kibana_health_metric_vis/master/assets/images/demo.gif" alt="demo">
 8 | </p>
 9 | 
10 | ## Quick Start
11 | 
12 | You can install this plugin in Kibana 4/5/6 by doing the following instructions:
13 | 
14 | Note: Every release package includes a Plugin version (X.Y.Z) and a Kibana version (A.B.C).
15 | 
16 | ### Simple installation
17 | 
18 | For kibana 5/6:
19 | 
20 | `$KIBANA_HOME/bin/kibana-plugin install https://github.com/clamarque/kibana_health_metric_vis/releases/download/vX.Y/kibana_health_metric_vis-A.B.C.zip `
21 | 
22 | Note: You can also look in [releases](https://github.com/clamarque/kibana_health_metric_vis/releases) for another version than this one!
23 | 
24 | For kibana 4:
25 | 
26 | `$KIBANA_HOME/bin/kibana plugin --install health-metric-vis -u https://github.com/clamarque/kibana_health_metric_vis/releases/download/v4.2/kibana_health_metric_vis-4.2.zip`
27 | 
28 | ### Offline
29 | 
30 | For kibana 5/6:
31 | 
32 | * Download the plugin [here](https://github.com/clamarque/kibana_health_metric_vis/releases)
33 | * `$KIBANA_HOME/bin/kibana-plugin install file:///$HOME_DIRECTORY/kibana_health_metric_vis-A.B.C.zip`
34 | 
35 | 
36 | For kibana 4:
37 | 
38 | * Download the plugin [here](https://github.com/clamarque/kibana_health_metric_vis/releases/download/v4.2/kibana_health_metric_vis-4.2.zip)
39 | * `$KIBANA_HOME/bin/kibana plugin --install health-metric-vis -u file:///$HOME_DIRECTORY/kibana_health_metric_vis-4.2.zip`
40 | 
41 | You can find the command for Windows [here](https://github.com/clamarque/Kibana_health_metric_vis/wiki#install-plugin-with-windows)
42 | 
43 | **Warning:** If you download or clone the directory directly, the installation will not work. In fact since kibana 5, it is necessary to put all the files under a folder empty called kibana (This does not apply to version 4).
44 | 
45 | ## How to use
46 | 
47 | Click on the button **'Visualize'** and create a new visualization to select **'Health Metric'**
48 | 
49 | > In options, you can change the colors you want with hexadecimal color code **(#FFFFFF)** or by the color name **(white)**. If you change the color indicating the name of the color, the color indicator **will not update** and display **the black color by default**.
50 | 
51 | You can also specify a maximum threshold **(critical)** that is not exceeded but also an alert threshold **(warning)**. The color will be modified according to the state of health of the metric.
52 | 
53 | [See more details, the conception of plugin](https://github.com/clamarque/Kibana_health_metric_vis/wiki)
54 | 
55 | ## Update 
56 | 
57 | If the version doesn't match yours, you can create a issue with the needed version.
58 | 
59 | ## Others plugins
60 | 
61 | You can see others plugins listed by Elastic [here](https://www.elastic.co/guide/en/kibana/current/known-plugins.html)
62 | 
63 | ## Author
64 | 
65 | clamarque
66 | 


--------------------------------------------------------------------------------
/public/health_metric_vis.js:
--------------------------------------------------------------------------------
 1 | import './index.less';
 2 | import mainTemplate from './health_metric_vis_params.html';
 3 | import { VisFactoryProvider } from 'ui/vis/vis_factory';
 4 | import { Schemas } from 'ui/vis/editors/default/schemas';
 5 | import { VisTypesRegistryProvider } from 'ui/registry/vis_types';
 6 | import { vislibColorMaps } from 'ui/vislib/components/color/colormaps';
 7 | import { HealthMetricVisComponent } from './health_metric_vis_controller';
 8 | // we need to load the css ourselves
 9 | 
10 | // we also need to load the controller and used by the template
11 | 
12 | // register the provider with the visTypes registry 
13 | VisTypesRegistryProvider.register(HealthMetricVisProvider);
14 | 
15 | function HealthMetricVisProvider(Private, i18n) {
16 |   const VisFactory = Private(VisFactoryProvider);
17 | 
18 |   // return the visType object, which kibana will use to display and configure new
19 |   // Vis object of this type.
20 | 
21 |   return VisFactory.createReactVisualization({
22 |     name: 'health-metric',
23 |     title: i18n('metricVis.metricTitle', { defaultMessage: 'health-metric' }),
24 |     icon: 'visMetric',
25 |     description: i18n('metricVis.metricDescription', { defaultMessage: 'Displays a metric with a color according to the planned state of health'}),
26 |     visConfig: {
27 |       component: HealthMetricVisComponent,
28 |       defaults: {
29 |         addTooltip: true,
30 |         addLegend: false,
31 |         type: 'metric',
32 |         metric: {
33 |           percentageMode: false,
34 |           colorsRange: [
35 |             { from: 0, to: 10000 }
36 |           ],
37 |           labels: {
38 |             show: true
39 |           },
40 |           style: {
41 |             fontSize: 60,
42 |             fontColor: 'black',
43 |             invertScale: false,
44 |             redThreshold: 0,
45 |             yellowThreshold: 0,
46 |             redColor: "#fd482f",
47 |             yellowColor: "#ffa500",
48 |             greenColor: "#6dc066"
49 |           }
50 |         }
51 |       }
52 |     },
53 |     editorConfig: {
54 |       collections: {
55 |         metricColorMode: [
56 |           {
57 |             id: 'None',
58 |             label: i18n('metricVis.colorModes.noneOptionLabel', { defaultMessage: 'None' })
59 |           },
60 |           {
61 |             id: 'Labels',
62 |             label: i18n('metricVis.colorModes.labelsOptionLabel', { defaultMessage: 'Labels' })
63 |           },
64 |           {
65 |             id: 'Background',
66 |             label: i18n('metricVis.colorModes.backgroundOptionLabel', { defaultMessage: 'Background' })
67 |           }
68 |         ],
69 |         colorSchemas: Object.keys(vislibColorMaps).map(value => ({ id: value.id, label: value.label })),
70 |       },
71 |       optionsTemplate: mainTemplate,
72 |       schemas: new Schemas([
73 |         {
74 |           group: 'metrics',
75 |           name: 'metric',
76 |           title: i18n('metricVis.schemas.metricTitle', { defaultMessage: 'Metric' }),
77 |           min: 1,
78 |           aggFilter: [
79 |             '!std_dev', '!geo_centroid',
80 |             '!derivative', '!serial_diff', '!moving_avg', '!cumulative_sum', '!geo_bounds'],
81 |           defaults: [
82 |             { type: 'count', schema: 'metric' }
83 |           ]
84 |         }, {
85 |           group: 'buckets',
86 |           name: 'group',
87 |           title: i18n('metricVis.schemas.splitGroupTitle', { defaultMessage: 'Split Group' }),
88 |           min: 0,
89 |           max: 1,
90 |           aggFilter: ['!geohash_grid', '!filter']
91 |         }
92 |       ])
93 |     }
94 |   });
95 | }
96 | 
97 | export default HealthMetricVisProvider;
98 | 


--------------------------------------------------------------------------------
/public/health_metric_vis_controller.js:
--------------------------------------------------------------------------------
  1 | import _ from 'lodash';
  2 | import React, { Component } from 'react';
  3 | 
  4 | export class HealthMetricVisComponent extends Component {
  5 | 
  6 |   _setColor(val, visParams) {
  7 |     const isPercentageMode = visParams.percentageMode;
  8 |     const min = visParams.colorsRange[0].from;
  9 |     const max = _.last(visParams.colorsRange).to;  
 10 | 
 11 |     if (isPercentageMode) {
 12 |       const percentage = Math.round(100 * (val - min) / (max - min));
 13 |       val = percentage;
 14 |     } else {
 15 |       val = val;
 16 |     }
 17 | 
 18 |     if (!visParams.style.invertScale) {
 19 |       if (val <= visParams.style.redThreshold) {
 20 |         return visParams.style.redColor;
 21 |       } else if (val <= visParams.style.yellowThreshold && val > visParams.style.redThreshold) {
 22 |         return visParams.style.yellowColor;
 23 |       } else {
 24 |         return visParams.style.greenColor;
 25 |       }
 26 |     } else {
 27 |       if (val >= visParams.style.redThreshold) {
 28 |         return visParams.style.redColor;
 29 |       } else if (val >= visParams.style.yellowThreshold && val < visParams.style.redThreshold) {
 30 |         return visParams.style.yellowColor;
 31 |       } else {
 32 |         return visParams.style.greenColor;
 33 |       }
 34 |     }
 35 |   }
 36 | 
 37 |   _getFormattedValue(fieldFormatter, value) {
 38 |     if (_.isNaN(value)) return '-';
 39 |     return fieldFormatter(value);
 40 |   }
 41 | 
 42 |   _processTableGroups(table) {
 43 |     const config = this.props.vis.params.metric;
 44 |     const isPercentageMode = config.percentageMode;  
 45 |     const min = config.colorsRange[0].from;
 46 |     const max = _.last(config.colorsRange).to;
 47 |     const metrics = [];
 48 | 
 49 |     let bucketAgg;
 50 |     let bucketColumnId;
 51 |     let rowHeaderIndex;
 52 | 
 53 |     table.columns.forEach((column, columnIndex) => {
 54 |       const aggConfig = column.aggConfig;
 55 | 
 56 |       if (aggConfig && aggConfig.type.type === 'buckets') {
 57 |         bucketAgg = aggConfig;
 58 |         // Store the current index, so we later know in which position in the
 59 |         // row array, the bucket agg key will be, so we can create filters on it.
 60 |         rowHeaderIndex = columnIndex;
 61 |         bucketColumnId = column.id;
 62 |         return;
 63 |       }
 64 | 
 65 |       table.rows.forEach((row, rowIndex) => {
 66 |         let title = column.name;
 67 |         let value = row[column.id];
 68 |         const updateColor = this._setColor(value, config);
 69 | 
 70 |         if (isPercentageMode) {
 71 |           const percentage = Math.round(100 * (value - min) / (max - min));
 72 |           value = `${percentage}%`;
 73 |         }
 74 | 
 75 |         if (aggConfig) {
 76 |           if (!isPercentageMode) value = this._getFormattedValue(aggConfig.fieldFormatter('html'), value);
 77 |           if (bucketAgg) {
 78 |             const bucketValue = bucketAgg.fieldFormatter('text')(row[bucketColumnId]);
 79 |             title = `${bucketValue} - ${aggConfig.makeLabel()}`;
 80 |           } else {
 81 |             title = aggConfig.makeLabel();
 82 |           }
 83 |         }
 84 | 
 85 |         metrics.push({
 86 |           label: title,
 87 |           value: value,
 88 |           colorThreshold: updateColor,
 89 |           rowIndex: rowIndex,
 90 |           columnIndex: rowHeaderIndex,
 91 |           bucketAgg: bucketAgg 
 92 |         });
 93 |       })
 94 |     })
 95 | 
 96 |     return metrics;
 97 |   }
 98 | 
 99 |   _renderMetric = (metric, index) => {
100 |     const metricValueStyle = {
101 |       fontSize: `${this.props.vis.params.metric.style.fontSize}pt`,
102 |       color: `${this.props.vis.params.metric.style.fontColor}`,
103 |     };
104 | 
105 |     return (
106 |       <div
107 |         className="mtrVis__container"
108 |         style={{ backgroundColor: metric.colorThreshold }}
109 |       >
110 |         <div
111 |           key={index}
112 |           className="mtrVis__container"
113 |           style={{ backgroundColor: metric.bgColor }}
114 |         >
115 |           <div
116 |             className="mtrVis__value"
117 |             style={metricValueStyle}
118 |             dangerouslySetInnerHTML={{ __html: metric.value }}
119 |           />
120 |           {this.props.vis.params.metric.labels.show &&
121 |             <div>{metric.label}</div>
122 |           }
123 |         </div>
124 |       </div>
125 |     );
126 |   };
127 | 
128 |   render() {
129 |     let metricsHtml;
130 |     if (this.props.visData) {
131 |       const metrics = this._processTableGroups(this.props.visData);
132 |       metricsHtml = metrics.map(this._renderMetric);
133 |     }
134 |     return (<div className="mtrVis">{metricsHtml}</div>);
135 |   }
136 | 
137 |   componentDidMount() {
138 |     this.props.renderComplete();
139 |   }
140 | 
141 |   componentDidUpdate() {
142 |     this.props.renderComplete();
143 |   }
144 | }
145 | 


--------------------------------------------------------------------------------
/public/health_metric_vis_params.html:
--------------------------------------------------------------------------------
  1 | <div class="kuiSideBarSection">
  2 |   <!-- Percentage Mode -->
  3 |   <div class="kuiSideBarFormRow">
  4 |     <label
  5 |       class="kuiSideBarFormRow__label"
  6 |       for="percentageMode"
  7 |       i18n-id="metricVis.params.percentageModeLabel"
  8 |       i18n-default-message="Percentage Mode"
  9 |     >
 10 |     </label>
 11 |     <div class="kuiSideBarFormRow__control">
 12 |       <input
 13 |         class="kuiCheckBox"
 14 |         id="percentageMode"
 15 |         type="checkbox"
 16 |         ng-model="editorState.params.metric.percentageMode"
 17 |       />
 18 |     </div>
 19 |   </div>
 20 |   <!-- show Labels -->
 21 |   <div class="kuiSideBarFormRow">
 22 |     <label
 23 |       class="kuiSideBarFormRow__label"
 24 |       for="showLabels"
 25 |       i18n-id="metricVis.params.showLabelsLabel"
 26 |       i18n-default-message="Show Labels"
 27 |     >
 28 |     </label>
 29 |     <div class="kuiSideBarFormRow__control">
 30 |       <input
 31 |         class="kuiCheckBox"
 32 |         id="showLabels"
 33 |         type="checkbox"
 34 |         ng-model="editorState.params.metric.labels.show"
 35 |       />
 36 |     </div>
 37 |   </div>
 38 | 
 39 |   <!-- Style -->
 40 |   <div>
 41 |     <div class="kuiSideBarCollapsibleTitle">
 42 |       <div
 43 |         kbn-accessible-click
 44 |         aria-expanded="{{ !!showStyle }}"
 45 |         aria-controls="metricOptionsStyle"
 46 |         aria-label="{{::'metricVis.params.style.toggleOptionsAriaLabel' | i18n: { defaultMessage: 'Toggle style options' } }}"
 47 |         class="kuiSideBarCollapsibleTitle__label"
 48 |         ng-click="showStyle = !showStyle"
 49 |       >
 50 |         <span
 51 |           aria-hidden="true"
 52 |           ng-class="{
 53 |             'fa-caret-down': showStyle,
 54 |             'fa-caret-right': !showStyle
 55 |             }"
 56 |           class="fa fa-caret-right kuiSideBarCollapsibleTitle__caret"
 57 |         ></span>
 58 |         <span
 59 |           class="kuiSideBarCollapsibleTitle__text"
 60 |           i18n-id="metricVis.params.style.styleTitle"
 61 |           i18n-default-message="Style"
 62 |         >
 63 |         </span>
 64 |       </div>
 65 |     </div>
 66 |     <div
 67 |       id="metricOptionsStyle"
 68 |       ng-if="showStyle"
 69 |       class="kuiSideBarCollapsibleSection"
 70 |     >
 71 |       <div class="kuiSideBarSection">
 72 |         <!-- font Size -->
 73 |         <div class="kuiSideBarFormRow">
 74 |           <label class="kuiSideBarFormRow__label" for="metricFontSize">
 75 |             <span
 76 |               i18n-id="metricVis.params.style.fontSizeLabel"
 77 |               i18n-default-message="Font Size ({fontSize}pt)"
 78 |               i18n-values="{ fontSize: editorState.params.metric.style.fontSize }"
 79 |             >
 80 |             </span>
 81 |           </label>
 82 |           <div class="kuiSideBarFormRow__control">
 83 |             <input
 84 |               id="metricFontSize"
 85 |               type="range"
 86 |               ng-model="editorState.params.metric.style.fontSize"
 87 |               class="form-control"
 88 |               min="12"
 89 |               max="120"
 90 |             />
 91 |           </div>
 92 |         </div>
 93 |         <!-- font Color -->
 94 |         <div class="kuiSideBarFormRow">
 95 |           <label class="kuiSideBarFormRow__label" for="metricFontColor">
 96 |             <span
 97 |               i18n-id="metricVis.params.style.fontSizeLabel"
 98 |               i18n-default-message="Font Color"
 99 |             >
100 |             </span>
101 |           </label>
102 |           <div class="kuiSideBarFormRow__control">
103 |             <input
104 |               type="color"
105 |               ng-model="editorState.params.metric.style.fontColor"
106 |               class="form-control view-color"
107 |               disabled="disabled"
108 |             />
109 |             <input
110 |               id="metricFontColor"
111 |               type="text"
112 |               ng-model="editorState.params.metric.style.fontColor"
113 |               class="form-control"
114 |             />
115 |           </div>
116 |         </div>
117 |         <!-- RED Threshold -->
118 |         <div class="kuiSideBarFormRow">
119 |           <label
120 |             class="kuiSideBarFormRow__label threshold"
121 |             for="metricCriticalThreshold"
122 |           >
123 |             <span
124 |               i18n-id="metricVis.params.style.fontSizeLabel"
125 |               i18n-default-message="Critical Threshold"
126 |             >
127 |             </span>
128 |             <span
129 |               class="threshold__info"
130 |               ng-bind-template="(equal to or {{
131 |                 !editorState.params.metric.style.invertScale ? 'below' : 'above'
132 |               }} this value, the state will be critical)"
133 |             ></span>
134 |           </label>
135 |           <div class="kuiSideBarFormRow__control">
136 |             <input
137 |               id="metricCriticalThreshold"
138 |               type="number"
139 |               ng-model="editorState.params.metric.style.redThreshold"
140 |               class="form-control threshold__number"
141 |             />
142 |           </div>
143 |         </div>
144 |         <!-- WARNING Threshold -->
145 |         <div class="kuiSideBarFormRow">
146 |           <label
147 |             class="kuiSideBarFormRow__label threshold"
148 |             for="metricWarningThreshold"
149 |           >
150 |             <span
151 |               i18n-id="metricVis.params.style.fontSizeLabel"
152 |               i18n-default-message="Warning Threshold"
153 |             >
154 |             </span>
155 |             <span
156 |               class="threshold__info"
157 |               ng-bind-template="(equal to or {{
158 |                 !editorState.params.metric.style.invertScale ? 'below' : 'above'
159 |               }} this value, the state will be on alert)"
160 |             ></span>
161 |           </label>
162 |           <div class="kuiSideBarFormRow__control">
163 |             <input
164 |               id="metricWarningThreshold"
165 |               type="number"
166 |               ng-model="editorState.params.metric.style.yellowThreshold"
167 |               class="form-control threshold__number"
168 |             />
169 |           </div>
170 |         </div>
171 |         <div class="kuiSideBarFormRow">
172 |           <input
173 |             type="checkbox"
174 |             ng-model="editorState.params.metric.style.invertScale"
175 |           />
176 |           Invert Scale
177 |         </div>
178 |         <!-- Default color -->
179 |         <div class="kuiSideBarFormRow">
180 |           <label class="kuiSideBarFormRow__label" for="metricDefaultColor">
181 |             <span
182 |               i18n-id="metricVis.params.style.fontSizeLabel"
183 |               i18n-default-message="Default Color"
184 |             >
185 |             </span>
186 |           </label>
187 |           <div class="kuiSideBarFormRow__control">
188 |             <input
189 |               type="color"
190 |               ng-model="editorState.params.metric.style.greenColor"
191 |               class="form-control view-color"
192 |               disabled="disabled"
193 |             />
194 |             <input
195 |               id="metricDefaultColor"
196 |               type="text"
197 |               ng-model="editorState.params.metric.style.greenColor"
198 |               class="form-control"
199 |             />
200 |           </div>
201 |         </div>
202 |         <!-- Critical color -->
203 |         <div class="kuiSideBarFormRow">
204 |           <label class="kuiSideBarFormRow__label" for="metricCriticalColor">
205 |             <span
206 |               i18n-id="metricVis.params.style.fontSizeLabel"
207 |               i18n-default-message="Critical Color"
208 |             >
209 |             </span>
210 |           </label>
211 |           <div class="kuiSideBarFormRow__control">
212 |             <input
213 |               type="color"
214 |               ng-model="editorState.params.metric.style.redColor"
215 |               class="form-control view-color"
216 |               disabled="disabled"
217 |             />
218 |             <input
219 |               id="metricCriticalColor"
220 |               type="text"
221 |               ng-model="editorState.params.metric.style.redColor"
222 |               class="form-control"
223 |             />
224 |           </div>
225 |         </div>
226 |         <!-- Warning color -->
227 |         <div class="kuiSideBarFormRow">
228 |           <label class="kuiSideBarFormRow__label" for="metricWarningColor">
229 |             <span
230 |               i18n-id="metricVis.params.style.fontSizeLabel"
231 |               i18n-default-message="Warning Color"
232 |             >
233 |             </span>
234 |           </label>
235 |           <div class="kuiSideBarFormRow__control">
236 |             <input
237 |               type="color"
238 |               ng-model="editorState.params.metric.style.yellowColor"
239 |               class="form-control view-color"
240 |               disabled="disabled"
241 |             />
242 |             <input
243 |               id="metricWarningColor"
244 |               type="text"
245 |               ng-model="editorState.params.metric.style.yellowColor"
246 |               class="form-control"
247 |             />
248 |           </div>
249 |         </div>
250 |       </div>
251 |     </div>
252 |   </div>
253 | </div>
254 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright © 2016 clamarque
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------