Shipbook Guide

LOGBOOK
 

The Logbook is a highly intuitive and intelligent search engine.  Easily find the logs you need to quickly solve any issue.These vast searching capabilities open the door to freely choose the best way for you to look for the source of the bug or issue.  

Sessions & Logs

The Logbook is organized according to session.
Each session has a blue header indicating the collective information.

The Session header displays:

  • Session start date and time

  • Hardware Info:  Manufacturer, Device name

  • Software Info: OS Version, App Version, Device Language

  • User Info: UUID (iOS) / Android ID, User ID,  User Name, Full User Name, Email, Phone number, and Custom parameters

Beneath each session header are the logs of that session organized chronologically, in other words, newest logs are displayed at the top of the list.

Selecting the message will open up a window where the comprehensive details of the log are displayed.  

The log message displays:

  • Log date and time

  • Log message

  • Log message location in code: File name, File row number, Function name (in parentheses), Tag name

Once a log is selected, a message box will open displaying the complete detail of all of the information from that log:

When reviewing the logs in search of the root of a problem, this will provide the developer with invaluable information and detail, allowing for much faster solutions. 

For example, in which orientation did the user experience a problem, or does the bug occur in specific telephones or software versions?

*Note: Message text has a limit of 10,000 characters.

For your convenience, at the bottom left of the message box note a small blue arrow icon- to select whether or not to text wrap the display of the log message.

Go to session: Any individual log session can be viewed by clicking on the small arrow (see “Go to Session” icon) on the far right, at the end of each log row.

You can also configure the amount of information that you wish to display: 


By Selecting the blue icon with the four parallel lines,  below the logs list you can choose to view simplified logs alone:

By switching the blue icon to the two large lines, below the logs list, you can choose to have the information displayed in more detail, as seen here.

You can switch the events icon “on” or “off” to choose whether or not to display events in the logs list

Search Box

Seek & you shall find
In one simple search, find exactly what you are looking for. All the search parameters are in one place. 

 

You can search through your logs with free text search or with parameters such as Device Model, UDID, or App Version. We make these searches even easier with our intuitive autocomplete function.

How Does All This Work?

Search using parameters:

Use the intuitive dropdown autocomplete function to search by specific user Email, User ID, etc.

In addition, you can add parameters by clicking on the small plus sign (+) that appears in the session and log. These will now become searchable parameters. 

Remember! With the Ultimate Search Intelligence, You Will Always Find What Your Are Looking For. 

>

Note: The search field can be used to enter all search parameters and variables.You can easily combine search parameters to refine your search. For example: MSG+ UDID

*

Next to the search bar, there is a refresh logs button. As logs are collected by the system on the fly therefor refresh for the most current logs.

Severity Icons

Notice, on the top right, six severity icons that allow you to control how you prefer to search.

From left to right the icons allow you to automatically organize your logs based on log severity: 

  1. Verbose

  2. Debug

  3. Info

  4. Warning

  5. Error

  6. Exception.

The switch button on the far right allows you to either:

  • From severity: View logs according to the minimum severity level selected

  • Specific severity: View logs according to specific severity level selected

Share Button

This button gives you the option to share the current search result via Jira, Slack, email, copy URL, and download log data.

 
 
 

© 2018 Shipbook Ltd.

  • Facebook Social Icon
  • LinkedIn Social Icon

Animation & Graphic Design: Barel Toledano

Content Writer:  Zoe Kabilio