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

    oracle

    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.

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.

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

Application of AWS RDS CloudWatch​

It is the description of the agent configuration using the AWS CloudWatch. If collection is started, the data is input in metrics and can be seen in the db_oracle_counter category under Management > Metrics Chart as well as the other metrics.

  • aws_region String

    Set the AWS region.

  • aws_arn String

    You can use the ARN of an IAM ROLE with appropriate roles for AWS authentication.

    Required role

    For the roles, the following policies are required.

    RoleRole details
    rds:DescribeDBInstancesCollection of the instance class data
    rds:DescribeDBClustersCollection of cluster data when using the autoscale
    rds:DescribeDBLogFilesCollection of CloudWatch logs
    rds:DownloadDBLogFilePortionCollection of CloudWatch logs
    ec2:DescribeInstanceTypesCollection of CPU counts for each instance class
    elasticache:DescribeCacheClustersCollection of instance class data when using the elasticache
    cloudwatch:ListMetricsCollection of the list of CloudWatch metrics
    cloudwatch:GetMetricStatisticsCollection of the values of the CloudWatch metrics
    logs:DescribeLogStreamsCollection of CloudWatch logs (in case of using the posted logs)
    logs:GetLogEventsCollection of CloudWatch logs (in case of using the posted logs)

  • cloud_watch String

    Set whether or not to use the CloudWatch Monitoring. The value is on or off.

  • cloud_watch_instance String

    Set the instance name of the CloudWatch.

  • cloud_watch_interval Second

    Set the interval to get monitoring values by CloudWatch (unit: second).

  • cloud_watch_metrics String

    Set the monitoring metric name to be imported into the CloudWatch. You can set it as follows:

    cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput

Example of configuration for RDS CloudWatch collection​

You must create the following default settings to monitor the RDS CloudWatch and collect the related data.

whatap.conf
cloud_watch=on
aws_region=ap-northeast-2

# Create roles in AWS IAM and then copy and paste the role ARN value.
aws_arn=arn:aws:iam::999999999999:role/UpdateApp
cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput

#Example of the instance name
cloud_watch_instance=pg-rds
Note

  • For more information about the role ARN, see the following link.

  • For information on how to collect data after granting the RDS CloudWatch metric collection role to EC2 without using the IAM ROLE's ARN value, see the following.

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