This is a Kibana Dashboard customized for UiPath logs. It is implemented as an ELK Stack using ElasticSearch, LogStash and Kibana.
To simplify installation the project is built as a Docker container. If you have Docker on your computer, you should be up running with a simple command. If not, you first have some installation to do.
You need Docker installed on your computer. Consider installing Kitematic which provides a graphical user interface for Docker on Windows.
For Elasticsearch to complete launching, at least 4Gb of memory needs to be allocated to Docker, and its limit on mmap counts needs to be set to 262,144 or more..
To build and launch the project, execute in the shell:
docker run -p 5601:5601 -p 9200:9200 -p 5044:5044 -it runefar/uipath-dashboard
Wait until the build has completed, then open the Kibana dashboards in a web browser:
http://localhost:5601/app/kibana#/dashboards
On windows the URL may have another port than 5601 mapping to it. If you use Kitematic, click on the Settings tab, and then on the Ports sub-tab to see the list of the ports exposed by the container (under DOCKER PORT) and the list of IP addresses and ports they are published on and accessible from on your machine (under MAC IP:PORT). Use the provided IP/port shown mapping to 5601 or configure it yourself for example to 32770.
If the Kibana page doesn't open, wait a little longer to ensure it is ready. It may take up to a few minutes before everything is settled.
If the visualizations in the Kibana dashboard show no data, you may have to adjust the time range for the logs in the top right of the menu. A timespan of Last Five Years should be sufficient.
Obviously you didn't just want a dashboard for random preset logs, but see your own. Use the docker -v option to specify a log directory, substituting $(pwd)/logs with the absolute path to your UiPath logs directory:
docker run -v $(pwd)/logs:/usr/home/logs -p 5601:5601 -p 9200:9200 -p 5044:5044 -it runefar/uipath-dashboard
UIpath can log directly to ElasticSearch so if you're savvy that's an alternative.
The following are notes for advanced customization and further development. You don't need it for basic use. It assumes you have cloned the distribution from the github repository with the current directory path being the repository.
Launch the dashboard using the provided docker-compose.yml configuration:
docker-compose --project-name uipath up --build dashboard
Logfiles are loaded live from the logs directory. Add your own logfiles to
the directory as yous see fit. Alternatively, modify the path for logs in docker-compose.yml to your own log directory and restart.
For further customization see the documentation of elk-docker, which is used as foundation:
https://elk-docker.readthedocs.io/
Kibana persists the Dashboard configuration in ElasticSearch. You have to use the command line to extract the dashboard configuration, as Kibana's export menu command delivers an incompatible data format. Check the url in the browser for the dashboard ID,then export via http:
curl http://localhost:5601/api/kibana/dashboards/export?dashboard=xxxxx > dashboard.json
Rename the file and place it in the dashboard directory before rebuilding.
MIT License. Copyright (c) 2018 Rune Norderhaug