CUBRID Log Files

The scope of this tutorial is to present some of the CUBRID built-in logging features. Logs related to restoring committed or uncommitted transactions when a system or media (disk) error occurs and neither the logs used to support the user-specified rollback(s) will be covered next time.

In this tutorial we will also show you how to use some of these logs from the CUBRID Manager, the default database administration tool for CUBRID.

Overview

There are 3 main types of CUBRID logs which are closely related to the CUBRID architecture:

• Broker logs
• CUBRID Manager logs
• Database logs

And based on the type of the operations recorded in the logs, we have separate logs for:

• Access
• Error
• Admin

This logs categorization is shown in the below image:

Let’s see now, for each log type, a brief description of what the log is intended for.

Broker Logs

• Access Log
  The access log file records information about client access in a file named broker_name.access.
• Error Log
  The error log file records information about the errors that occurred during the client's request processing.
• SQL Log
  The SQL log file records SQL statements requested by the application client.

CUBRID Manager Logs

• Access Log
  The access log files records information about the CUBRID Manager access. You can see in it user accounts, operation history, and the time when operations were performed.
• Error Log
  The error log file records information about errors that occurred while connecting in the CUBRID Manager.

Database/Server Logs

• Admin Log
  This admin log records information about errors occurred while server is running.

You can access all these logs from within the CUBRID Manager:

Or, you can access them directly in the CUBRID installation folder:

In the next sections of this tutorial, we will go into more details regarding each log type.

Broker Logs

There are three types of logs that relate to the CUBRID Broker:

• Access log
• Error log
• SQL log

Each log can be found in the log directory under the installation directory.

You can change the directory where these logs are maintained by changing the:

• LOG_DIR
• ERROR_LOG_DIR,

... parameters of the broker environment configuration file (cubrid_broker.conf).

Access Log

The access log records information about the application client and is saved with the name broker_name.access.

If the LOG_BACKUP parameter is configured to ON in the Broker environment configuration file, when the Broker stops properly, the access log file is saved with the date and time when the Broker has stopped. For example, if broker1 stopped at 12:27 P.M. on June 17, 2008, an access file named broker1.access.20080617.1227 is generated in the log/broker directory.

The following is an example and description of access log file content:

1 192.168.1.203 - - 972523031.298 972523032.058 2008/06/17 12:27:46~2008/06/17 12:27:47 7118 - -1
2 192.168.1.203 - - 972523052.778 972523052.815 2008/06/17 12:27:47~2008/06/17 12:27:47 7119 ERR 1025
1 192.168.1.203 - - 972523052.778 972523052.815 2008/06/17 12:27:49~2008/06/17 12:27:49 7118 - -1

Error Log

The error log file records information about errors that occurred during the client's request processing and is stored with the name broker_name_app_server_num.err.

The following is an example and description of error log content:

Time: 02/04/09 13:45:17.687 - SYNTAX ERROR *** ERROR CODE = -493, Tran = 1, EID = 38
Syntax: Unknown class "unknown_tbl". select * from unknown_tbl

SQL Log

The SQL log file records SQL statements requested by the application client and are stored with the name broker_name_app_server_num.sql.log.

The SQL log is generated in the log/broker/sql_log directory when the SQL_LOG parameter is set to ON. Note that the size of the SQL log file to be generated cannot exceed the value set for the SQL_LOG_MAX_SIZE parameter.

CUBRID provides the broker_log_top, broker_log_converter, and broker_log_runner utilities to manage SQL logs.

The following is an example and description of SQL log content:

02/04 13:45:17.687 (38) prepare 0 insert into unique_tbl values (1)
02/04 13:45:17.687 (38) prepare srv_h_id 1
02/04 13:45:17.687 (38) execute srv_h_id 1 insert into unique_tbl values (1)
02/04 13:45:17.687 (38) execute error:-670 tuple 0 time 0.000, EID = 39
02/04 13:45:17.687 (0) auto_rollback
02/04 13:45:17.687 (0) auto_rollback 0

The broker_log_top utility analyses the SQL logs which are generated for a specific period. As a result, the information of SQL statements and time execution are outputted in files by order of the longest execution time; the results of SQL statements are stored in log.top.q and those of execution time are stored in log.top.res, respectively.

The broker_log_top utility is useful to analyze long (in terms of execution time) queries.

The syntax is:

>broker_log_top [options] sql_log_file_list
options : {-t | -F  from_date | -T  to_date}

To store SQL logs created in log/broker/sql_log under the installation directory to a separate file, the broker_log_converter utility is executed.

The syntax of the broker_log_converter utility is:

>broker_log_converter  SQL_log_file  output_file

To re-execute queries saved in the query file which has been created by the broker_log_converter utility, the broker_log_runner utility can be used.

The syntax of the broker_log_runner utility

>broker_log_runner options input_file
options : -I cas_ip -P cas_port  -d dbname  [-u dbuser [-p dbpasswd ]]  [-t num_thread] [-r repeat_count] [ -o result_file]

CUBRID Manager Server Logs

CUBRID Manager Server-related logs are stored in the log/manager folder, under the CUBRID installation folder:

They are stored as one of the following four types of files, depending on the process of the Manager Server:

• cub_auto.access.log: Access log of a client that logged into and out of the Manager Server successfully.
• cub_auto.error.log: Access log of a client that failed to log into or out of the Manager Server.
• cub_js.access.log: Log of the jobs processed by the Manager Server:
  
• cub_js.error.log: Error log that occurred while the Manager Server is processing jobs.

Database/Server Logs

This admin log records information about errors that occurred while server is running. The format of output file is: <database_name>_<date>_<time>.err:

Logging-Related Parameters

The following are parameters related to logs used for database backup and restore. The type and the value range for each parameter is:

And here below is a summary presentation of each parameter meaning and usage:

Using Broker SQL Logs from CUBRID Manager Client

Remember: All the executed queries are stored in the log file when the SQL_LOG parameter of the Broker is ON – and you change this value easily from the CUBRID Manager client:

This broker log files can be viewed/analyzed/re-executed from CUBRID Manager client:

View Log

This function reads the SQL log stored in the selected file and displays 100 lines at a time. It also provides a function for selecting and copying a specific area of the log information.

Analyze Log

When Analyze Sql Log menu is selected, you can select which Broker's SQL log is to be analyzed:

• When the Transaction based analyze checkbox is selected, the log is analyzed for each transaction;
• Otherwise, they are analyzed for each query.

After selecting the SQL log file you want to analyze and then clicking OK, the results are displayed:

Execute Log

If you select Execute log, the Set Execution Information dialog box is displayed, in which you can configure the execution environment:

Log Property

By selecting the Log property menu, information about the selected log file is displayed:

See also

• CUBRID Tutorials
• CUBRID Manual
• CUBRID Manager Logs

Getting Help

This concludes the CUBRID Logs tutorial. If you have any questions related the CUBRID Log files, you can tweet to @cubrid or post your message on the CUBRID Forum.