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

    db2

    Caution

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

  • db String

    Database name.

  • db_ip String

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

  • db_port String

    Set the port used for DB communication.

Data collection​

  • db_param_enabled Boolean

    Default true

    It sets whether or not to collect the DB parameters.

  • connect_timeout Int

    Default 15 (seconds)

    If a collection query exceeds the specified time limit, data collection for the query is stopped.

  • db2_opt Int

    Default 0

    Set the active session's collection conditions.

    • 0: Only the sessions whose activity_state is EXECUTING are collected.

    • 1: The sessions whose activity_state is EXECUTING, RECEIVING, and SUSPENDED are all collected.

  • 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.

  • xview_min_sec Int

    Default 0

    When collecting xview, collection is performed only when the query execution time is longer than the set time. The default setting is to collect all queries whose execution time is longer than 0 seconds.

User Metric Collection (SQLMON)​

SQLMON periodically collects the results of user-defined SQL queries and stores them as metrics.
It is suitable for lightweight queries that return numeric results.

  • sqlmon Int

    Default value: 1

    • 1: Run both dbx and sqlmon simultaneously
    • 2: Run only sqlmon

Supported version: 2.3.5 or later

Configuration​

  1. Create a sqlmon directory under the dbx agent and create <filename>.sql files for the queries you want to collect.
dbx/
└── sqlmon/
    ├── active_sessions.sql
    └── lock_count.sql
  1. Save the query to be collected as a <filename>.sql file.

Write the execution options on the first line and the SQL statement from the second line onward.

Option format
interval(min);run_time;tag_name
SQL statement
ItemDescriptionExample
IntervalExecution interval in minutes, minimum 11 → runs every 1 minute
Run timeHHMM-HHMM format, multiple ranges separated by comma (,). Set 0 to run at all times0900-1100 → runs only 09:00–11:00
Tag nameTag name stored in metrics. If omitted, the file name is used as the tag namewhatap
Example: 1 min interval, 09:00–11:00, tag name whatap
1;0900-1100;whatap
SELECT count(*) FROM active_sessions
Example: 1 min interval, always running, file name as tag
1;0
SELECT count(*) FROM active_sessions
Note
  • Run time can span across dates. (e.g., 2300-0100 → 23:00 to 01:00 the next day)
  • When omitting the tag name, do not add a semicolon (;) after the run time.
  • Do not add a semicolon (;) at the end of the SQL statement.

  1. Enable SQLMON in whatap.conf.

  2. Restart the agent.

  3. In the Icon Sitemap > Metrics Search menu, check the sqlmon category.

# whatap.conf
sqlmon=1

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
Last updated on