You can use Kibana to analyze the logs that were uploaded from devices to the BlackBerry IoT Platform. Kibana is an open source (Apache Licensed), browser-based, analytics and search dashboard. The BlackBerry IoT Platform provides a Kibana server, which uses Elasticsearch to index your organization's logs. If you want more detailed information about using Kibana, see:
- an overview about Kibana at http://www.elasticsearch.org/overview/kibana/
- 10 minute walkthrough at http://www.elasticsearch.org/guide/en/kibana/current/using-kibana-for-the-first-time.html
Note: To perform log analysis on the Kibana server provided as part of the BlackBerry IoT Platform, you may need to contact a representative from our sales team.
Logs uploaded are uploaded as data with the type of log to the BlackBerry IoT Platform. The information that's provided in a log can be specific to the application, but must adhere to the standard schema. The log information is pushed by an agent that runs on the device.
The logs can have any information that's useful for identifying trends, debugging an application, or gathering usage information. This information to particular to the requirements of the application and what information needs to be analyzed. For example, if you have an inventory application, you may find it useful to log faults, errors, or warnings that occur while the application is running.
After you have this information, what can you use it for? The short answer is anything you want, however here are some suggestions:
- build trends to understand deployment of your devices
- identify the faults that are most relevant, based on a various factors, such as time, location, number, etc.
- understand details about the device
About the Log dashboard
To start using the Log dashboard, the following items are required:
- an active user account on BlackBerry IoT Platform with either the capabilities to create an organization or that’s part of an existing organization
- access to logs for multiple devices stored in cloud Note: It's presumed that the devices are configured to send their log data to the cloud
When a user logs into Kibana to use the Log dashboard, all the organizations and applications that user has access to are available. The logs are filtered based on the applications that the user selects. The user can further refine the filters on the data to analyze and better understand the collected logs.
The Log dashboard indicates the number of logs that were collected during a time interval. The user can filter the information from the logs and look at specific information about each log. Having this functionality can help the user identify trends about devices and help to build an overall understanding of the health of the deployed devices.
It's important to understand that the same security policies configured on the BlackBerry IoT Platform applies to logs. The assigned tags and capabilities applied to a user determine the logs that user can see. For example, if a user doesn't have the proper capabilities to view logs for a particular application, that user won't be able to see any information from those logs.
In Log Analysis pane, there are three panes that are available:
- Log Levels: Shows the level of information that's being logged for the applications selected. If there's information logged that isn't tagged with a log level, it's indicated in the Missing column.
- Log Rate: Show the logs that have been collected. You can zoom into the logs to see the interval of the logs and hover over the bars to see the timestamp of each log.
- Logs: Shows the list of logs. You can select and view the details of each log in this pane. You can select the fields you want to see in the Fields column of the pane and click each log to see the raw JSON values.
When you first see the Log Rate pane, a bar appears on the right that shows limited information for a time interval. To see more details about the logs, you drag your mouse to expand the time interval. For example, you may see data in the following format.
After you drag your mouse as shown in the following illustration, the data is magnified:
If you repeat the process and select various areas in the Log Rate pane, you can see the intervals of the logs:
In the Logs pane, you can select various fields and see them in the table of logs. If you click a specific log, you can view detailed information about the log. You can view the log details as a table of values, JSON, or as Raw information as shown below: