Skip to main content

DBX Agent Setting

Write the settings for the DBX agent in the whatap.conf file. For the options that can be set, see the following.

Default options​

  • license String

    To install the agent, set the project access key granted from the server. The project access key includes the agent's project and the encryption key for secured communication.

  • whatap.server.host String

    Default 127.0.0.1,127.0.0.1

    Specify the IP address of the collection server to transfer the data collected by the agent. If there are multiple IP addresses for collection server redundancy, use comma (,) as the delimiter. The collection server proxy daemon must be serviced in the listening state for the set IP address.

  • whatap.server.port String

    Default 6600

    Set the port of the collection server. Because only one port can be set, use the same port set in the "whatap_server_host" option.

  • dbms String

    cubrid-v1

    Caution

    If other option values are entered, data collection for monitoring may not work.

  • db_ip String

    Set the IP address of the database server to be monitored.

  • db_port String

    Set the port used for DB communication.

CUBRID-dedicated options​

  • db_port Int

    Default 0

    Broker port information used for application connection information. Enter the value defined in BROKER_PORT in the broker configuration file (cubrid_broker.conf). (CUBRID's default value BROKER_PORT: 33000)

  • cms_port Int

    Default 8001

    Port used by CUBRID Manager. Enter the value defined in the cm_port field in the CUBRID Manager configuration file (cm.conf). It is required to obtain monitoring information through the CUBRID Manager API.

  • cms_token_file String

    If there are multiple user-created DBs, the WhaTap agent must be installed and set up for each database. In this case, the cms_token_file path is required to share tokens between agents. Set it to {Agent installation path}/cms_token.

    For example) If agent2 has been installed, set as follows to share the cms_token_file path of agent1.

    whtap.conf

    cms_token_file=/agent1/cms_token

  • broker String

    Default broker1, query_editor

    Once CUBRID has been installed, the broker runs as broker1 and query_editor by default. If you arbitrarily changed the name of the broker or started it additionally, enter the changes.

    Note

    The name to set with the broker option can be viewed by the cubrid broker status command.

Data collection​

  • db_param_enabled Boolean

    Default true

    It sets whether or not to collect the DB parameters.

  • conn_fail_count Int

    Default 15

    It sends a notification when the connection error occurs consecutively 15 times. You can adjust the notification trigger criteria by entering the desired number.

  • tables_hour Int

    Default 5

    Set the time to collect data for storing the table size information. The default value is 5 and collection starts at 5 am.

  • long_run_session_sec Second

    Default 10 (unit: second)

    A session that has been running longer than the set time is treated as a long run session.

  • replication_name String

    If you set the replication name, it is considered that there is a Master/Slave relationship between DBs with the same replication_name.

    As an option to define the replication set, if you set the replication_name option that has the same value for both master and slave nodes, the Monitoring a Database Instance displays a tree structure. It also provides a widget to monitor the replication status in Flex Board based on the option value.

  • skip_whatap_session Int

    Default 0

    If you set 1, the session in which the query to collect from WhaTap operates, does not appear in the active session list. (Default value: 0)

Applying the AES 256 encryption​

The WhaTap DBX agent transfers the collected data to the server after encryption. You can change this depending on the importance of the data or setting. Basically, the XOR operation and encryption through the AES algorithm are used, and encryption and decryption are performed by dividing the plain text into 128-bit units. It can be expanded up to 256 bits depending on the setting.

Add the following options to the whatap.conf file in the path where the WhaTap DBX agent has been installed.

whatap.conf
cypher_level=256

Add the settings and then restart the agent.

Agent name setting​

Automatic configuration​

If you do not set the agent name in the agent configuration (whatap.conf), the agent name is automatically determined by combining the IP address and the port number. For example, if the IP address is 10.11.12.13 and the port number is 3000, the agent name is set to DBX-12-13-3000.

The key variables that determine the agent name are as follows:

ConfigurationDescription
{type}The DBX value is used.
{ip0}The first byte of the IPv4 address is used. (e.g. 10 in 10.11.12.13)
{ip1}The second byte of the IPv4 address is used. (e.g. 11 in 10.11.12.13)
{ip2}The third byte of the IPv4 address is used. (e.g. 12 in 10.11.12.13)
{ip3}The fourth byte of the IPv4 address is used. (e.g. 13 in 10.11.12.13)
{port}Database server port
Note

If the IP address is not numeric like RDS, the name is set in the following format: DBX-{ip0}-{hash}-{port}, where the {hash} value is the IP address that has been converted to 4-digit hexadecimal number.

Manual configuration​

To set the agent name manually, enter a desired name for the whatap.name or object_name option in the whatap.conf file. The entered name is assigned to the agent name.

whatap.conf
whatap.name=agent-1234
# or
object_name=agent-1234