diff --git a/src/main/webapp/WEB-INF/kibana/README.md b/src/main/webapp/WEB-INF/kibana/README.md new file mode 100644 index 000000000..b3ab8d31e --- /dev/null +++ b/src/main/webapp/WEB-INF/kibana/README.md @@ -0,0 +1,19 @@ +kibana4 settings for fess +===== + +Providing kibana settings file for monitoring search logs of fess. + +## Install + +1. Install and launch fess. +1. Install and launch kibana4. +1. Open kibana home [http://localhost:5601/](http://localhost:5601/). +1. Input "fess_log" to the textbox of Index name or pattern. +1. Set "requestedAt" to the Time-field name. +1. From the top of page, click *Settings*. +1. Click *Objects*. +1. Click *Import* and select 'fess_log.json' to import settings. +1. Click *Dashboard*. +1. Click *Load Saved Dashboard* and select 'fess_log' dashboard. +1. (Change the period from upper right if you want to do.) + diff --git a/src/main/webapp/WEB-INF/kibana/fess_log.json b/src/main/webapp/WEB-INF/kibana/fess_log.json new file mode 100644 index 000000000..e9bd38679 --- /dev/null +++ b/src/main/webapp/WEB-INF/kibana/fess_log.json @@ -0,0 +1,103 @@ +[ + { + "_id": "fess_log", + "_type": "dashboard", + "_source": { + "title": "fess_log", + "hits": 0, + "description": "", + "panelsJSON": "[{\"col\":11,\"id\":\"search-term-rank-of-no-results\",\"panelIndex\":1,\"row\":1,\"size_x\":2,\"size_y\":6,\"type\":\"visualization\"},{\"col\":5,\"id\":\"rank-of-UserAgent\",\"panelIndex\":2,\"row\":7,\"size_x\":8,\"size_y\":4,\"type\":\"visualization\"},{\"col\":1,\"id\":\"average-response-time\",\"panelIndex\":3,\"row\":4,\"size_x\":8,\"size_y\":3,\"type\":\"visualization\"},{\"col\":9,\"id\":\"search-term-rank\",\"panelIndex\":4,\"row\":1,\"size_x\":2,\"size_y\":6,\"type\":\"visualization\"},{\"col\":1,\"id\":\"search-query-counts/sec.\",\"panelIndex\":5,\"row\":1,\"size_x\":8,\"size_y\":3,\"type\":\"visualization\"},{\"col\":1,\"id\":\"hit-counts\",\"panelIndex\":6,\"row\":7,\"size_x\":4,\"size_y\":4,\"type\":\"visualization\"}]", + "optionsJSON": "{\"darkTheme\":false}", + "uiStateJSON": "{\"P-1\":{\"spy\":{\"mode\":{\"fill\":false,\"name\":null}}},\"P-2\":{\"spy\":{\"mode\":{\"fill\":false,\"name\":null}}}}", + "version": 1, + "timeRestore": false, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"filter\":[{\"query\":{\"query_string\":{\"analyze_wildcard\":true,\"query\":\"*\"}}}]}" + } + } + }, + { + "_id": "average-response-time", + "_type": "visualization", + "_source": { + "title": "average response time", + "visState": "{\n \"type\": \"line\",\n \"params\": {\n \"addLegend\": false,\n \"addTimeMarker\": false,\n \"addTooltip\": true,\n \"defaultYExtents\": false,\n \"drawLinesBetweenPoints\": true,\n \"interpolate\": \"linear\",\n \"radiusRatio\": 9,\n \"scale\": \"linear\",\n \"setYExtents\": false,\n \"shareYAxis\": true,\n \"showCircles\": true,\n \"smoothLines\": false,\n \"times\": [],\n \"yAxis\": {}\n },\n \"aggs\": [\n {\n \"id\": \"1\",\n \"type\": \"avg\",\n \"schema\": \"metric\",\n \"params\": {\n \"field\": \"responseTime\"\n }\n },\n {\n \"id\": \"2\",\n \"type\": \"date_histogram\",\n \"schema\": \"segment\",\n \"params\": {\n \"field\": \"requestedAt\",\n \"interval\": \"h\",\n \"customInterval\": \"2h\",\n \"min_doc_count\": 1,\n \"extended_bounds\": {}\n }\n }\n ],\n \"listeners\": {}\n}", + "uiStateJSON": "{}", + "description": "", + "version": 1, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\n \"index\": \"fess_log\",\n \"query\": {\n \"query_string\": {\n \"query\": \"_type: \\\"search_log\\\"\",\n \"analyze_wildcard\": true\n }\n },\n \"filter\": []\n}" + } + } + }, + { + "_id": "rank-of-UserAgent", + "_type": "visualization", + "_source": { + "title": "rank of UserAgent", + "visState": "{\n \"type\": \"table\",\n \"params\": {\n \"perPage\": 10,\n \"showPartialRows\": false,\n \"showMeticsAtAllLevels\": false\n },\n \"aggs\": [\n {\n \"id\": \"1\",\n \"type\": \"count\",\n \"schema\": \"metric\",\n \"params\": {}\n },\n {\n \"id\": \"2\",\n \"type\": \"terms\",\n \"schema\": \"bucket\",\n \"params\": {\n \"field\": \"userAgent\",\n \"size\": 5,\n \"order\": \"desc\",\n \"orderBy\": \"1\"\n }\n }\n ],\n \"listeners\": {}\n}", + "uiStateJSON": "{}", + "description": "", + "version": 1, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\n \"index\": \"fess_log\",\n \"query\": {\n \"query_string\": {\n \"query\": \"_type: \\\"search_log\\\"\",\n \"analyze_wildcard\": true\n }\n },\n \"filter\": []\n}" + } + } + }, + { + "_id": "search-term-rank", + "_type": "visualization", + "_source": { + "title": "search term rank", + "visState": "{\n \"type\": \"table\",\n \"params\": {\n \"perPage\": 20,\n \"showMeticsAtAllLevels\": false,\n \"showPartialRows\": false\n },\n \"aggs\": [\n {\n \"id\": \"1\",\n \"type\": \"count\",\n \"schema\": \"metric\",\n \"params\": {}\n },\n {\n \"id\": \"2\",\n \"type\": \"terms\",\n \"schema\": \"bucket\",\n \"params\": {\n \"field\": \"searchWord\",\n \"size\": 20,\n \"order\": \"desc\",\n \"orderBy\": \"1\"\n }\n }\n ],\n \"listeners\": {}\n}", + "uiStateJSON": "{}", + "description": "", + "version": 1, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\n \"index\": \"fess_log\",\n \"query\": {\n \"query_string\": {\n \"analyze_wildcard\": true,\n \"query\": \"_type: \\\"search_log\\\"\"\n }\n },\n \"filter\": []\n}" + } + } + }, + { + "_id": "search-term-rank-of-no-results", + "_type": "visualization", + "_source": { + "title": "search term rank of no results", + "visState": "{\n \"type\": \"table\",\n \"params\": {\n \"perPage\": 20,\n \"showPartialRows\": false,\n \"showMeticsAtAllLevels\": false\n },\n \"aggs\": [\n {\n \"id\": \"1\",\n \"type\": \"count\",\n \"schema\": \"metric\",\n \"params\": {}\n },\n {\n \"id\": \"2\",\n \"type\": \"terms\",\n \"schema\": \"bucket\",\n \"params\": {\n \"field\": \"searchWord\",\n \"size\": 20,\n \"order\": \"desc\",\n \"orderBy\": \"1\"\n }\n }\n ],\n \"listeners\": {}\n}", + "uiStateJSON": "{}", + "description": "", + "version": 1, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\n \"index\": \"fess_log\",\n \"query\": {\n \"query_string\": {\n \"query\": \"_type: \\\"search_log\\\" && hitCount: 0\",\n \"analyze_wildcard\": true\n }\n },\n \"filter\": []\n}" + } + } + }, + { + "_id": "hit-counts", + "_type": "visualization", + "_source": { + "title": "hit counts", + "visState": "{\n \"type\": \"histogram\",\n \"params\": {\n \"shareYAxis\": true,\n \"addTooltip\": true,\n \"addLegend\": false,\n \"scale\": \"linear\",\n \"mode\": \"stacked\",\n \"times\": [],\n \"addTimeMarker\": false,\n \"defaultYExtents\": false,\n \"setYExtents\": false,\n \"yAxis\": {}\n },\n \"aggs\": [\n {\n \"id\": \"1\",\n \"type\": \"sum\",\n \"schema\": \"metric\",\n \"params\": {\n \"field\": \"hitCount\"\n }\n },\n {\n \"id\": \"2\",\n \"type\": \"date_histogram\",\n \"schema\": \"segment\",\n \"params\": {\n \"field\": \"requestedAt\",\n \"interval\": \"h\",\n \"customInterval\": \"2h\",\n \"min_doc_count\": 1,\n \"extended_bounds\": {}\n }\n }\n ],\n \"listeners\": {}\n}", + "uiStateJSON": "{}", + "description": "", + "version": 1, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\n \"index\": \"fess_log\",\n \"query\": {\n \"query_string\": {\n \"query\": \"_type: \\\"search_log\\\"\",\n \"analyze_wildcard\": true\n }\n },\n \"filter\": []\n}" + } + } + }, + { + "_id": "search-query-counts/sec.", + "_type": "visualization", + "_source": { + "title": "search query counts / sec.", + "visState": "{\n \"type\": \"line\",\n \"params\": {\n \"addLegend\": false,\n \"addTimeMarker\": false,\n \"addTooltip\": true,\n \"defaultYExtents\": false,\n \"drawLinesBetweenPoints\": true,\n \"interpolate\": \"linear\",\n \"radiusRatio\": 9,\n \"scale\": \"linear\",\n \"setYExtents\": false,\n \"shareYAxis\": true,\n \"showCircles\": false,\n \"smoothLines\": false,\n \"times\": [],\n \"yAxis\": {}\n },\n \"aggs\": [\n {\n \"id\": \"1\",\n \"type\": \"count\",\n \"schema\": \"metric\",\n \"params\": {\n \"json\": \"\"\n }\n },\n {\n \"id\": \"2\",\n \"type\": \"date_histogram\",\n \"schema\": \"segment\",\n \"params\": {\n \"field\": \"requestedAt\",\n \"interval\": \"s\",\n \"customInterval\": \"10m\",\n \"min_doc_count\": 1,\n \"extended_bounds\": {}\n }\n }\n ],\n \"listeners\": {}\n}", + "uiStateJSON": "{}", + "description": "", + "version": 1, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\n \"index\": \"fess_log\",\n \"query\": {\n \"query_string\": {\n \"query\": \"_type: \\\"search_log\\\"\",\n \"analyze_wildcard\": true\n }\n },\n \"filter\": []\n}" + } + } + } +] \ No newline at end of file