Initial commit

Change-Id: I2d68bef99e793214347a3b62ca717ab21d5d15c1
13 files changed
tree: 7ee921fd3b47261cfbb7e990352b2fa9ae0c23a2
  1. .gitignore
  2. LICENSE
  3. README.md
  4. analytics-setup/
  5. local_environment/
README.md

Kibana Dashboard

The goal of this project is to provide the tools to manage and configure a kibana dashboard aimed to visualize analytics on project contributions. Kibana configuration is maintained in elasticsearch so, in reality, this project will talk to the elasticsearch instance which kibana is connected to.

For the time being, this project allows to configure only one type of dashboard:

  • Git Commits Dashboard: which is able to display data produced by the execution of the GIT commits ETL analytics ETL

Getting Started

To get you running in no time, this project also provides a way to spin up a local environment with elasticsearch and kibana:

cd local_environment
docker-compose up

this will start:

  • elasticsearch, bound and exposing port 9200 and 9300
  • kibana, bound and exposing port 5601

Prerequisites

Restore kibana configuration

To configure a kibana dashboard you can simply point the setup script to the target elasticsearch as follows

make restore [ELASTICSEARCH_URL] [ELASTICSEARCH_PORT]

  • ELASTICSEARCH_URL: default is http://host.docker.internal (the current host running docker)
  • ELASTICSEARCH_PORT: default is 9200

For example to configure kibana spinned up via local environment you can simply run:

cd analytics-setup
make restore

Just browse to http://localhost:5601 to see the configured dashboard.

At this point the dashboard will still be empty. If you want to populate it with data you might want to run the GIT commits ETL

Dump kibana configuration

If you make some changes to kibana and you want to dump them on disk for later use you can just run:

make dump [ELASTICSEARCH_URL] [ELASTICSEARCH_PORT]

  • ELASTICSEARCH_URL: default is http://host.docker.internal (the current host running docker)
  • ELASTICSEARCH_PORT: default is 9200

For example to dump the configuration of kibana spinned up via local environment you can simply run:

cd analytics-setup
make dump

This will save any changes to kibana-config/analytics-settings-dashboards-visualizations.data.json

License

This project is licensed under the Apache License, Version 2.0 License - see the LICENSE file for details