{"_id":"5a8fae0468264c001f20cc43","category":{"_id":"5a8fae0368264c001f20cc05","version":"5a8fae0268264c001f20cc00","project":"5633ebff7e9e880d00af1a53","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-04T21:11:27.469Z","from_sync":false,"order":7,"slug":"dashboards","title":"Common Tools"},"project":"5633ebff7e9e880d00af1a53","parentDoc":null,"user":"5637d336aa96490d00a64f81","version":{"_id":"5a8fae0268264c001f20cc00","project":"5633ebff7e9e880d00af1a53","__v":4,"createdAt":"2018-02-23T06:00:34.961Z","releaseDate":"2018-02-23T06:00:34.961Z","categories":["5a8fae0268264c001f20cc01","5a8fae0268264c001f20cc02","5a8fae0368264c001f20cc03","5a8fae0368264c001f20cc04","5a8fae0368264c001f20cc05","5a8fae0368264c001f20cc06","5a8fae0368264c001f20cc07","5a8fae0368264c001f20cc08","5a8fae0368264c001f20cc09","5abaa7eb72d6dc0028a07bf3","5b8ee7842790f8000333f9ba","5b8ee8f244a21a00034b5cd9"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"githubsync":"","__v":0,"updates":["59d7cad6d5525800101ae5a5"],"next":{"pages":[],"description":""},"createdAt":"2016-01-15T17:56:31.479Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Kibana is an open-source data visualization and dashboard tool built for rich analytics. It takes advantage of Elasticsearch’s full-text querying and aggregation capabilities to built highly flexible and interactive dashboards.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e0fa1b7-kibana.jpg\",\n        \"kibana.jpg\",\n        1000,\n        560,\n        \"#206f87\"\n      ]\n    }\n  ]\n}\n[/block]\nAll Bonsai clusters support Kibana out of the box. It is possible to use Kibana through one of several ways:\n\n* [Cluster Dashboard](doc:using-kibana-with-bonsai#cluster-dashboard)\n* [As a free Heroku App](doc:using-kibana-with-bonsai#as-a-free-heroku-app)\n* [Locally / Private Server](doc:using-kibana-with-bonsai#locally--private-server)\n\nFor information on using Kibana, consult the [official documentation](https://www.elastic.co/guide/en/kibana/current/getting-started.html). \n[block:api-header]\n{\n  \"title\": \"Cluster Dashboard\"\n}\n[/block]\nBonsai provides Kibana instances to clusters running on Elasticsearch versions 5.x and up. You can find the URL to your private Kibana instance on the cluster dashboard. It will look like this:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/93bbc86-kibana-url.png\",\n        \"kibana-url.png\",\n        831,\n        224,\n        \"#f2f2f2\"\n      ]\n    }\n  ]\n}\n[/block]\nClicking on the \"Access Kibana\" link, or copy/pasting the Kibana URL into a browser will take you to your Kibana instance.\n\nFor more reading on the cluster dashboard, see the relevant documentation:\n\n* [Direct sign ups](doc:managing-your-cluster) \n* [Heroku users](doc:bonsai-elasticsearch-dashboard) \n* [Manifold users](doc:managing-your-cluster-1) \n[block:api-header]\n{\n  \"title\": \"As a Free Heroku App\"\n}\n[/block]\nIf you have a Heroku account, there is a [GitHub project](https://github.com/omc/heroku-kibana) that offers a click to deploy button. Clicking on the button will walk you through the process of deploying a free Heroku app running Kibana, which can be configured with a URL to an Elasticsearch cluster.\n\nIf you don't have a cluster yet, a free Bonsai cluster will be created and attached to the Kibana app. If you already have a Bonsai cluster, you can link to it during the build process.\n[block:api-header]\n{\n  \"title\": \"Locally / Private Server\"\n}\n[/block]\nYou may also [download](https://www.elastic.co/downloads/kibana) Kibana and run it locally or on a private server. Not all versions of Kibana are compatible with all versions of Elasticsearch, so make sure to check the [compatibility matrix](https://www.elastic.co/support/matrix#matrix_compatibility) and download a version that will work with your Bonsai cluster.\n\n(_Note:_ You can also install Kibana using a [repository](https://www.elastic.co/guide/en/kibana/current/install.html) and package manager, but this will likely involve downloading the latest version and may not be compatible with your cluster)\n\nOnce you have Kibana downloaded, you'll need to configure it to point at your Bonsai cluster. Open up the `config/kibana.yml` file and to set the value for `elasticsearch_url`. For example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    elasticsearch_url: \\\"https://randomuser:randompass:::at:::something-12345.us-east-1.bonsai.io\\\"\",\n      \"language\": \"yaml\",\n      \"name\": \"config/kibana.yml\"\n    }\n  ]\n}\n[/block]\nIn some later versions of Kibana, you may need to separately specify your Bonsai cluster's username/password as configuration options:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    elasticsearch_url: \\\"https://randomuser:randompass@something-12345.us-east-1.bonsai.io:443\\\"\\n    elasticsearch.username: \\\"randomuser\\\"\\n    elasticsearch.password: \\\"randompass\\\"\",\n      \"language\": \"yaml\",\n      \"name\": \"config/kibana.yml\"\n    }\n  ]\n}\n[/block]\nOnce Kibana has been configured, you can run it with `bin/kibana` (or `bin\\kibana.bat` on Windows). This will start up the Kibana server with the settings pointing to your Bonsai cluster.\n\nLast, open up a browser to http://localhost:5601 to finish setting up Kibana and get started. Note that if you're running Kibana on a remote server, you'll need to replace `localhost` with the IP address or domain of the remote server.","excerpt":"","slug":"using-kibana-with-bonsai","type":"basic","title":"Using Kibana with Bonsai"}

Using Kibana with Bonsai


Kibana is an open-source data visualization and dashboard tool built for rich analytics. It takes advantage of Elasticsearch’s full-text querying and aggregation capabilities to built highly flexible and interactive dashboards. [block:image] { "images": [ { "image": [ "https://files.readme.io/e0fa1b7-kibana.jpg", "kibana.jpg", 1000, 560, "#206f87" ] } ] } [/block] All Bonsai clusters support Kibana out of the box. It is possible to use Kibana through one of several ways: * [Cluster Dashboard](doc:using-kibana-with-bonsai#cluster-dashboard) * [As a free Heroku App](doc:using-kibana-with-bonsai#as-a-free-heroku-app) * [Locally / Private Server](doc:using-kibana-with-bonsai#locally--private-server) For information on using Kibana, consult the [official documentation](https://www.elastic.co/guide/en/kibana/current/getting-started.html). [block:api-header] { "title": "Cluster Dashboard" } [/block] Bonsai provides Kibana instances to clusters running on Elasticsearch versions 5.x and up. You can find the URL to your private Kibana instance on the cluster dashboard. It will look like this: [block:image] { "images": [ { "image": [ "https://files.readme.io/93bbc86-kibana-url.png", "kibana-url.png", 831, 224, "#f2f2f2" ] } ] } [/block] Clicking on the "Access Kibana" link, or copy/pasting the Kibana URL into a browser will take you to your Kibana instance. For more reading on the cluster dashboard, see the relevant documentation: * [Direct sign ups](doc:managing-your-cluster) * [Heroku users](doc:bonsai-elasticsearch-dashboard) * [Manifold users](doc:managing-your-cluster-1) [block:api-header] { "title": "As a Free Heroku App" } [/block] If you have a Heroku account, there is a [GitHub project](https://github.com/omc/heroku-kibana) that offers a click to deploy button. Clicking on the button will walk you through the process of deploying a free Heroku app running Kibana, which can be configured with a URL to an Elasticsearch cluster. If you don't have a cluster yet, a free Bonsai cluster will be created and attached to the Kibana app. If you already have a Bonsai cluster, you can link to it during the build process. [block:api-header] { "title": "Locally / Private Server" } [/block] You may also [download](https://www.elastic.co/downloads/kibana) Kibana and run it locally or on a private server. Not all versions of Kibana are compatible with all versions of Elasticsearch, so make sure to check the [compatibility matrix](https://www.elastic.co/support/matrix#matrix_compatibility) and download a version that will work with your Bonsai cluster. (_Note:_ You can also install Kibana using a [repository](https://www.elastic.co/guide/en/kibana/current/install.html) and package manager, but this will likely involve downloading the latest version and may not be compatible with your cluster) Once you have Kibana downloaded, you'll need to configure it to point at your Bonsai cluster. Open up the `config/kibana.yml` file and to set the value for `elasticsearch_url`. For example: [block:code] { "codes": [ { "code": " elasticsearch_url: \"https://randomuser:randompass@something-12345.us-east-1.bonsai.io\"", "language": "yaml", "name": "config/kibana.yml" } ] } [/block] In some later versions of Kibana, you may need to separately specify your Bonsai cluster's username/password as configuration options: [block:code] { "codes": [ { "code": " elasticsearch_url: \"https://randomuser:randompass@something-12345.us-east-1.bonsai.io:443\"\n elasticsearch.username: \"randomuser\"\n elasticsearch.password: \"randompass\"", "language": "yaml", "name": "config/kibana.yml" } ] } [/block] Once Kibana has been configured, you can run it with `bin/kibana` (or `bin\kibana.bat` on Windows). This will start up the Kibana server with the settings pointing to your Bonsai cluster. Last, open up a browser to http://localhost:5601 to finish setting up Kibana and get started. Note that if you're running Kibana on a remote server, you'll need to replace `localhost` with the IP address or domain of the remote server.