Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/datasweet/kibana-datasweet-formula

This Kibana plugin allows calculated metrics on any standard kibana visualizations.
https://github.com/datasweet/kibana-datasweet-formula

Last synced: 6 days ago
JSON representation

This Kibana plugin allows calculated metrics on any standard kibana visualizations.

Host: GitHub
URL: https://github.com/datasweet/kibana-datasweet-formula
Owner: datasweet
License: apache-2.0
Created: 2018-02-05T14:13:32.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2022-12-15T01:11:35.000Z (almost 2 years ago)
Last Synced: 2024-05-18T22:22:41.105Z (6 months ago)
Language: JavaScript
Size: 11.8 MB
Stars: 123
Watchers: 15
Forks: 35
Open Issues: 24
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Datasweet Formula : a real time calculated metric plugin
[![GitHub stars](https://img.shields.io/github/stars/datasweet/kibana-datasweet-formula.svg)](https://github.com/datasweet/kibana-datasweet-formula/stargazers)
[![GitHub license](https://img.shields.io/github/license/datasweet/kibana-datasweet-formula.svg)](https://github.com/datasweet/kibana-datasweet-formula/blob/master/LICENSE)

[![datasweet-logo](docs/img/datasweet.png)](http://www.datasweet.fr)

Hi all !
We are Datasweet, a french startup providing full service (big) data solutions. We tweaked Kibana to fit our needs. We are happy to release Datasweet Formula, a real time calculated metric plugin, that works on any standard Kibana visualization. Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula/)

# Example : simple ratio calculation

![tutorial-datasweet-formula](docs/img/tutorial-datasweet-formula.gif)

# Installation
This plugin is supported by :
- Kibana 7.0.x => v2.2.0
- Kibana 6.5.x to 6.7.x => v2.1.0
- Kibana 6.4.x => v2.0.0
- Kibana 5.6.x to 6.3.x => v1.1.3

Copy the last installation url for your version of Kibana from the [repository releases](https://github.com/datasweet/kibana-datasweet-formula/releases/latest).
```
./bin/kibana-plugin install https://github.com/datasweet-fr/kibana-datasweet-formula/releases/download/version_name/datasweet_formula-X.X.X_kibana-major.minor.patch.zip
```

# Features
Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula/)

# Development

See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. Once you have completed that, use the following yarn scripts.

> ***IMPORTANT:*** You must have the following tree :
- kibana/
- kibana-extra/
- kibana-datasweet-formula/

```bash
cd kibana
git checkout v7.x
rm -Rf node_modules/
nvm use
yarn kbn bootstrap
docker run -p 9200:9200 docker.elastic.co/elasticsearch/elasticsearch:7.x
node scripts/makelogs.js
cd ../kibana-extra/kibana-datasweet-formula/
rm -Rf node_modules/
yarn kbn bootstrap
yarn start
```

- `yarn start`

Start kibana and have it include this plugin. You can pass any arguments that you would normally send to `bin/kibana`

```
yarn start --elasticsearch.url http://localhost:9220
```

- `yarn build`

Build a distributable archive of your plugin.

- `yarn test:browser`

Run the browser tests in a real web browser.

- `yarn test:server`

Run the server tests using mocha.

For more information about any of these commands run `yarn ${task} --help`. For a full list of tasks checkout the `package.json` file, or run `yarn run`.

# Questions ? problems ? suggestions ?
If you find a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet/kibana-datasweet-formula/issues/new).

# Credits
Datasweet Formula is built on [Javascript Expression Evaluator](https://silentmatt.com/javascript-expression-evaluator/) by Silent Matt.

# Contributors

_{Gustavo Matheus}

_itamarm10

_joeyJsonar

# License
```
This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
```