Skip to main content

Configuration

You can take a look at the structure of the WhaTap agent, set additional functions through various options, and monitor the resources of the DB server to be monitored.

Agent structure​

The following displays the WhaTap agent's structure map.

Agent structure map

  • Collection server

    It collects and stores the database performance data collected by agents, extracts statistical data, and efficiently provides them to users. The collection server can be set by region. Different collection server addresses are allocated to each region. The collection server address may differ depending on the selected region. When creating a project, the region is also set.

  • DMX agent

    Query-based performance data is collected and transmitted to the server. Monitoring is possible through a separate agent server without installing agents directly on the database server to be monitored.

  • Network: The WhaTap monitoring agent uses the external communication (TCP) port 6600 to transfer the collected monitoring data to the WhaTap collection server.

Default agent settings​

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.

  • ipckey String

    It can be obtained through the ipcs -m command. This is the key value (hexadecimal) of the Oracle to be monitored.

    Note

    The ipcs command provides information about inter-process communication (IPC). The -m option queries shared memory resources.

  • rac String RAC

    This option sets the group name of the instances grouped in Oracle's Real Application Clusters (RAC). This option allows you to change complex RAC cluster group names to concise and easy ones to identify. The RAC cluster group name set using this option can be checked on the WhaTap Monitoring Service screen.

    For example, if the RAC cluster group name is too long, such as 'my_long_rac_cluster_group_name', you can set a concise name as follows:

    whatap.conf
    rac=my_rac_cluster_group

    It is displayed as 'my_rac_cluster_group' in the WhaTap Monitoring Service, allowing users to quickly identify and monitor the RAC cluster group.

Database data collection options​

  • xos Boolean

    Default true

    This option enables the XOS agent (xos.conf) to additionally monitor the resources of the database server.

  • interval Int

    Default 3

    It sets the data collection cycle in seconds.

    Note

    Oracle Pro monitoring can collect data almost in real time through memory access, but Active session, stat, and event metrics are collected in queries.

  • stat String

    It enables collecting statistics-related metrics. Write the name of the metric to collect by referencing the NAME column such as v$sysstat, and v$statname. You can collect additional metrics along with the basic metrics by writing them in a way like stat+=. You can enter multiple items using the comma (,) as the delimiter without spaces.

  • event String

    It enables collecting event-related metrics. Write the name of the metric to collect by referencing the EVENT column such as v$system_event, and v$event_name. You can collect additional metrics along with the basic metrics by writing them in a way like event+=. You can enter multiple items using the comma (,) as the delimiter without spaces.

  • topstat Int

    Default 50

    It collects changes in key statistics-related metrics according to the values set in descending order. The data having the stat_top and event_top categories are used.

  • topevent Int

    Default 50

    It collects changes in key event-related metrics according to the values set in descending order. The data having the stat_top and event_top categories are used.

    Note

    If no value is set for this option, it operates according to the setting for topstat.

  • bind_interval Int

    Default 0

    It sets the bind capture interval in seconds. Setting the default value (0) disables the bind capture.

  • bind_max_count Int

    Default 1000

    It sets how many bind capture values ​​to collect. Only the bind capture values after the last collection time can be collected.

  • bind_elapse Int

    Default 5

    It sets to collect bind values ​​if SQL runs longer than the specified time (seconds). If the setting is 0, this option does not work.

  • plan_change Int

    Default 1

    It sets whether to collect the change history for the plan.

    • 1: Excludes sys
    • 2: Includes sys

  • plan_elapse Int

    Default 5

    It collects the plans that take more than 5 seconds to run.

  • multi_db_stat Boolean

    Default true

    When using the Multi DB, set whether to collect metrics by database or by summing them for all instances.

  • ora_hidden_param Boolean

    Default false

    It sets whether to collect hidden parameter values. Set the option value to true to collect hidden parameters.

  • segments Boolean

    Default true

    It collects the segment size information. In Stat/Report > Tablespace Size, you can see the size by selecting the database or tablespace.

  • segments_hour Int

    Default 5

    It sets the time to collect segment sizes. The default value is 5 and collection starts at 5 AM.

  • segments_min_size Int

    Default 10

    The minimum unit for collecting segment sizes is 10 MB by default. When collecting the segment sizes, the segment sizes less than the set value are not collected.

  • segments_exclude_sys Int

    Default 1

    The sizes are collected except for accounts corresponding to sys.

  • segments_sys String

    Default 'SYS', 'OUTLN', 'SYSTEM', 'AUDSYS', 'DBSNMP', 'GSMADMIN_INTERNAL', 'XDB', 'WMSYS', 'OJVMSYS', 'CTXSYS', 'ORDSYS', 'ORDDATA', 'MDSYS', 'LBACSYS', 'DVSYS', 'DBSFWUSER', 'APPQOSSYS', 'OLAPSYS'

    It is the list of accounts corresponding to sys. To add to the above accounts, you can add with segments_sys+='xxx'.

  • segments_max_count Int

    Default 50

    Only 50 large segments are collected and stored for each tablespace.

  • xview_min Int

    Default 100 (1 scond)

    The unit is centisecond (1/100 of a second). This option processes only the jobs whose elapsed time is greater than the set value.

    • -1: This option is disabled.
    • 0: It collects all jobs.

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.

Additional agent configuration​

You can additionally monitor resources on the database server by setting the following options in the xos.conf file. To use this option, set the xos option to true in the whatap.conf file.

  • interconnect_nic String RAC

    It collects network card information corresponding to the set option value. If this option is not set, interconnect-related metrics are not collected.

    xos.conf
    # example
    interconnect_nic=enp0s3

    Enter the network interface used for interconnect of Real Application Cluster (RAC) among the network interfaces confirmed by the netstat -i command. The set values are used to monitor the performance and activities of the network card.

  • 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

    Displays the disk utilizations, free sizes, and total sizes for each instance. If the value is 0, disk usage is not collected.

  • process String

    The execution status of processes can be monitored. Enter the process name as an option value. Multiple items can be registered 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 on the database is ended. 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 Configuration), enter the absolute path in the file option for the log files to be monitored.

    xos.conf
    file=/opt/oracle/log