Kibana Connect

For the most up-to-date documentation, please visit docs.brix.ch

Kibana Connect

Properties

To be configured in {home}/appserver/conf/custom.properties

kibanaConnector.license

type: String, required: yes, default: -

The license key for the plugin (product: kibanaConnector), provided by brix.

kibanaConnector.threadPoolSize

type: int, required: no, default: 10

Number of threads used for indexing. A higher value can make indexing faster, but it also requires more resources.

kibanaConnector.pageSize

type: int, required: no, default: 200

This setting determines how many assets are processed simultaneously during indexing.

kibanaConnector.lastIdReset

type: boolean , required: no, default: false

This property can be set to true (preferably only temporarily via the configuration manager), to reset the Event-Id, from which the data will be sent to Kibana.

kibanaConnector.maxCacheSize

type: int, required: no, default: 50000

Number of Assets that are stored in the cache while indexing. A higher value can make indexing faster, but it also requires more resources.

Installation

Set Up Elasticsearch

  1. Download Elasticsearch 7: https://www.elastic.co/downloads/elasticsearch
  2. Unzip the file to your install directory (e.q. /opt/elasticsearch)
  3. Start Elasticsearch with elasticsearch-7.x/bin/elasticsearch &

Set Up Kibana

  1. Download Kibana 7: https://www.elastic.co/downloads/kibana
  2. Unzip the file to your install directory (e.q. /opt/kibana)
  3. Start Kibana with kibana-7.x/bin/kibana &

Set Up Celum Connector

  1. Place the kibanaConnector-x.jar in the celum lib folder and configure the necessary properties.
  2. After an appserver restart run all the tasks in the kibana task-tab. (Make sure Elasticsearch and Kibana are running.)

Note: The Event-Tasks tracks it's own progress. It can be paused or stopped and will continue where it has been stopped. If there is the need to reindex all the events, the property 'kibanaConnect.lastIdReset' can be set to 'true' and the indexing will start form the first Event. Remember to set the property back to false, after the first run.

Kibana Index

Asset-Index

Asset
│   
└───Active From (date)
└───Active To (date)
└───Active Type (string)
└───Asset Id (number)
└───Asset Type Id (number)
└───Asset Type Name (string)
└───Created By
│   └───Date (date)
│   └───User Id (number)
└───Direct Parents (number)
└───File Category (string)
└───File Extension(string)
└───Infofield Entries
│   └───Informationfield Id (number)
│   └───Value (string)
│   └───Label (string)
└───Last Modified By
│   └───Date (date)
│   └───User Id (number)
└───Name (string)
└───Original File Name (string)
└───Original File Size (number)
└───Parents (number)
└───Status (string)
└───Versioned By
    └───Date (date)
    └───User Id (number)

Node-Index

Node
│   
└───Has Children (boolean)
└───Name (string)
└───Node Id (number)
└───Node Type Id (number)
└───Node Type Name (string)
└───Parent Id (number)
└───Parent Ids (number)
└───Validation Level Inherited (boolean)

User-Index

User
│   
└───Company (string)
└───Created (date)
└───Deactivated (boolean)
└───First Name (string)
└───Last Name (string)
└───Middle Name (string)
└───Must Change Password (boolean)
└───System (boolean)
└───User Id (number)
└───User Kind (string)

Event-Index

Event
│   
└───Asset Id (number)
└───Asset Type Id (number)
└───Asset
└───Date (date)
└───Event Id (number)
└───Event Type (string)
└───Event Type Id (number)
└───Node Id (number)
└───Node Type Id (number)
└───Node
└───User Id (number)
└───User

Release Notes

1.0.0

Released 2019-10-09

Initial Version