The following table describes the parameters of the binlog service in the local file conf/conf.json.
Note
For parameters whose values are inconsistent in conf/conf.json and config_template, the values in config_template prevail.
| Parameter | Default value | Description |
|---|---|---|
| service_port | 2983 | The service listening port. |
| max_packet_bytes | 67108864 | The maximum number of bytes allowed for a data packet. |
| record_queue_size | 20000 | The size of the data sending queue. |
| read_timeout_us | 2000000 | The waiting period of each batch of data reading queues. Unit: microseconds. |
| read_fail_interval_us | 1000000 | The waiting period for retrying each data reading queue. Unit: microseconds. |
| read_wait_num | 20000 | The number of data reading queues in a waiting batch. |
| send_timeout_us | 2000000 | The timeout period for sending a packet. Unit: microseconds. |
| send_fail_interval_us | 1000000 | The waiting period for the retry of a failed packet-sending task. Unit: microseconds. |
| command_timeout_s | 10 | The timeout period of command execution. Unit: microseconds. |
| log_quota_size_mb | 5120 | The maximum size of all log files. Unit: MB. |
| log_quota_day | 7 | The maximum log file retention period. Unit: days. |
| log_gc_interval_s | 43200 | The interval for purging log files. Unit: seconds. |
| log_level | 2 | The log level. Valid values in ascending order: 0 (TRACE), 1 (DEBUG), 2 (INFO), 3 (WARN), 4 (ERROR), and 5 (CRITICAL). |
| log_flush_strategy | 1 | The log flushing strategy. Valid values: 1 (flushing by log level) and 0 (flushing by time interval). |
| log_flush_level | 2 | The log flushing level. |
| log_flush_period_s | 1 | The interval for log flushing. Unit: seconds. |
| log_max_file_size_mb | 1024 | The maximum size of the logproxy.log file of the main process before log rotation. Unit: MB. |
| log_retention_h | 360 | The retention period of the logproxy.log file of the main process. Unit: hours. |
| allow_all_tenant | true | Specifies whether to allow subscription to all tenants. |
| ob_sys_username | "" | The username of a user in the sys tenant in ciphertext. |
| ob_sys_password | "" | The password of the user in the sys tenant in ciphertext. |
| counter_interval_s | 2 | The counting cycle of the counter. Unit: seconds. |
| metric_enable | true | Specifies whether to enable collection of metric data, such as the consumption of CPU, memory, and network resources. |
| metric_interval_s | 10 | The interval for metric data collection. |
| prometheus_port | 2984 | The listening port of Prometheus. |
| debug | false | Specifies whether to print debugging information. |
| verbose | false | Specifies whether to print details. |
| verbose_packet | false | Specifies whether to print packet details. |
| verbose_record_read | false | Specifies whether to print record reading details. |
| count_record | false | Specifies whether to count the number of records. |
| binlog_log_bin_basename | ./run | The default path where the generated binlog files are stored. |
| binlog_obcdc_ce_path_template | ../../obcdc/obcdc-ce-%s.x-access/libobcdcaccess.so | The path of the obcdc library that the community edition binlog service depends on. |
| binlog_obcdc_path_template | ../../obcdc/obcdc-%s.x-access/libobcdcaccess.so | The path of the obcdc library that the enterprise edition binlog service depends on. |
| binlog_ignore_unsupported_event | true | Specifies whether to ignore events that do not support conversion. |
| binlog_max_event_buffer_bytes | 67108864 | The buffer size for binlog event conversion. |
| binlog_mode | false | Specifies whether to enable the binlog mode. |
| binlog_nof_work_threads | 16 | The size of the thread pool for requests that are not scheduled by the binlog converter (BC), such as the SHOW BINARY LOGS statement to view the list of binlog files. |
| binlog_bc_work_threads | 2 | The size of the thread pool for requests that are scheduled by the BC. |
| binlog_max_file_size_bytes | 536870912 | The maximum size of a single binlog file. |
| binlog_convert_timeout_us | 10000 | The timeout period for binlog conversion. Unit: microseconds. |
| binlog_checksum | true | Specifies whether to enable the binlog checksum. |
| binlog_heartbeat_interval_us | 1000000 | The interval for sending binlog heartbeat events. Unit: microseconds. |
| binlog_gtid_display | true | Specifies whether to display the GTID information. |
| binlog_ddl_convert | true | Specifies whether to enable DDL statement conversion. If this parameter is set to true, the extended syntax of OceanBase Database is discarded. |
| binlog_ddl_convert_ignore_unsupported_ddl | true | Specifies whether to ignore DDL statements that do not support conversion. |
| binlog_memory_limit | 3G | The binlog memory limit. Default value: 3G. |
| binlog_working_mode | storage | The binlog working mode, which corresponds to the working_mode parameter in obcdc. Default value: storage. |
| binlog_recover_backup | true | Specifies whether to enable binlog backup and restore. |
| start_tcp_port | 8100 | The start value of the port occupied by the binlog instance. |
| reserved_ports_num | 256 | The number of reserved ports. |
| gtid_seq_compressed_interval_s | 256 | The compression interval of the GTID sequence. Unit: seconds. |
| gtid_seq_compressed_trx_size | 100000 | The transaction size in the GTID sequence. |
| gtid_inspector_s | true | The inspection interval for GTID consistency. |
| database_ip | The IP address of the MetaDB. | |
| database_port | The port number of the MetaDB. | |
| database_name | The name of the MetaDB. | |
| user | The username for accessing the MetaDB. | |
| password | The password for accessing the MetaDB. | |
| node_ip | The IP address of the OBServer node. | |
| enable_resource_check | true | Specifies whether to enable resource check. |
| node_cpu_limit_threshold_percent | 80 | The threshold of CPU utilization. |
| node_mem_limit_threshold_percent | 85 | The threshold of memory usage. |
| node_disk_limit_threshold_percent | 70 | The threshold of disk usage. |
| recovery_point_strategy | fast | The restore strategy used when a binlog instance fails over to a different binlog server node. |
| enable_dumper_interception | false | Specifies whether to enable subscription interception. |
| max_dumper_num | 128 | The maximum number of subscriptions for a binlog instance. |
| database_properties | The properties used to initialize MariaDB. | |
| max_instance_startup_wait_sec | 60 | The maximum time to wait before a binlog instance is created. Unit: seconds. |
| min_pool_size | 30 | The minimum number of connections in the connection pool of the MetaDB. |
| max_pool_size | 1000 | The maximum number of connections in the connection pool of the MetaDB. |