System Logs

From docs.websky.tech
Jump to navigation Jump to search

System Logs is a module of the Websky system used for recording actions and events taking place in the system.

Purpose

Websky supports a flexible tool for logging all important operations that take place in the system. It helps to learn detailed information about almost any action inside the system in the shortest possible time. The interface provides the widest choice of filters to select the necessary data. In addition, there are a number of pre-installed filters, which are separated into a separate block and accessible by links.

Principle of Operation

Depending on their type the logs can be:

  • indexable - errors, warnings, etc. These logs can be searched through log filters.
  • non-indexable - message, etc., are available in the body of one log action during the opening.

If no indexed logs have been collected after a script has been executed, no logs are saved.

Principles:

  • only the actually useful logs must be indexed (the event type must be chosen correctly).
  • the amount of data placed in the logs must be minimized (for example, do not save the entire armor object).

To search and view the logs, go to For technical support → Logs section.

Logs section consists of 3 main parts:

  • The filter form.
  • The filter presets block.
  • Log table.

The log entries are arranged page by page, to switch to the next page, click the Next. link at the bottom of the table.

1200px
Log page

Success of action is a characteristic of a single Websky request, for example, for the search it means getting at least one result, for booking it means successful booking, etc.

Log table

  • Table columns - log parameters,
  • Table rows - action records.

A single log entry is called an action (essentially the equivalent of a single PHP script). An action contains many operations.

Each record in the table is an action. To open its operations, expand the record by clicking on it.
Some operations are accompanied by a Data link that opens additional information about the event (operation): the body of the XML request, a set of parameters or a complete message (if a short one is cropped by length), etc.

For each action (log), there is a link. Additionally, there may be links "Upload xml logs", "View order", "View search results", "Search form", etc.

Logs, where interaction with GDS was taking place, are marked in green.

Attention! Logs of search queries are written in a separate table.

Search query table parameters

  • Launch - time to start the action.
  • User - the user who launched the action.
  • Component - system component, to which the action belongs.
  • Action - name of the action.
  • Message - short identification message, used for search of logs.
  • Order - order number.
  • Search - search number.
  • Billing - payment transaction number.
  • Supplier - the name of the service provider involved.
  • Runtime - the numeric value (in seconds).
  • IP - address of the host that initiated the action.
  • Additional - additional information, for example:
    • status of the action ("Successful" / "Failed");
    • number of errors, if any;
    • the system operation mode in which the action was performed).

Log filters

Filters are used to search for logs. By default, the form of filters is displayed on the page in a minimized form, where the most used filtering options are available:

  • User - user identifier,
  • Order - order identifier,
  • Message - a short identification message to search for logs,
  • Event - a list of events registered by the system.

To access all the parameters of a filter, click the button "Additional filters" (see the Additional filters section).

Additional filters

The full filter form includes the following fields:

Name Description
User User ID
Order Order identifier
Message Short identification message for log search
The Event

List of events registered by the system:

  • Any.
  • "Action registration".
  • [GDS] Request" - request to external system.
  • [GDS] Response" - a response from the external system.
  • [GDS] Error" - received error from external system.
  • [Notification] Event" - something is sent to somebody (message).
  • [Notification] SMS" - SMS notification.
  • [Notification] Email" - e-mail notification.
  • [Notification] Error" - notification error.
  • [Error] Validation" - backend validation error (for example, validation of form).
  • [Error] Access restriction" - error with restricting access to somewhere for someone.
  • [Error] Lock" - for undefined errors caused by controller function ->lock().
  • [Input/Output] Request" - received incoming request.
  • [Input/Output] Response" - reply to the incoming request.
  • [Input/Output] File Upload" - somebody uploads the file.
  • [Input/Output] Local auto request" - starts http request to your server.
  • [Integration] Export" - export from the system.
  • [Integration] Import" - import to the system.
  • [Integration] Error" - import/export error.
  • [Authorization] via site" - authorization via the website.
  • [Authorization] via external system" - authorization via remote system.
  • [Authorization] Logout" - logout.
  • [Authorization] Error" - logout error.
  • [Registration] Request" - registration.
  • [Registration] Confirmation" - registration confirmation.
  • [Registration] automatic" - auto-registration.
  • [Users] Change" - something changes in user/group.
  • [Users] Creation of a new one" - new user.
  • [Users] Create a company" - new company/agency.
  • [Users] Group Creation" - new group.
  • [Users] Password change" - change of password.
  • [Users] Deletion" - deletion of a user.
  • [Order] Error at booking"
  • [Order] Error at cancellation
  • [Order] Error at issue
  • [Order] Error in updating
  • [Order] Error on modification
  • [Order] Operation"
  • [DB] New record
  • [DB] Update record
  • [DB] Delete record
  • [System] Anchor (for indexing)
  • [API] Request" - request to agency services.
  • [API] Answer" - a response from agency services.
  • [API] Error" - agent services error.
  • [Payment] Change of status" - change of payment status.
  • [Payment] Request to gateway" - request to payment gateway.
  • [Payment] Answer from gateway" - answer from the payment gateway.
  • [Payment] Error" - bug from the payment gateway.
  • [Payment] Go to gateway page"
  • [Payment] Change of payment method
  • [Balance] Change the balance"
  • [Balance] Change the available overdraft"
  • [Balance] Available funds"
  • Warning
