Log Files Description


Log files are text files that trace Logo - EasyVista.png activity events on servers in chronological order using probes. They help you understand the origin of errors when bugs occur and identify performance issues.

  • You can define the probes you want to enable and their configuration in an INI configuration file for each application.
  • One log file will be generated for each active probe.

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 application performance. The size of the log file can also increase significantly. This is why we recommend that you avoid using the probes indicated below in red in the production database.

Generated log files

Probe log files

  • These files are automatically created once you enable the probe.
  • The daily values of the probe 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 = <nomApplication><nomSonde>_<dateYYMMJJ>.xml
               Example documentation icon EN.png  SMO_MSSQLException_190125.xml, SMO_MSSQLException_190124.xml, SMO_MSSQLException_190123.xml
    • One XSL file is generated for each application. This provides an overview of all XML files.
               Example documentation icon EN.png  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 the probe log file

All log files contain the main information below.

  • Error code
  • Platform
  • SMO Server function (InterfaceName)
  • Host: Server hosting the SMO Server
  • Remote: Machine submitting the call, e.g. PHP server.
  • Database versions
  • Input: All information and parameters passed to the SMO Server 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 the different probes

  • ltInterface: Used to log all calls from the PHP to the SMO Server.
    • Caution: This probe can have an adverse effect on application performance. We recommend that you avoid using it in a production database.
  • ltApplication: Used to log initialization functions and all calls.
    For the SMO Server:
    • This includes calls from the broker and other modules (in the SMO Server, except for workflows, the sending of emails, etc.). 
    • This does not include calls from the PHP. 
    • Caution: This probe can have an adverse effect on application performance. We recommend that you avoid using it in a production database.
  • ltWarning: Used to log SMO Server functions and queries that require a lot of time to run.
    • 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 problems that occur when sending emails.
  • ltScheduler (Note: Used only when the scheduler is enabled on the SMO Server): Used to log all scheduler activities.
  • ltAuthentication: Used to log all connections to the SMO Server, i.e. login, account, authentication method, results, etc.

Enabling probes

  • The Log_Type parameter in the INI configuration file displays the list of probes to be enabled.
    • Syntax: Probes to be enabled must be separated using the | character.
                 Example documentation icon EN.png
      • Log_Type= ltWarning  |  ltException |  ltIntegration  |  ltMail
      • Log_Type= lt_all
       
    • The ltAll value will enable all probes.
      Caution: This value can have an adverse effect on application performance. We recommend that you avoid using it in a production database.
  • You can define a list of probes for each of the applications, e.g. smoBroker, smoServer, smoMail, etc.

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.

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

  • Log_Input_Maxsize: Maximum size of the Input field that contains all instructions sent to the server. Suggested value: 100.
    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.
  • Log_Output_Maxsize: Suggested value: 100. Recommended value: 500.
  • Log_BindedSQL_Maxsize: Suggested value: 100.
  • Log_QuerySentToSGBD: Suggested value: -1 . You can keep this value or you can choose not to restrict the size of the ReceivedQuery field. 
  • Log_ReceivedQuery_Maxsize: Suggested value: 100.

Definition of thresholds for warning probes

You can define thresholds for warning probes by specifying the maximum values exceeding which warnings should be logged.

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

Procedure: How to configure log files for an application

1. Open the configuration file of the application.

           Example documentation icon EN.png  smoServer.ini

2. Specify the list of probes to be enabled in the Log_Type parameter. Each probe must be separated using the | character.

           Example documentation icon EN.png  Log_Type= ltWarning  |  ltException |  ltIntegration  |  ltMail

3. (optional) Define the maximum size of the fields in the log. Open url.png See the description.

  • Specify 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.

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

5. Save the file.

6. Restart the services.

Tags:
Last modified by Unknown User on 2019/07/22 10:00
Created by Administrator XWiki on 2019/07/22 10:00

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020