Install and deploy oblogproxy by using the installation package

You can deploy oblogproxy by using the installation package or using the source code. This topic describes how to deploy oblogproxy by using the installation package.

Background information

oblogproxy is a proxy service for managing incremental logs of OceanBase Database. It is a part of OceanBase Migration Service (OMS). Designed based on obcdc, oblogproxy provides links for applications to access and manage real-time incremental logs of OceanBase Database.

oblogproxy allows you to subscribe to incremental logs in isolated networks and supports multiple access methods. You can perform the following steps to configure and use oblogproxy.

Install oblogproxy

Download and install oblogproxy

You can download the package of oblogproxy V1.1.0 from the GitHub open-source community.

Decompress the package to the installation directory, which is /usr/local in this example.

Run the following command to decompress the package:

tar -zxf oblogproxy-ce-for-4x-xxxx.tar.gz -C /usr/local

After decompression, specify the temporary environment variables.

• Specify the path for running logproxy.

  export PATH=$PATH:/usr/local/oblogproxy/bin
  

• Specify the dependency path.

  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/oblogproxy/liboblog
  

Configure the sys tenant

For security, you must specify the username and password of a user for oblogproxy. Only a user in the sys tenant of OceanBase Database can be connected.

sh run.sh config_sys sys_user sys_pwd

where

• sys_user specifies the username.
• sys_pwd specifies the user password.

Here is an example:

sh run.sh config_sys sys passwd

Run oblogproxy

Go to the oblogproxy directory.

cd /usr/local/oblogproxy

Run the following command to start the service:

./run.sh start

By default, the 2983 port is listened to. You can set the service_port field in the conf.json file to change the port. The service logs of oblogproxy are stored in the logs/ directory. The service logs of the LogReader thread are stored in the run/{client-id}/logs/ directory.

Use oblogclient for data subscription

You can use oblogclient to subscribe to data from OceanBase Database. Make sure that you have installed Maven dependencies before use.

<dependency>
  <groupId>com.oceanbase.logclient</groupId>
  <artifactId>logproxy-client</artifactId>
  <version>1.0.7</version>
</dependency>

After that, you can configure the oblogclient by referencing the following sample code:

ObReaderConfig config = new ObReaderConfig();
// Specify the IP addresses of OceanBase root servers and separate multiple IP addresses with semicolons (;) in the following format: ip1:rpc_port1:sql_port1;ip2:rpc_port2:sql_port2
config.setRsList("xxx.xxx.xxx.1:2882:2881;xxx.xxx.xxx.2:2882:2881");
// Specify the username and password (user tenant).
config.setUsername("r***");
config.setPassword("****");
// Specify the UNIX start timestamp in seconds. A value of 0 specifies to start the client from the current time.
config.setStartTimestamp(0L);
// Specify the subscription allowlist in the tenant.db.table format. Use asterisks (*) as wildcards.
config.setTableWhiteList("sys.*.*");

// Specify the IP address of the server where oblogproxy is deployed to create the client instance.
LogProxyClient client = new LogProxyClient("xxx.xxx.xxx.1", 2983, config);
// Add the RecordListener.
client.addListener(new RecordListener() {
    @Override
    public void notify(LogMessage message){
        // Process the message.
    }

    @Override
    public void onException(LogProxyClientException e) {
        // Handle the error.
        if (e.needStop()) {
            // Stop the client when an unrecoverable exception occurs.
            client.stop();
        }
    }
});

// Start the client.
client.start();
client.join();

More information

For more information about oblogclient, see oblogclient.