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

    mongodb

    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​

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

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

  • collections Boolean

    Default true

    Set whether or not to save the collection size information. If you do not want to save it, change it to false.

    Note

    For more information about the DB size menu associated with this option, see the following.

  • collections_hour Int

    Default 5

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

    Note

    For more information about the DB size menu associated with this option, see the following.

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_redis_counter category under Analysis > 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.

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.