{"_id":"5a062c84703c1d001cdd631f","project":"5633ebff7e9e880d00af1a53","version":{"_id":"5633ec007e9e880d00af1a56","project":"5633ebff7e9e880d00af1a53","__v":18,"createdAt":"2015-10-30T22:15:28.105Z","releaseDate":"2015-10-30T22:15:28.105Z","categories":["5633ec007e9e880d00af1a57","5633f072737ea01700ea329d","5637a37d0704070d00f06cf4","5637cf4e7ca5de0d00286aeb","564503082c74cf1900da48b4","564503cb7f1fff210078e70a","567af26cb56bac0d0019d87d","567afeb8802b2b17005ddea0","567aff47802b2b17005ddea1","567b0005802b2b17005ddea3","568adfffcbd4ca0d00aebf7e","56ba80078cf7c9210009673e","574d127f6f075519007da3d0","574fde60aef76a0e00840927","57a22ba6cd51b22d00f623a0","5a062c15a66ae1001a3f5b09","5b032aef01b0ff00038d8d5e","5b032af62d18d700038a7042"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"567b0005802b2b17005ddea3","pages":["567b001117368a0d009a6e10","567b00307c40060d005603e7","567b039a7c40060d005603ec"],"project":"5633ebff7e9e880d00af1a53","version":"5633ec007e9e880d00af1a56","__v":3,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-23T20:11:49.377Z","from_sync":false,"order":2,"slug":"best-practices","title":"Best Practices & Tools"},"user":"5633ec9b35355017003ca3f2","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-10T22:47:32.750Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"If you have a Bonsai cluster with Elasticsearch version 5.x or greater, you can get Kibana up and running from your cluster dashboard with just a few clicks. Follow the steps below to get a simple dashboard set up.\n\n## View Data in Kibana\n\n### 1. Navigate to your Bonsai dashboard\n\nClick on `Access Kibana`\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/847d977-logs.png\",\n        \"logs.png\",\n        2992,\n        1674,\n        \"#428195\"\n      ]\n    }\n  ]\n}\n[/block]\n### 2. Open your Kibana link\n\nOnce Kibana launches, navigate to the `Management` tab.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a88352a-Kibana.png\",\n        \"Kibana.png\",\n        2806,\n        1430,\n        \"#efefef\"\n      ]\n    }\n  ]\n}\n[/block]\nDynamic index pattern names, like the default one show above, `logstash-*`, is useful for indices of log and metric data.\n\n### 3. Configure Kibana: Select an index\n\nYou'll need to let Kibana know which index you want to explore. Type in your index pattern. If you need to, it may be helpful to run `_cat/indices` against your cluster:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"_cat/indices\\n\\ngreen open .kibana    WrCBl9V2QzOsRYjEEUunJQ 1 1    0 0    0kb    0kb\\ngreen open inetspeeds MdGwmJYjTTeb_PnTbfFPgw 1 1 9188 0  6.9mb  3.4mb\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nBy default, all Bonsai clusters come with an index called `.kibana` in which we keep all of the metadata necessary for Kibana to remember your dashboards and settings. This index is **not** counted towards your shard limit. For this doc example, we're going to configure our Kibana with the `inetspeeds` index, a small index we've created that contains logs of an office's internet speed.\n\n### 4. Configure Kibana: Select index fields\n\nJust like with the index name, we have to tell Kibana which fields we want to be searchable with queries, bucketed with aggregations, etc. Select the fields you want to explore.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9293b22-Screen_Shot_2018-02-27_at_12.27.40_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.27.40 PM.png\",\n        2560,\n        1316,\n        \"#eeefef\"\n      ]\n    }\n  ]\n}\n[/block]\n### 5. Discover your data!\n\nNavigate to the `Discover` tab to see Kibana's raw view of the data.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/63acb8a-Screen_Shot_2018-02-27_at_12.35.06_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.35.06 PM.png\",\n        2560,\n        1318,\n        \"#3499ba\"\n      ]\n    }\n  ]\n}\n[/block]\n#### Kibana No Results Found\n\nIf you see `No results found 😐`, don't freak out! You probably just need to adjust your time window in the upper right-hand corner to view the correct time slices where there exists data.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0f1eeb9-no_results_found.png\",\n        \"no results found.png\",\n        2806,\n        1430,\n        \"#e7ebeb\"\n      ]\n    }\n  ]\n}\n[/block]\n## Create a Kibana Component\n\nIn order to create a Kibana dashboard, you must first create the components that will comprise your dashboard view. To create a component, first navigate to the visualize tab.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3340146-Screen_Shot_2018-02-27_at_12.35.40_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.35.40 PM.png\",\n        2560,\n        1318,\n        \"#37abd2\"\n      ]\n    }\n  ]\n}\n[/block]\nClick `Create a visualization` & select your index.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/43dd039-Screen_Shot_2018-02-27_at_12.36.06_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.36.06 PM.png\",\n        2560,\n        1322,\n        \"#ededed\"\n      ]\n    }\n  ]\n}\n[/block]\nUse the settings in the left-hand column to create your x-axis and y-axis metrics, then define how you want to aggregate your data in the buckets section. Want to learn more about how the aggregations work? See more here:\n\n- https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-aggregations.html\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/77ff64d-Screen_Shot_2018-02-27_at_12.38.58_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.38.58 PM.png\",\n        2560,\n        1318,\n        \"#dec9d1\"\n      ]\n    }\n  ]\n}\n[/block]\nName your component and save it.\n\n## Create a Kibana Dashboard\n\nTo create a saved Kibana dashboard, you must first have some [visualization components](https://docs.bonsai.io/v1.0/docs/kibana#section-create-a-kibana-component) to build with. To get started, navigate to the `Dashboard` tab and click `Create a dashboard`.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/19b65a0-Screen_Shot_2018-02-27_at_12.39.40_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.39.40 PM.png\",\n        2560,\n        1318,\n        \"#36abd2\"\n      ]\n    }\n  ]\n}\n[/block]\nYou're now in the dashboard builder and can add existsing visualizations. Click `Add` to add a component.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b2f0c87-Screen_Shot_2018-02-27_at_12.39.48_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.39.48 PM.png\",\n        2560,\n        1318,\n        \"#34abd2\"\n      ]\n    }\n  ]\n}\n[/block]\nChoose the visualization you want, and click `Save`.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/63a23d8-Screen_Shot_2018-02-27_at_12.40.31_PM.png\",\n        \"Screen Shot 2018-02-27 at 12.40.31 PM.png\",\n        2560,\n        1316,\n        \"#36abd0\"\n      ]\n    }\n  ]\n}\n[/block]\nEt voilà! Now go build more components and enjoy your cool dashboard! Since your metadata is saved in your cluster's `.kibana` index, all of your settings will be saved for the next time you need to come back.","excerpt":"How to use our Kibana deployment.","slug":"kibana","type":"basic","title":"Kibana"}

Kibana

How to use our Kibana deployment.

If you have a Bonsai cluster with Elasticsearch version 5.x or greater, you can get Kibana up and running from your cluster dashboard with just a few clicks. Follow the steps below to get a simple dashboard set up. ## View Data in Kibana ### 1. Navigate to your Bonsai dashboard Click on `Access Kibana` [block:image] { "images": [ { "image": [ "https://files.readme.io/847d977-logs.png", "logs.png", 2992, 1674, "#428195" ] } ] } [/block] ### 2. Open your Kibana link Once Kibana launches, navigate to the `Management` tab. [block:image] { "images": [ { "image": [ "https://files.readme.io/a88352a-Kibana.png", "Kibana.png", 2806, 1430, "#efefef" ] } ] } [/block] Dynamic index pattern names, like the default one show above, `logstash-*`, is useful for indices of log and metric data. ### 3. Configure Kibana: Select an index You'll need to let Kibana know which index you want to explore. Type in your index pattern. If you need to, it may be helpful to run `_cat/indices` against your cluster: [block:code] { "codes": [ { "code": "_cat/indices\n\ngreen open .kibana WrCBl9V2QzOsRYjEEUunJQ 1 1 0 0 0kb 0kb\ngreen open inetspeeds MdGwmJYjTTeb_PnTbfFPgw 1 1 9188 0 6.9mb 3.4mb", "language": "text" } ] } [/block] By default, all Bonsai clusters come with an index called `.kibana` in which we keep all of the metadata necessary for Kibana to remember your dashboards and settings. This index is **not** counted towards your shard limit. For this doc example, we're going to configure our Kibana with the `inetspeeds` index, a small index we've created that contains logs of an office's internet speed. ### 4. Configure Kibana: Select index fields Just like with the index name, we have to tell Kibana which fields we want to be searchable with queries, bucketed with aggregations, etc. Select the fields you want to explore. [block:image] { "images": [ { "image": [ "https://files.readme.io/9293b22-Screen_Shot_2018-02-27_at_12.27.40_PM.png", "Screen Shot 2018-02-27 at 12.27.40 PM.png", 2560, 1316, "#eeefef" ] } ] } [/block] ### 5. Discover your data! Navigate to the `Discover` tab to see Kibana's raw view of the data. [block:image] { "images": [ { "image": [ "https://files.readme.io/63acb8a-Screen_Shot_2018-02-27_at_12.35.06_PM.png", "Screen Shot 2018-02-27 at 12.35.06 PM.png", 2560, 1318, "#3499ba" ] } ] } [/block] #### Kibana No Results Found If you see `No results found 😐`, don't freak out! You probably just need to adjust your time window in the upper right-hand corner to view the correct time slices where there exists data. [block:image] { "images": [ { "image": [ "https://files.readme.io/0f1eeb9-no_results_found.png", "no results found.png", 2806, 1430, "#e7ebeb" ] } ] } [/block] ## Create a Kibana Component In order to create a Kibana dashboard, you must first create the components that will comprise your dashboard view. To create a component, first navigate to the visualize tab. [block:image] { "images": [ { "image": [ "https://files.readme.io/3340146-Screen_Shot_2018-02-27_at_12.35.40_PM.png", "Screen Shot 2018-02-27 at 12.35.40 PM.png", 2560, 1318, "#37abd2" ] } ] } [/block] Click `Create a visualization` & select your index. [block:image] { "images": [ { "image": [ "https://files.readme.io/43dd039-Screen_Shot_2018-02-27_at_12.36.06_PM.png", "Screen Shot 2018-02-27 at 12.36.06 PM.png", 2560, 1322, "#ededed" ] } ] } [/block] Use the settings in the left-hand column to create your x-axis and y-axis metrics, then define how you want to aggregate your data in the buckets section. Want to learn more about how the aggregations work? See more here: - https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-aggregations.html [block:image] { "images": [ { "image": [ "https://files.readme.io/77ff64d-Screen_Shot_2018-02-27_at_12.38.58_PM.png", "Screen Shot 2018-02-27 at 12.38.58 PM.png", 2560, 1318, "#dec9d1" ] } ] } [/block] Name your component and save it. ## Create a Kibana Dashboard To create a saved Kibana dashboard, you must first have some [visualization components](https://docs.bonsai.io/v1.0/docs/kibana#section-create-a-kibana-component) to build with. To get started, navigate to the `Dashboard` tab and click `Create a dashboard`. [block:image] { "images": [ { "image": [ "https://files.readme.io/19b65a0-Screen_Shot_2018-02-27_at_12.39.40_PM.png", "Screen Shot 2018-02-27 at 12.39.40 PM.png", 2560, 1318, "#36abd2" ] } ] } [/block] You're now in the dashboard builder and can add existsing visualizations. Click `Add` to add a component. [block:image] { "images": [ { "image": [ "https://files.readme.io/b2f0c87-Screen_Shot_2018-02-27_at_12.39.48_PM.png", "Screen Shot 2018-02-27 at 12.39.48 PM.png", 2560, 1318, "#34abd2" ] } ] } [/block] Choose the visualization you want, and click `Save`. [block:image] { "images": [ { "image": [ "https://files.readme.io/63a23d8-Screen_Shot_2018-02-27_at_12.40.31_PM.png", "Screen Shot 2018-02-27 at 12.40.31 PM.png", 2560, 1316, "#36abd0" ] } ] } [/block] Et voilà! Now go build more components and enjoy your cool dashboard! Since your metadata is saved in your cluster's `.kibana` index, all of your settings will be saved for the next time you need to come back.