Skip to main content

XOS agent configuration

To additionally monitor the resources of the database server, run a separate XOS agent process on the database server to collect data.

Note

It can be applied to only the OS environment running on the x86 architecture.

Configuring the whatap.conf file​

Set the following options in the whatap.conf file before running the XOS agent.

  • xos Int

    Default 0

    Set whether or not to use the XOS agent. If the value is 0 the XOS agent is not used for collection. Enter the value as 1 or IP address of the XOS agent. If the IP address is specified, data is collected from only the XOS agent.

  • xos_port String

    Default 3002

    Set the port to communicate with the XOS agent. XOS agent can be communicated via UDP. If you have set a firewall on that port, disable it for UDP communication.

  • xos_cpu_iowait Int

    Default 1

    Set whether the CPU utilization collected from the XOS agent is to include the iowait value. If the value is set to 1, the iowait value is included. If set to 0, the value is not included.

  • xos_mem_buffcache Int

    Default 0

    Set whether the memory utilization collected from the XOS agent is to include the buffcache value. If the value is set to 1, the buffcache value is included. If set to 0, the value is not included.

Configuring the xos.conf file​

Copy the xos directory to the database server, and then enter the agent server information and set additional options in the xos.conf file.

  • dbx_ip String

    Enter the IP address of the server in which the DBX agent has been installed.

  • dbx_port String

    Default 3002

    Set the port to communicate with the DBX agent. DBX agent can be communicated via UDP. If you have set a firewall on that port, disable it for UDP communication.

  • cpu_limit Int

    Default 0

    It collects the process data with a value greater than the set limit. If it is 1.23% (1/100% step), set it to 123.

  • mem_limit Int

    Default 10240

    It collects the process data with a value greater than the set limit. 10240 (Kbytes) indicates 10 MB.

  • disk_usage_interval Second

    Default 60

    It displays the disk utilization, free sizes, and total sizes for each instance. If the value is 0, the disk utilization is not collected.

  • process String

    You can monitor the running status of processes. Enter the process name as an option. You can register multiple items using comma (,) as the delimiter.

    xos.conf
    process={process_name}

    For example, to set the top and lock.sh processes to be monitored, set the options as follows:

    xos.conf
    process=top,lock.sh
    Note

    You can use the process option to send an alert when a process running in the database ends. For more information, see the following.

  • iplist_interval Second

    You can collect a list of IPs for your database servers. Set the time interval in seconds (at least 3 seconds) for collection.

  • file String

    To use the Log menus (Live Tail, Log Trend, Log Search, Log Setting), enter the absolute path in the file option for the log files to be monitored.

    xos.conf
    file=/var/log/mongodb/mongodb.log
Note
  • The file option is available in DBX Agent 1.7.0 or later.

  • For more information about the Log menus, see the following.

Running the XOS agent​

Run the following batch file on the database server.

$ ./start.sh

# or

$ ./startd.sh # When running in the background