OMS logs

2024-12-16 07:21:30  Updated

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 on 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
common-default.log INFO, WARNING, and ERROR logs.
common-error.log ERROR logs. If OMS returns an error, search for the error time in this log file and locate the error causes.
oms-scheduler.log Background scheduling logs.
oms-step.log Step execution logs of migration and synchronization projects.
oms-api.log External API call logs.
database.log Database call logs.
oms-web.log External console access logs, including the URL, request path, execution time, and API response.
oms-alarm.log Alert-related logs.
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 using the ERROR keyword to obtain the causes of the error.

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
service.log Service logs of the CM component. The causes and stack information are provided in this log file. Check this log file first when you troubleshoot the issues.
cm-web.log Network logs of the CM component, including the APIs and request parameters used by other components such as the OMS console and Supervisor to access the CM component, the result, and the time.
dao-digest.log Logs of data access objects. Each row indicates a DML operation performed on the OMS MetaDB. The last digit indicates the execution time of the DML operation. If the execution time exceeds 60 ms, an exception may have occurred in the MetaDB.
logs.log Controller logs.

Logs of the store component

Logs of the store component are stored in /home/ds/store/{storeport}/log by default. You can view the logs of the store component in the OMS console. Perform the following steps:

  1. Log on to the OMS console.

  2. In the left-side navigation pane, click Data Synchronization.

  3. On the Data Synchronization page, click the name of the target data synchronization project to go to its details page.

  4. 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.

    You can log on to the OMS console and view the logs of the store component in either of the following ways:

    • Go to the View Component Monitoring page. Click the More icon in the Actions column of the target component and choose View Logs from the drop-down list.

    • Choose OPS & Monitoring > Component > Store. On the page that appears, click the More icon in the Actions column of the target store and choose View Logs from the drop-down list.

The following table describes the different types of logs of the store component.

Log type Description
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.
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 subTopic and subId parameters in the conf/crawler.conf configuration file, in the ${subTopic}.${subId} format.
liboblog.log This log file records the pulling and parsing logs generated after OceanBase Reader is started. You can check this log file when you locate issues related to OceanBase Reader.
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.

Logs of the connector component

Logs of the connector component are stored in /home/ds/run/{connectorName}/log by default. You can view the logs of the connector component in the OMS console. Perform the following steps:

  1. Log on to the OMS console.

  2. In the left-side navigation pane, click Data Synchronization.

  3. On the Data Synchronization page, click the name of the target data synchronization project to go to its details page.

  4. Click View Component Monitoring in the upper-right corner to view the ID of the corresponding connector.

    You can log on to the OMS console and view the logs of the connector component in either of the following ways:

    • Go to the View Component Monitoring page. Click the More icon in the Actions column of the target component and choose View Logs from the drop-down list.

    • Choose OPS & Monitoring > Component > Connector. On the page that appears, click the More icon in the Actions column of the target connector and choose View Logs from the drop-down list.

The following table describes the different log types of the connector component.

Log type Description
connector.log Info logs at the framework layer.
error.log Error logs at the framework layer.
metrics-xxx.log Metric logs.
plugin-connector.log Info logs at the component layer.
plugin-error.log Error logs at the component layer.
msg/connector_source_msg.log Messages indicating that data is successfully read from the source database.
msg/connector_sink_msg.log Messages indicating that data is successfully written to the destination database.
msg/connector_msg.log Heartbeat messages.

Logs of the JDBCWriter component

Logs of the JDBCWriter component are stored in /home/ds/run/{jdbcwriterName}/log. You can view the logs of the JDBCWriter component in the OMS console. Perform the following steps:

  1. Log on to the OMS console.

  2. In the left-side navigation pane, click Data Migration.

  3. On the Data Migration page, click the name of the target data migration project to go to its details page.

  4. Click View Component Monitoring in the upper-right corner to view the ID of the corresponding JDBCWriter component.

    You can log on to the OMS console and view the logs of the JDBCWriter component in either of the following ways:

    • Go to the View Component Monitoring page. Click the More icon in the Actions column of the target component and choose View Logs from the drop-down list.

    • Choose OPS & Monitoring > Component > JDBCWriter. On the page that appears, click the More icon in the Actions column of the target component and choose View Logs from the drop-down list.

The following table describes the different types of logs of the JDBCWriter component.

Log type Description
Link ID in the root directory of the link.out Project startup logs.
logs/plugin-connector.log Logs printed in third-party JAR packages.
logs/msg/sql_msg.log Slow DML statements whose execution time is longer than 15 ms.
logs/msg/ddl_msg.log Received DDL statements, including DDL statements before and after etransfer and DDL statements for compensation (to add special columns and indexes).
logs/msg/metrics.log. Metric logs.
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.
logs/error.log Error logs of the project.
logs/warn.log Alert logs of the project, including logs generated in etransfer, un-updated data content in case of primary key conflicts, and prompts for large transaction splitting.
*logs/jdbc-connector.log Configuration parameters of the project.
*logs/plugin-error.log Error logs in third-party JAR packages.

Logs of the checker component

Checker logs are stored in /home/ds/run/{checkerName}/log. You can view the logs of the checker component in the OMS console. Perform the following steps:

  1. Log on to the OMS console.

  2. In the left-side navigation pane, click Data Migration.

  3. On the Data Migration page, click the name of the target data migration project to go to its details page.

  4. Click View Component Monitoring in the upper-right corner to view the ID of the corresponding checker.

    You can log on to the OMS console and view the logs of the checker component in either of the following ways:

    • Go to the View Component Monitoring page. Click the More icon in the Actions column of the target component and choose View Logs from the drop-down list.

    • Choose OPS & Monitoring > Component > Checker. On the page that appears, click the More icon in the Actions column of the target checker and choose View Logs from the drop-down list.

The following table describes the different log types of the checker component.

Log type Description
error.log Error logs of the project.
metrics.log Metric logs of the project.
task.log Runtime logs of the project.

Critical 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 script correction file:

/home/ds/run/{taskname}/[migrate|verify]/{subid}/{schema}/sql/{tablename}.sql

Contact Us