From 5b5beccfddcbf96daa4d818ae389e08e42d420e7 Mon Sep 17 00:00:00 2001 From: Thomas Charlot Date: Wed, 14 Feb 2018 18:51:05 +0100 Subject: [PATCH] Fix documentation. --- README.md | 8 +++---- docs/functions/basics.md | 48 ++++++++++++++++++++++++++++++++++++++++ docs/functions/filter.md | 2 +- docs/functions/next.md | 2 +- docs/functions/prev.md | 2 +- docs/index.md | 9 +++++--- docs/installation.md | 2 +- mkdocs.yml | 1 + 8 files changed, 63 insertions(+), 11 deletions(-) create mode 100644 docs/functions/basics.md diff --git a/README.md b/README.md index 1aa8b13..5d720b6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![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 workds on any standard Kibana vizualisation. Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula.html) +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 vizualisation. Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula/) # Example : simple ratio calculation @@ -12,17 +12,17 @@ We are Datasweet, a french startup providing full service (big) data solutions. # Installation This plugin is supported by : - Kibana 6.x - - Kibana >= 5.5 + - Kibana 5.6 Copy the last installation url for your version of Kibana from the [repository releases](https://github.com/datasweet-fr/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.html) +Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula/) # Questions ? problems ? suggestions ? -If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new). +If you find a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new). # Credits Datasweet Formula is built on [Javascript Expression Evaluator](https://silentmatt.com/javascript-expression-evaluator/) by Silent Matt. diff --git a/docs/functions/basics.md b/docs/functions/basics.md new file mode 100644 index 0000000..35fce2d --- /dev/null +++ b/docs/functions/basics.md @@ -0,0 +1,48 @@ +# Basics + +## Arithmetic operators + +* + +* - +* * +* / +* % +* ^ + +## Logical operators + +* and +* or +* not + +## Comparaison operators + +* < less than +* <= less than equal +* == equal +* != not equal +* > greater than +* >= greater than equal + +## Basics maths functions + +* abs +* acos +* acosh +* asin +* asinh +* atan +* atanh +* ceil +* cos +* cosh +* exp +* floor +* log (alias ln) +* log10 (alias lg) +* round +* sinh +* sqrt +* tan +* tanh +* trunc \ No newline at end of file diff --git a/docs/functions/filter.md b/docs/functions/filter.md index 43b50ce..df6fb06 100644 --- a/docs/functions/filter.md +++ b/docs/functions/filter.md @@ -1,6 +1,6 @@ # Function filter -Returns a null value for a filter value. +Filter out values matching the condition in the serie, by returning a null value. ## Syntax ``` diff --git a/docs/functions/next.md b/docs/functions/next.md index 6b9b5c1..da7354a 100644 --- a/docs/functions/next.md +++ b/docs/functions/next.md @@ -1,6 +1,6 @@ # Function next -Shift to right a serie. +Shift a serie to right. ## Syntax ``` diff --git a/docs/functions/prev.md b/docs/functions/prev.md index 68eee2d..8b6f632 100644 --- a/docs/functions/prev.md +++ b/docs/functions/prev.md @@ -1,6 +1,6 @@ # Function prev -Shift to left a serie. +Shift a serie to left. ## Syntax ``` diff --git a/docs/index.md b/docs/index.md index 5ee0073..a09f783 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Datasweet Formula -Datasweet Formula makes it possible to calculate a metric in real time, based on any existing metrics, in a Kibana standard vizualisation. It thus allows to create pretty much any calculation, from simple ratios to more complex, chained treatments. +Datasweet Formula makes it possible to calculate a metric in real time, based on any existing metrics, in a Kibana standard vizualisation. It allows to create pretty much any calculation, from simple ratios to more complex, chained treatments. ![tutorial-datasweet-formula](img/tutorial-datasweet-formula.gif) @@ -8,12 +8,15 @@ Datasweet Formula makes it possible to calculate a metric in real time, based on Select the metrics you need as input to your formula, then : * Add new metric > select _Datasweet Formula_ -* Type your formula in the input textbox as follow : `aggX + aggY`, where X and Y are the #id attributed by Kibana to the metric you want as inputs. +* Type your formula in the input textbox as follow : `aggX + aggY`, where X and Y are the #id attributed by Kibana to the metric you want as input. +* You can apply functions to your calculation : `avg(aggX + aggY)` +* Functions are chainables : `floor(avg(aggX + aggY))` +* You can use a previously set formula as input for a new one. ## Credits Datasweet Formula is built on [Javascript Expression Evaluator](https://silentmatt.com/javascript-expression-evaluator/) by Silent Matt. ## Questions ? problems ? suggestions ? -If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new). +If you find a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new). diff --git a/docs/installation.md b/docs/installation.md index 5459f09..abdd36e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -8,4 +8,4 @@ Copy the last installation url for your version of Kibana from the [repository r This plugin is supported by : * Kibana 6.x -* Kibana >= 5.5 \ No newline at end of file +* Kibana >= 5.6 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 54051a0..12a0fda 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,6 +20,7 @@ pages: - About: about.md - Installation: installation.md - Functions List: + - functions/basics.md - functions/avg.md - functions/count.md - functions/cusum.md