The default directory for OMS logs is /home/admin/logs/. This topic describes the logs of different components of OceanBase Migration Service (OMS).
Note
To view OMS logs, you must log in to the server where OMS is deployed and then go to the container of OMS. Run the following command to go to the container where OMS is deployed:
docker exec -it <oms_container_name> bash
Logs of the console component
By default, logs of the console component are stored in /home/admin/logs/ghana/Ghana. The following table describes the different types of logs of the console component.
| Log type | Description | Log retention strategy |
|---|---|---|
common-default.log |
INFO, WARNING, and ERROR logs. |
Archived and compressed by day and retained for 15 days. |
common-error.log |
ERROR logs. If OMS returns an error, you can search for the error time in this log file and locate the error causes. |
Archived and compressed by day and retained for 15 days. |
oms-scheduler.log |
Background scheduling logs. | Archived and compressed by day and retained for 6 days. |
oms-step.log |
Step execution logs of migration and synchronization tasks. | Archived and compressed by day and retained for 6 days. |
oms-api.log |
External API call logs. | Archived and compressed by day and retained for 6 days. |
database.log |
Database call logs. | Archived and compressed by day and retained for 6 days. |
oms-web.log |
External console access logs, including the URL, request path, execution time, and API response. | Archived and compressed by day and retained for 6 days. |
oms-alarm.log |
Alert-related logs. | Archived and compressed by day and retained for 6 days. |
dbcat.log |
Logs of the schema migration component DBCat. When an error is returned for an SQL query, you can filter the DBCat logs by the ERROR keyword to obtain the causes of the error. |
Archived and compressed by day and retained for 3 days. |
oms-ha.log |
Logs related to high availability of services. | Archived and compressed by day and retained for 6 days. |
Logs of the CM component
By default, logs of the cluster manager (CM) component are stored in the /home/admin/logs/cm/log directory. The following table describes the different types of logs of the CM component.
| Log type | Description | Log retention strategy |
|---|---|---|
cm-scheduler.log |
Background scheduling logs. | Archived and compressed by hour. The latest 72 log files are retained. Log files that have not been modified for more than 3 days will be deleted. |
error-details.log |
Error details logs. | Archived and compressed by hour. The latest 72 log files are retained. Log files that have not been modified for more than 3 days will be deleted. |
meta-db.log |
Database call logs. | Archived and compressed by hour. The latest 72 log files are retained. Log files that have not been modified for more than 3 days will be deleted. |
service.log |
Service-layer execution logs. | Archived and compressed every 12 hours. The latest 14 log files are retained. Log files that have not been modified for more than 7 days will be deleted. |
common-error.log |
ERROR logs. If OMS returns an error, you can search for the error time in this log file and locate the error causes. |
Archived and compressed every 12 hours. The latest 14 log files are retained. Log files that have not been modified for more than 7 days will be deleted. |
common-default.log |
INFO, WARNING, and ERROR logs. | Archived and compressed every 12 hours. The latest 14 log files are retained. Log files that have not been modified for more than 7 days will be deleted. |
controller.log |
External API call logs. | Archived and compressed every 12 hours. The latest 14 log files are retained. Log files that have not been modified for more than 7 days will be deleted. |
cm-api.log |
HTTP request logs of Jetty. | Archived every 24 hours without compression and retained for 3 days. |
Logs of the Store component
Logs of the Store component are stored in /home/ds/store/store{storeport}/log by default. You can view the logs of the Store component in the OMS console. Perform the following steps:
Log in to the OMS console.
In the left-side navigation pane, click Data Synchronization.
On the Data Synchronization page, click the name of the target data synchronization task to go to its details page.
Click View Component Monitoring in the upper-right corner to view the ID of the corresponding store. You can find the port number in the component ID.
In the OMS console, you can view the logs of the Store component in the following ways:
Go to the View Component Monitoring page. Click View Logs in the Actions column of the target component.
Choose OPS & Monitoring > Component > Store. On the page that appears, click View Logs in the Actions column of the target store.
The following table describes the different types of logs of the Store component.
| Log type | Description | Log retention strategy |
|---|---|---|
store.log |
The standard output and standard error output of the Store component will be redirected to this log file. If you cannot find useful error information in other log files, you can check this log file. | Only one log file is retained without compression. |
congo.log |
This log file records the parameters used when a reader task (a transaction log capture task) is started on the Store component. MySQL Reader also records the binlog pulling and parsing logs in this log file. When you locate issues related to MySQL Reader, you can search for ERROR logs in this log file. If you cannot find useful information in this log file, you can check the meta.log file in the data directory. The name of the data directory of the Store component is a combination of the values of the subTopic and subId parameters in the conf/crawler.conf configuration file, in the ${subTopic}.${subId} format. |
Each log file is sized 256 MB. At most 12 log files (sized about 3 GB in total) are retained without compression. |
liboblog.log/libobcdc.log |
This log file records logs related to pulling and parsing after OceanBase Reader is started. When you locate issues related to OceanBase Reader, you check this log file. This log file is named liboblog.log in OceanBase Database V2.x and V3.x, and named libobcdc.log in OceanBase Database V4.x. |
Each log file is sized 256 MB. By default, 40 log files (sized about 10 GB in total) are retained without compression. |
connector.log |
This log file records the pulling and parsing logs generated after Oracle Reader, DB2 LUW Reader, and PostgreSQL Reader are started. When you locate issues related to the reader of the corresponding data source, you can check this log file. | Archived and compressed by hour. These logs are retained for at most 7 days, or at most 2 GB of these logs are retained. |
Logs of the Full-Import and Incr-Sync components
By default, logs of the Full-Import and Incr-Sync components are stored in the /home/ds/run/{name}/logs directory. You can also view the logs of the Full-Import and Incr-Sync components in the OMS console. Perform the following steps:
Log in to the OMS console.
In the left-side navigation pane, click Data Migration.
On the Data Migration page, click the name of the target data migration task to go to its details page.
Click View Component Monitoring in the upper-right corner and view the ID of the Full-Import or Incr-Sync component.
In the OMS console, you can view the logs of the Full-Import and Incr-Sync components in the following ways:
Go to the View Component Monitoring page. Click View Logs in the Actions column of the target component.
Choose OPS & Monitoring > Component > Full-Import/Incr-Sync. On the page that appears, click the More icon in the Actions column of the target Full-Import or Incr-Sync component and select View Logs from the drop-down list.
The following table describes the different types of logs of the Full-Import and Incr-Sync components.
| Log type | Description | Log retention strategy |
|---|---|---|
Link ID in the root directory of the link.out |
Task startup logs. | Retained permanently without being archived. |
logs/connector.log |
Info-level logs generated when the component is running. | Archived and compressed by hour and retained for 7 days. |
logs/error.log |
Error logs of the task generated when the component is running. | Archived and compressed by hour and retained for 7 days. |
logs/trace.log |
Trace logs collected during batch execution of multiple records. | Archived and compressed by hour and retained for 7 days. |
logs/msg/connector_filter_msg.log |
Messages filtered by extract-transform-load (ETL). | Archived and compressed by hour and retained for 7 days. |
logs/msg/connector_sink_msg.log |
Messages indicating that data is successfully written to the target database. | Archived and compressed by hour and retained for 7 days. |
logs/msg/connector_source_msg.log |
Messages indicating that data is successfully read from the source database. | Archived and compressed by hour and retained for 7 days. |
logs/msg/ddl_msg.log |
All DDL operations. | Archived and compressed by hour and retained for 7 days. |
logs/msg/metrics.log |
Metrics. | Archived and compressed by day and retained for 7 days. |
logs/msg/sql_msg.log |
Slow DML statements whose execution time exceeds 15 ms. | Archived and compressed by hour and retained for 7 days. |
logs/msg/manual_table.log |
Logs of tables to which special columns and indexes are added. Before reverse migration, you must delete the special columns and indexes from the tables. | Retained permanently without being archived. |
Logs of the Full-Verification component
The logs of the Full-Verification component are stored in the /home/ds/run/{name}/logs directory. You can also view the logs of the Full-Verification component in the OMS console. Perform the following steps:
Log in to the OMS console.
In the left-side navigation pane, click Data Validation.
On the Data Validation page, click the name of the target data verification task to go to its details page.
Click View Component Monitoring in the upper-right corner and view the ID of the corresponding Full-Verification component.
In the OMS console, you can view the logs of the Full-Verification component in the following ways:
Go to the View Component Monitoring page. Click View Logs in the Actions column of the target component.
Choose OPS & Monitoring > Component > Full-Verification. On the page that appears, click View Logs in the Actions column of the target Full-Verification component.
The following table describes the different types of logs of the Full-Verification component.
| Log type | Description | Log retention strategy |
|---|---|---|
error.log |
Error logs of the task. | Archived and compressed by hour and retained for 72 hours. |
metrics.log |
Metric logs of the task. | Archived and compressed by day and retained for 7 days. |
task.log |
Runtime logs of the task. | Archived and compressed by hour and retained for 72 hours. |
warn.log |
Warn logs of the task. | Archived and compressed by hour and retained for 72 hours. |
inmode.log |
Results of verifying whether the IN mode is used for tables. | Archived and compressed by hour and retained for 72 hours. |
sql_msg.log |
SQL execution logs of the task. | Archived and compressed by hour and retained for 168 hours. |
Important log files:
Note
In the following log paths, {subid} corresponds to task.subId that is automatically passed in by OMS.
/home/ds/run/{taskname}/[migrate|verify]/{subid}/heartbeat/home/ds/run/{taskname}/[migrate|verify]/{subid}/overview-running/home/ds/run/{taskname}/[migrate|verify]/{subid}/overview-done/home/ds/run/{taskname}/[migrate|verify]/{subid}/overview-failed
Verification result file:
/home/ds/run/{taskname}/[migrate|verify]/{subid}/{schema}/diff/{tablename}.diff
SQL correction file:
/home/ds/run/{taskname}/[migrate|verify]/{subid}/{schema}/sql/{tablename}.sql
Logs of the Incr-Verification component
The Incr-Verification component logs are stored in the /home/ds/run/{name}/logs directory. You can also view the Incr-Verification component logs in the OMS console. To do so, follow these steps:
Log in to the OMS console.
In the left-side navigation pane, click Data Validation.
On the Data Validation page, click the name of the target data verification task to go to the details page.
Click View Component Monitoring in the upper-right corner to view the corresponding Incr-Verification component ID.
You can view the Incr-Verification component logs in the OMS console in the following two ways:
On the View Component Monitoring page, click View Logs next to the target component.
On the OPS & Monitoring > Component > Incr-Verification page, click View Logs next to the target Incr-Verification component.
The following table describes the Incr-Verification component logs.
| Log type | Description | Retention strategy |
|---|---|---|
error.log |
The error logs of the task. | Compress the logs archived by hour and retain them for 72 hours. |
metrics.log |
The monitoring metrics of the task. | Compress the logs archived by day and retain them for 7 days. |
task.log |
The running logs of the task. | Compress the logs archived by hour and retain them for 72 hours. |
warn.log |
The warning logs of the task. | Compress the logs archived by hour and retain them for 72 hours. |
inmode.log |
The result log of whether the table uses Inmode. | Compress the logs archived by hour and retain them for 72 hours. |
sql_msg.log |
The SQL statements executed by the task. | Compress the logs archived by hour and retain them for 168 hours. |
incr_trace.log |
The incremental records received by the task. | Compress the logs archived by hour and retain them for 72 hours. |
Logs of the Supervisor component
Locate Supervisor logs based on the logging.path option in the drc.properties file in the /home/ds/supervisor/config directory. In OMS Enterprise Edition, the logs of the Supervisor component are usually stored in the /home/admin/logs/supervisor/ directory.
The following table describes the different types of logs of the Supervisor component.
| Log type | Description | Log retention strategy |
|---|---|---|
error.log |
All error logs. | Archived by day without compression and retained for 7 days. |
legacy.log |
Logs about the API operations by the OMS console and Agent on the CM component, including the API name, request parameters, result, and time . | Archived by day without compression and retained for 7 days. |
routine.log |
Logs related to scheduled tasks in the Supervisor component, including:
|
Archived by day without compression and retained for 7 days. |
supervisor.log |
All logs of the Supervisor component. | Archived by day without compression and retained for 7 days. |