[elastic] update readme with info on modifying dashboard
[scripts.git] / elastic / README.md
1 # Kibana Soledad Benchmark Dashboard
2
3 ## Generate visualisations from template
4
5     ./generate-config.py
6
7 ## Upload configs
8
9 Provide kibana admin credentials in your `~/.netrc` file.
10 Then upload dashboard configs:
11
12     ./load.sh -l https://moose.leap.se:9200
13
14 ## Browse Dashboard
15
16     https://moose.leap.se/app/kibana#/dashboard/soledad-benchmark
17
18 ## Changing the Dashboard
19
20 Currently, the dashboard is generated from a series of template files that can
21 be found in the `templates/` directory. Each graph is a "visualization" which
22 is create from a search and different visualization states. Many graphs are
23 combined in a "dashboard".
24
25 In order to have a new graph in dashboard, you need to:
26
27 * maybe create a new search.
28 * create a new visualization.
29 * add the new visualization to the dashboard.
30
31 The way we have been doing is to first create temporary searches,
32 visualizations and dashboards by hand in kibana, and then export them and use
33 the exported data as a basis to modify the templates in this repository. To
34 export these objects, go to the main kibana page, and then click Management ->
35 Saved Objects -> Select the appropriate object -> Export.
36
37 If you add or modify fields you might also have to update the index pattern. To
38 export the index pattern, do the following:
39
40     curl --netrc -X GET https://moose.leap.se:9200/.kibana/dashboard#/benchmark*