Log Sub-System

Owned by Kari Mattsson
2017-06-22
5 min read

The service makes logs of all events, such as user actions, both for device owners and organisation management, as well as device events. Each management section of the system writes log events for the objects. The log sub-system keeps track of each action and provides a way parse all the important information about the action that was made.

You can view the logs in the following ways:

Context Logs

You can access such logs in their context in many views, by right-clicking a table and selecting Log from the context menu.

The log view is a kind of a report. See Reports for a description of the basic functionalities.

It has some additional controls:

From

Start date and time for the log extract. If empty, the log is shown from the beginning.

To

End date and time for the log extract. If empty, the log is shown up to current time.

Show DEBUG events

The report by default shows all INFO, WARNING, and ERROR events, etc. Check the box to also show the DEBUG events, which give more detailed information and can be used for finding possible faults in the software.

The columns somewhat depend on the context, but have at least the same columns as the main event log, as described later.

Timeline

You can click the chart button in the bottom of the log view to view a timeline of events.

Clicking opens a timeline view pop-up.

You can select a time range by clicking any of the Zoom buttons (1m, 3m, 6m, YTD, 1y, or All), setting a custom range with the From and To buttons, or by dragging the range selection or it's begin and end handles at the bottom of the view.

Click × to close the window.

Main Event Log

The main system event log allows filtering and browsing all the events done in the system.

  1. Open the Reports view
  2. In the Other tab, click the Event Log button
  3. The event log filter view opens:
  4. Select Date range.
    1. Month (default) shows logs for a single month, which you can select in the Select month field by clicking the ⏪, ⏴, ⏵, and ⏩ buttons
    2. Year shows logs for a single year, which you can select in the select in the Select year field by clicking the ⏪, ⏴, ⏵, and ⏩ buttons
    3. Custom allows defining any date range. You need to specify start and end dates with the date fields.
  5. Use any of the filters in the view to narrow the search results down:

    User

    Filters events associated to a user; not applicable for event types that are not associated with a user. Select either Equals or Doesn't equal and then select a user from the selection box. You can type text to the input field to filter the selection.

    Source

    Filters events according to the event source. The source is a subsystem writing to the system log. Select either Equals or Doesn't equal and then select a subsystem from the selection box.

    Type

    Filters events according to the event type (debug, information, warning, error, action-required, or acknowledged). Select either Equals or Doesn't equal and then select an event type from the selection box.

    Event ID

    Filters events according to the exact event ID. Select either Equals or Doesn't equal and then select an event ID from the selection box.

    Status text

    Filters events according to the event status text, which can have numeric or other status information. Select either Equals or Doesn't equal for matching the entire text or Contains (most typically) or Doesn't contain for partial match, and enter the text to search in the input field.

    Description

    Filters events according to the event description. Select either Equals or Doesn't equal for matching the entire text or Contains (most typically) or Doesn't contain for partial match, and enter the text to search in the input field.

    Target

    Filters events according to the target of an event. The target is typically a device ID, a user ID, a phone number, or an email address, but can also be a special label. For example, when an account was removed, the user ID no longer exists, so "(account)" is shown. Select either Equals or Doesn't equal for matching the entire text or Contains (most typically) or Doesn't contain for partial match, and enter the text to search in the input field.

    Target device

    As Target, but filters events according to a selected device. Select either Equals or Doesn't equal and then select a device from the selection box.

    Target account

    As Target, but filters events according to a selected account. Select either Equals or Doesn't equal and then select an account from the selection box.

    Leaving a filter empty means that it is not matched against (consequently you cannot match against empty text).
  6. Click Create report
  7. The log view opens. It is a normal report view, as described in Reports. The columns are largely as described above for the filters.
  8. Clicking Close in the report returns to the filter view.
  9. Click Close to exit the event log filter view.