Action Select the type of action:
  • Any
  • " Unidentified"
  • Registration
  • Authorization
  • Authorization (optional)
  • Exit
  • Settings
  • "Search form"
  • Search process
  • Search results
  • "Request for data on service"
  • "Entering customer information"
  • "Entering passenger information"
  • Booking
  • "Order information display"
  • Payment
  • "Undefined action with an order"
  • Confirmation
  • "Extract"
  • "Cancellation of ticketing"
  • "Refund"
  • Displaying information
  • Additional client request
  • Update
  • "Test script"
  • Order modification
  • Automatic action
  • Systematic action
  • Form (other)
  • "My passengers"
  • "Messages and inquiries"
  • Documents
Search
Billing
Supplier
Payment gateway
Object-user
Object
Action ID
IP
Date
In the last X seconds
With requests to the GDS
Test mode
Success
  • Any
  • Successful
  • Not successful

Pre-defined filters

A block of links with preset filters created for quick search:

  • My logs (of the current user).
  • My logs (by IP).
  • Problem ticketings.
  • Partial ticketings.
  • Problem bookings.
  • Problem cancellations.

Log records search

Log Search

To apply filtering to logs:

  1. Set the filter values.
  2. Click on "Search".
    To cancel the filter, click on the "Reset" button.
500px.
Search for logs by e-mail notifications of the specified user.

Searching for search request logs

Search request logs are written in a separate table.

To search for search logs:

  1. Click the button "Search request log table".
  2. Set the filter values.
  3. Click on the button "Search".
    To cancel the filter, click on the button "Reset".
500px.
Link to search request logs table
500px.
Example of search request log search

Searching for restored logs

After clicking on the link Search for restored logs, the search will be performed in a special log storage, which was lost for some reason and then restored.

Examples of log search

  • By order number:
    1. enter the order number in the "Order" field,
    2. press the "Search" button.
500px.
Searching for logs by order number
  • By error - if the required orders contain a known error:
    1. enter the error text in the "Message" field.
    2. press the "Search" button.
500px.
Search for logs with errors among orders of the specified user.png

XML data logging

The module performs logging:

  • of the package exports of orders from personal account in Websky/SOFI formats,
  • of the metasearch statistics uploads,
  • of the user export.

For the first two exports, single order exports and requests to GDS, each log can be downloaded separately.

If the content of the event contains more than just XML, only XML (for example, Websky/SOFI uploads) is extracted and output from all content.

To prevent the browser from freezing due to the large volume of the event log (over 64000 characters), the corresponding message is displayed on the main page of logs (settings/logs) instead of the content. XML can be viewed in a separate window through a special plugin.

Examples of logging

The following actions are logged in Websky:

  • change of settings in the Administration panel,
  • action with the order (including notifications, exports, payment, status fixing, etc.),
  • search,
  • authorization / registration on the site,
  • action in the personal account (exporting orders, sending messages/requests, etc.).

Features of logging actions in Websky

  • GDS connection requisites:
    • When you change GDS connection requisites, these changes and the state of settings before them are logged.
    • When you delete the requisites, the id of the requisites to be deleted and data contained in this id are logged.
  • Logging of setting value change - setting change is also logged:
    • date and time of changing the setting value;
    • the full name of the setting;
    • the user who changed the setting value;
    • the previous setting value;
    • the current setting value.

Example:

2014-10-06 15:33:41.915 [Users] Change "user.param.time_zone" (Data)
Array
(
    [oldValue] => Pacific/Fakaofo
    [newValue] => Indian/Antananarivo
)

Errors occurring during payment

  • The blocking "Payment prohibited for this order" - this error can be found in Websky administration panel in the logs when the order was not booked and the user tried to pay for it; or when the order has been booked but not in the available actions for ordering the ticketing operation; or when the order was booked and there are no ancillary services for pre-ticketing. During the payment attempt, the system performs these checks and blocks the payment in these cases.

See also