When you create an OBProxy cluster, you can specify the startup parameters in Parameter Settings. This topic describes the OBProxy startup parameters.
Startup parameters
The following table describes the startup parameters that you can specify when you create an OBProxy cluster. If you do not specify the parameters, the system uses the default values.
Parameter |
Default value |
Value range |
Description |
|---|---|---|---|
| app_name | dropship | - | The application name of the OBProxy service. |
| automatic_match_work_thread | true |
|
Specifies whether to automatically create worker threads based on the number of CPU cores. If you set the parameter to true, the maximum number of worker threads is determined by the work_thread_num parameter. |
| block_thread_num | 1 | [1, 4] | The number of OBProxy threads for blocking tasks. The parameter is used for thread initialization. |
| enable_cpu_topology | false |
|
Specifies whether to enable CPU affinity, which is a process in which each worker thread is associated with a different CPU core. |
| enable_metadb_used | false |
|
Specifies whether the MetaDB of OceanBase Cloud Platform (OCP) is accessible when OBProxy is running. |
| enable_strict_kernel_release | false |
|
Specifies whether the OS kernel must be verified. Valid values:
|
| frequent_accept | true |
|
Whether to initialize the net accept parameter. |
| grpc_client_num | 9 | [9,16] | The number of gRPC clients. |
| grpc_thread_num | 8 | [8,16] | The number of gRPC threads. |
| listen_port | 2883 | (1024, 65536) | The listening port of OBProxy. |
| local_bound_ip | 0.0.0.0 | - | The local IP address of OBProxy. |
| net_accept_threads | 2 | [0, 8] | The number of threads that run accept tasks. |
| obproxy_config_server_url | - | - | The URL for external users to access the OCP configurl service. |
| prometheus_cost_ms_unit | false |
|
Specifies whether to set the cost unit of Prometheus to milliseconds. By default, the cost unit is microseconds. |
| prometheus_listen_port | 2884 | (1024, 65536) | The listening port of OBProxy Prometheus. |
| proxy_id | 0 | [0,255] | The ID of the OBProxy. If the proxy_service_mode parameter is set to server, you cannot set the proxy_id parameter to 0. |
| proxy_service_mode | client |
|
The deployment and service mode of OBProxy. |
| rootservice_cluster_name | - | - | The default name of the cluster of the RootService list. |
| rootservice_list | xx.xx.xx.xx:2881 | - | The RootService list in the following format: ip1:sql_port1;ip2:sql_port2. |
| skip_proxy_sys_private_check | true |
|
Specifies whether to skip the check of private CIDR blocks for OBProxy. |
| stack_size | 1MB | [1MB, 10MB] | The size of the thread stack, which is used for thread creation. |
| enable_proxy_scramble | true |
|
Specifies whether to enable the challenge random number for OBProxy. |
| task_thread_num | 2 | [1, 4] | The number of task threads for OBProxy. |
| work_thread_num | 128 | [1, 128] | The number of worker threads for OBProxy. If the automatic_match_work_thread parameter is set to true, this parameter specifies the maximum number of worker threads. |
References
OBProxy parameters include startup parameters and other parameters.