Global Logs

Last modified on 2023/08/03 11:08
Contents

Global logs are log files that trace activity events on EasyVista servers using probes. For each EasyVista service, e.g. smoBroker, smoServer or smoMail, they help you understand the origin of errors when bugs occur and identify performance issues.

  • Probes are defined in the INI configuration file of each EasyVista service.
  • One log file will be generated for each enabled probe.
  • Events are traced in chronological order.

Notes

  • Passwords are never displayed in log files.

Caution

  • Certain activity probes require high CPU usage and as such, may have an adverse effect on platform performance. The size of the log file can also increase significantly.
    • These probes are indicated in red in the list.
    • We recommend that you avoid using these probes in the production database.
  • You must restart EasyVista services each time a probe is modified. Open url.png See the procedure.

Best Practice

  • Enable the ltException probe to find application downtime errors.

Menu access

Administration > Platform activity > Get global logs

Screen description

          Global logs.png

Start date / End date: Dates defining the start and end of the period to get log files.

Download: Used to download a ZIP file containing all log files on the period in XML and XLS format.

Description of log files

Probe log files

  • These files are automatically created once you enable the probe.
  • The daily values of activity probes are collected in each file.
  • File format: XML.

  • One file is created every day and added to the history of probe activity events.* File name = <ServerName><ControlParameterName>_<dateYYMMDD>.xml

    example  SMO_MSSQLException_220125.xml, SMO_MSSQLException_220124.xml, SMO_MSSQLException_220123.xml

    • One XSL file is generated for each EasyVista service. This provides an overview of all XML files.

      example  SMO_MSSQLException.xsl

LogConfig.txt

This file contains all modifications made to the configuration tables. 

  • This file is always created.
  • File format: JSON.

List of probes

Contents of a probe log file

All log files contain the main information below.

  • Error code
  • Platform
  • SMOServer (InterfaceName)
  • Host: Server hosting the SMOServer service
  • Remote: Machine submitting the call, e.g. PHP server
  • Database versions
  • Input: All information and parameters passed to the SMOServer service for the query
  • For SQL events:
    • SQL query
    • Query received, bind variables, query sent to the SQL server
    • Connection context: Initialization and information context

Description of probes

Probe Description
ltInterface Used to log calls from the PHP to the SMOServer service.

   This probe can have an adverse effect on the performance of the EasyVista service.
ltApplication Used to log initialization functions and all calls.

For the SMOServer service:

  • This includes calls from the SMOBroker service and other modules in SMOServer, except for workflows, the sending of emails, etc.
  • This does not include calls from the PHP.

   This probe can have an adverse effect on the performance of the EasyVista service.
ltWarning Used to log the functions and queries of the SMOServer service that require long processing times.

To avoid generating an excessive number of rows in the log file, you can specify the maximum values exceeding which warnings should be logged. Open url.png See the description

.
ltException Used to log application errors.
ltIntegration Used to log processing steps when integrating data.
ltMail Used to log errors that occur when sending emails.
ltScheduler Used to log scheduler activities.

Note: Used only when the scheduler is enabled for the SMOServer service.
ltProcess Used to log traces generated by business rules.
ltAuthentication Used to log connections to the SMOServer service, i.e. login, account, authentication method, results, etc.

Enabling probes

For each EasyVista service, the Log_Type parameter in the INI configuration file displays the list of probes to be enabled.

  • Syntax: Probes must be separated using the | character.

    example  

    • Log_Type= ltWarning  |  ltException |  ltIntegration  |  ltMail
  • Log_Type= ltAll: Enable all probes.

   This probe can have an adverse effect on the performance of the EasyVista service.

Possible configurations

Definition of the maximum size of fields in the log

To avoid creating log files that are too big, you can use different parameters to reduce the size of certain fields in the log.

Note: The -1 value means that there is no limit to the size of the field.

Logged field Description Suggested maximum size
Log_Input_Maxsize Maximum size of the Input field that contains all instructions sent to the server.

Note: If the size of the Input field is not restricted, you can restrict the size of the ReceivedQuery field because the query will be loaded to the Input field.

 100
Log_Output_Maxsize 100 - Recommended value: 500
Log_BindedSQL_Maxsize 100
Log_QuerySentToSGBD -1 - You can keep this value or you can choose not to restrict the size of the ReceivedQuery field.
Log_ReceivedQuery_Maxsize 100

Definition of thresholds for warning probes

You can define thresholds for warning probes. These indicate the maximum values exceeding which warnings will be logged in the probe log file.

Parameter Description Suggested value
warning_exec_time Used to log warnings for interface functions. 3000
warning_query_time Used to log warnings for queries. 3000
warning_Critical_Enter Used to log the time required for entering a critical section. 50000
warning_Critical_Process Used to log the time spent in the critical section. 50000

Procedures

How to configure log files for a EasyVista

 service

Step 1: Open the configuration file of the EasyVista service

1. Go to the configuration file folder.

2. Open the INI file of the EasyVista service.

example  smoServer.ini

 

Step 2: Specify and configure the probes to be enabled

1. Specify the list of probes to be enabled in the Log_Type parameter.

  • You should separate each probe using the | character.

example  Log_Type= ltWarning  |  ltException |  ltIntegration  |  ltMail

2. (optional) Specify the maximum size of fields in the log file. Open url.png See the description.

  • Indicate the maximum number of characters in the field. 
  • Leave the -1 value to indicate that there is no limit to the size of the field.

3. (optional) Define the thresholds for warning probes. Open url.png See the description.
 

Step 3: Enable the probes for the EasyVista service

1. Save the INI file.

2. Restart the EasyVista services.

Order in which EasyVista services should be stopped and restarted

StopRestartEasyVistaServices

   Only for On-premises customers. SaaS-based customers must create a change request using MyEasyVista.com to ask the EasyVista CMC team to restart the services.

  • When stopping services:
    • net stop SmoScheduler
    • net stop SmoASTPlugin
    • net stop SmoPrintServer
    • net stop SmoMonitoring
    • net stop EasyvistaKernel
    • net stop EasyvistaServer
    • net stop SmoServer
    • net stop SmoBroker
  • When restarting services:
    • net start SmoBroker
    • net start SmoServer
    • net start EasyvistaServer
    • net start EasyvistaKernel
    • net start SmoMonitoring
    • net start SmoPrintServer
    • net start SmoASTPlugin
    • net start SmoScheduler
EndStopRestartEasyVistaServices

 

Tags:
Powered by XWiki © EasyVista 2022