Log View Plugin

Log View Plugin

This extension allows users to view VM log files. It uses the Log View backend-plugin that extends the CloudStack API with additional requests providing access to the VM log files storage. For the Log View UI-plugin operation, firstly, the Log View backend-plugin should be downloaded from GitHub and deployed. The plugin uses the ELK stack to store machine log files and Filebeat to export log files from a VM to the storage. The plugin is developed and tested only with Apache CloudStack 4.11.1.

Then, it is necessary to enable the Log View UI-plugin via the CloudStack-UI configuration file. After activation, the View Logs section appears in CloudStack-UI. There a user can select the log files to display by setting up main parameters - a virtual machine and a date for which a user wishes to see the logs.

To make the View logs section available, first, deploy the Log View plugin and then activate the UI-plugin via the config.json file. See details below.

Deployment Instructions

Full instructions on the Log View backend plugin deployment is presented at the project page.

To enable the Log View UI-plugin you need to:

1. Install the backend plugin into CloudStack.
2. Deploy necessary components: ElasticSearch, Filebeat, Logstash, Curator.
3. Enable the UI extension via the config.json file (see below).

Log View Configuration

Please, enable vmLogs in the extensions section of config.json:

"extensions": {
  ...,
  "vmLogs": true
}