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:

All Bonsai clusters support Kibana out of the box. It is possible to use Kibana through one of several ways: via your Bonsai cluster dashboard, as a free Heroku app, or locally/as a private server.

For information on using Kibana, consult the official documentation.

Cluster Dashboard

Bonsai provides Kibana instances to clusters running on Elasticsearch versions 5.x and up. You can launch your Kibana instance right from your dashboard.

From the Access Tab

A Word About Access Tokens

This is not your username and password. These tokens are randomly generated. If you copy and paste this URL into a browser, it might ask for login credentials; you will use these randomly-generated tokens as the username and password.

As a Free Heroku App

If you have a Heroku account, there is a GitHub project 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.

Locally / Private Server

You may also download 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 and download a version that will work with your Bonsai cluster.

( Note: You can also install Kibana using a repository 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:

    elasticsearch_url: "https://<access token>:<access secret>@something-12345.us-east-1.bonsai.io"

In some later versions of Kibana, you may need to separately specify your Bonsai cluster’s username/password as configuration options:

elasticsearch_url: "https://<access token>:<access secret>@something-12345.us-east-1.bonsai.io:443"
elasticsearch.username: "<access token>"
elasticsearch.password: "<access password>"

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.