siscale / kibana-arcanna-deprecated

The ARCANNA Kibana Plugin

Arcanna - Automated Root Cause Analysis Neural Network Assisted - is a custom built Elastic plugin capable of identifying with increased accuracy the probable root cause of issues that arise within the entire infrastructure stack. For a more in-depth description of the product, please visit our website and our blog postings (#1, #2, #3).

This repository represents the Kibana plugin (UI) of the solution.

In order to use the solution, you also need to setup the solution backend, which can be found here.

---

Installation

In order to install the Arcanna Kibana Plugin, first download the appropriate release for your Kibana version from the releases tab.

To install the plugin in Kibana, run the following command:

bin/kibana-plugin install file:///PATH_TO_FILE/arcanna-vXXXXX.zip

Wait until the installation finishes. It may take several minutes to optimize and cache browser bundles.

In kibana.yml, add the Arcanna backend settings:

arcanna.endpoint.url: "http://ARCANNA_BACKEND_HOST:5000"
arcanna.endpoint.token: "ARCANNA_BACKEND_AUTH_TOKEN"

Restart Kibana to apply the changes.

You are now ready to use the Arcanna plugin.

Development

Kibana setup

Check the kibana contributing guide for initial setup steps.

Extra steps

Once Kibana is setup, find the last commit for the required Kibana version. Check the plugin package.json to get the exact kibana version. You can use the tags to find the proper commit.

git checkout <commit-sha1>
yarn kbn bootstrap

You can add a kibana dev config file to kibana to avoid involuntary deletion.

The plugin currently uses the deprecated kibana dev folder structure:

.
+-- kibana
+-- kibana-extra
|   +-- kibana-arcanna

When in the plugin folder, the following commands are available:

• yarn kbn bootstrap

  Install dependencies and crosslink Kibana and all projects/plugins.

  IMPORTANT: Use this script to install dependencies when switching branches, and re-run it whenever your dependencies change.

• yarn start

  Start kibana and have it include this plugin. You can pass any arguments that you would normally send to bin/kibana

  yarn start --elasticsearch.url http://localhost:9220
  

  In order to use the dev kibana config use the script with the --dev flag:

  yarn start --dev
  

• yarn build

  Build a distributable archive of your plugin.

• yarn test:browser

  Run the browser tests in a real web browser.

• yarn test:server

  Run the server tests using mocha.

For more information about any of these commands run yarn ${task} --help. For a full list of tasks checkout the package.json file, or run yarn run.