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

    Caution

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

  • db String

    Set the name of the database to be monitored.

  • db_ip String

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

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 default BROKER_PORT: 33000)

  • cms_port Int

    Default 8001

    This port is used by CUBRID Manager. In the CUBRID Manager configuration file (cm.conf), enter the value defined in cm_port. It is necessary to fetch monitoring information through the API of CUBRID Manager.

  • cms_token_file String

    If there are multiple DBs created by the user, WhaTap agents must have been installed and set as many as the number of DBs. In this case, the cms_token_file path is required to share tokens between agents. Set 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​

  • long_run_session_sec Second

    Default 10

    The session running longer than the set time is treated as the long run session (unit: second).

  • tables_hour Int

    Default 5

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

  • tables_min_row Int

    Default 10000

    When collecting the table information, table data with the number of rows smaller than the set value is not collected.

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.

Identifying the agent name​

Details

Agent Name Setting In the WhaTap monitoring service, the term, "object" is used for comprehensive meaning of a monitoring target, and it is sometimes used interchangeably with the agent. To distinguish the objects to be monitored, the different names must be used. WhaTap identifies the target through the object name and object ID.

Note
  • The object (agent) names must be unique on a project basis.
  • Object ID = CRC32 (object name). If the object ID or name has been changed, the previous data is not connected.

WhaTap basically uses the data collected from database servers to identify each server while collecting monitoring data. Basic information uses the database server as a unique identifier by a combination of database server type, IP address, service port, and such. If necessary, use the name set by the user or change the pattern to a unique value. The agent name must be unique.

The reason why the data extracted from the application server is used, is like the following. When a communication loss of the collection server and agent caused by the stop of the database server, network disconnection, or agent problem is restored, the continuity of the data from the reconnected agent is maintained.

  • object_name String

    Default {type}-{ip2}-{ip3}-{port}

    It is an agent naming (ONAME) scheme to identify database servers. An OID is created based on the ONAME.

    ConfigurationDescription
    {type}Use the value set in whatap.app_name.
    {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
    {hostname}Host name

  • auto_oname_enabled Boolean

    Default false

    The function to automatically obtain the agent name (oname) from the server is activated. Upon application, the options for -Dwhatap.name and -Dwhatap.oname are ignored. It obtains oname through communication with the collection server and then starts the agent's normal operation.

  • auto_oname_prefix String

    Default agent

    When an agent name is automatically granted from the server, the prefix of the agent name (business name as usual) is used. The prefix + serial number (from 1) is assigned.

  • auto_oname_reset Int

    Default 0

    Modify it to obtain a new agent name from the server. If the agent name is automatically granted, the system environment variable, whatap.oname is set. Once set, the system environment variables are not changed until the Java instance is restarted. For a reset, modify the value of auto_oname_reset. If you change it to a value different from the current setting, it is to be applied.