Skip to main content

Monitoring Multiple Instances

Info

This document has been created based on the CUBRID Monitoring V2. For the CUBRID monitoring V1 document, see the following.

Home > Select Project > Dashboard > Monitoring Multiple Instances

While you can monitor only one agent (instance) in Monitoring a Database Instance, Monitoring Multiple Instances allows you to monitor and manage multiple agents (instances).

You can compare and analyze key performance metrics occurring in each instance at a glance. You can effectively perform monitoring by aggregating data such as the number of agents running, the sum of all active sessions, and the number of transactions. Users can easily check the changes in metric values ​​over time and high performance metrics for each instance through graph charts.

Additionally, users can see the longest-lasting active sessions, which can be used as a basis for diagnosing and resolving the system performance bottlenecks.

Multi-instance Monitoring

Tip

If you select an agent to compare in Dashboard > Instance List, and then select Multi view, the Monitoring Multiple Instances menu appears.

Viewing the past data

The dashboard basically provides real-time monitoring features in which you can view the past data.

Real-time modeNon-real-time mode
Real-time modeNon-real-time mode
  1. Select Pause icon in the time selector at the upper left of the screen.

  2. Click the date and time to set the desired time zone.

    Configure manual time

  3. Select Apply.

It updates the data in widgets placed on the dashboard based on the set time. To switch to the Realtime mode, select Playback icon.

Checking the agent

Checking the agent connection status

On the upper left of the screen, the right area of the time selector provides information that allows you to check the status of agents connected to the project. This allows you to immediately check whether the target application server is running.

  • Total: Number of all agents connected to the project

  • Active: Number of active agents

  • Inactive: Number of inactive agents

  • Agent display icon: Can display or hide inactive agents.

Agent-based monitoring

Selecting the agent

By default, the dashboard displays the metrics collected from all agents in charts and you can also view the data by agent. Select one or more agents under the time selector. The data of the widgets on the dashboard is updated with the metrics of the selected agent(s).

Tip

To select all agents again while one or more agents is selected, deselect them or select Total.

Editing a dashboard widget

The widgets on the dashboard can be adjusted to the desired size and placed in the desired positions. You can also delete unnecessary widgets or add them again.

Resizing a widget

Resizing a widget

Click and hold the mouse on the Resize icon element at the lower right of the widget, and then drag it to the desired size. Grids with a uniform horizontal-to-vertical ratio appear and the size of the widget can be adjusted in each grid.

Moving a widget

Moving a widget

When you move the mouse cursor to the top of the widget, the cursor shape changes to Move icon. At this time, you can move the widget by dragging with your left mouse button and move to the desired position.

Deleting a widget

Deleting a widget

Right-click on a widget to delete. If you select Delete, the widget is deleted from the dashboard.

Adding a widget

Adding a widget

Move the mouse cursor to an empty space on the dashboard and then right-click on it. Select a widget to add from the pop-up menu. Place the widget to the desired position and then resize it.

Note
  • For more information about the widgets that can be placed on the dashboard, see the following.

  • The widgets that can be added are fixed, but we plan to increase supports through future updates.

Custom widget

The custom widget feature allows users to add their own metrics in addition to the metrics provided by default on the dashboard. If you have metrics to continuously monitor on the dashboard in addition to the metrics provided by default, use the custom widget feature.

Add

  1. Right-click an empty space on the dashboard.

  2. On the pop-up menu, select Add Custom Widgets.

  3. If Custom Widget is created on the dashboard, select Select indicator.

    Custom widget

  4. When the Add Custom Widgets window appears on the right of the screen, enter the widget name in Title.

    Custom widget

  5. In the metrics list at the bottom of the screen, select the Add icon button on the upper right of the metric to add.

  6. After the metric has been changed, select Save.

Note
  • You can add up to four metrics. To add metrics, select Add icon.

  • Ti change the metric, select a different metric in the metrics list. If you select Add icon, the metric is added.

  • If you do not enter the widget title, it is saved as a custom widget.

Selecting the chart type

In chart type of the Add Custom Widgets window, you can select the following types.

  • Graph icon Series: Time series chart that displays the metric changes over time.

  • Graph icon Equalizer: Bar graph chart that can compare the performance for multiple metrics. By visually displaying various metrics on one screen, you can easily see the overall performance status.

  • Graph icon Pie: Pie chart useful for checking the composition ratio for multiple metrics relative to the whole.

  • Text icon Text: It displays the figures for the metrics in text.

Selecting the data merging method

In Merge target of the Add Custom Widgets window, you can select the way to display metrics collected from agents.

  • Sum: It sums up the metric values ​​collected from multiple agents and displays them as a single value. This option is useful for displaying the overall total by merging data from multiple agents.

  • Avg: It averages the metric values ​​collected from multiple agents and displays them as a single value. This option is useful for checking the average performance or status of all agents.

  • Max: By selecting the largest value among the metric values ​​collected from multiple agents, it displays a single value. This option is useful for identifying the highest performance consumption or worst performance cases among agents.

  • No Merge: It displays the metrics for each agent.

Note

The available merge method may differ depending on the chart type.

Changing a metric

You can change or add metrics for the metrics added to the custom widget.

  1. Select Configuration icon on the upper right of the custom widget added on the dashboard.

  2. When the Add Custom Widgets window appears on the right of the screen, select a metric to change.

    Custom widget

  3. Select a metric to change from the metric list at the bottom of the screen. To add a metric, select Add icon on the upper right of the metric to add.

  4. After the metric has been changed, select Save.

Tip

The features of the icon buttons in the list for added or changed metrics are as follows:

  • Delete icon: You can exclude the metric from the custom widget.

  • Alert icon: You can set the alert for the metric. When the button is selected, the Alert > Event Configuration appears. For more information about the Metrics event setting, see the following.

Using the widget options

The icons displayed on the widget function as follows:

  • Information icon: You can see the features and information for major widgets. (multilingual support planned)

  • Up arrow icon or Down arrow icon: You can enlarge or reduce the range of the vertical axis.

  • Fullscreen icon: You can view the widget's data on a wider screen.

  • Detail icon : A detail window appears where you can search the data of the widgets separately by agent.

Note

The provided options may differ depending on the widget.

Setting presets

You can save and load the settings and layouts for widgets on the dashboard. You can create a new preset by adjusting its size and placing it on the desired position.

Preset

  • Default: This preset consists of XOS metrics, AWS RDS CloudWatch metrics, and major DB metrics.

  • Default(xos): This preset consists of XOS metrics and major DB metrics.

  • Default(rds): This preset consists of AWS RDS CloudWatch metrics and major DB metrics.

Note

The default preset (Default) cannot be changed.

Creating a new preset

  1. Place the widgets in the desired format on the dashboard. You can also resize and place only the widgets to be frequently checked.

  2. On the upper right of the screen, select Save icon.

  3. Enter a new preset name.

    Save preset

    To save the selected agent data, select Include agent selection history.

  4. Select Save.

You can see the newly saved preset from the preset list.

Note
  • If any changes are made to the newly created preset, save the preset again. Select Save icon and then save the preset with the same name. Any changes are overwritten in the existing preset.

  • If you go to another menu without saving changes on the dashboard, the changes are not saved.

  • Presets are saved on a project basis and can be shared with other users.

Deleting presets

If you have unused presets, you can delete them from the preset list. Select Delete icon on the right of the item to delete from the preset list.

Note

The Default preset cannot be deleted.

Learning about the main widgets

The types of widgets that can be placed on the dashboard are as follows.

XOS widgets

  • [XOS] CPU

    You can see the CPU usages for each agent in real time.

  • [XOS] Memory

    You can see the memory usages for each agent in real time.

  • [XOS] Disk Usage

    Displays the disk utilizations, free sizes, and total sizes for each agent.

    • Detail icon: The Disk usage details pop-up window appears. You can check the chart that displays the disk usage by time zone. You can check the data by instance. By selecting Size, Free, or Used, you can see the total size, remaining size, and size in use.

    • Zoom in icon: You can expand the table on the widget to a wider screen.

    Tip

    If there is no data displayed, add the following settings to the xos.conf file.

    xos.conf
    # Off if the disk usage is 0; unit: second
    disk_usage_interval=60
  • Active Sessions

    It visually displays the numbers of active sessions over time in a time series chart. This widget traces and graphs the numbers of sessions running in the database over time. It is useful for visually checking the session usage patterns and load.

  • Lock Wait Sessions

    It visually displays the numbers of lock waiting sessions over time in a time series chart. This widget traces the numbers of sessions in lock waiting state in the database over time and displays it on the graph in real time.

  • Long Active Session Count

    It provides information about active sessions running on the database for long time. A chart appears for information aggregated by time zone with grouped by the session execution time. It can identify long-running sessions with performance issues or resource leaks in the database, or classify the sessions based on the execution time to visually display which sessions stay active for long time.

    It appears in blue for less than 3 seconds, green for 3 seconds or more that is less than 10, orange for 10 seconds or more that is less than 15, and red for 15 seconds or more.

  • Long Waiting Session Count

    It provides information about the long-term latency of the sessions holding or waiting for locks in the database. By combining lock information and active session information, you can trace long-term latencies for queued sessions. It monitors the sessions that are holding locks or waiting for long time. You can visually see which sessions are holding locks or waiting for long time.

    It appears in blue for less than 5 seconds, green for 5 seconds or more that is less than 10, orange for 10 seconds or more that is less than 60, and red for 60 seconds or more.

  • SQL Elapse Map

    Displays a real-time chart for the elapsed times of running queries. If you drag a specific part of the chart, the Query List appears. You can enlarge or reduce the range of the vertical axis by selecting Up arrow icon or Down arrow icon.

    Note

    The execution times of queries are calculated after collecting active sessions. Therefore, depending on the active session collection cycle, there may be a margin of error. See the following figure. The execution times of SQL queries that have ended within the collection cycle are not calculated. A shorter collection cycle may decrease the margin of error, but considering the database load, it is typically set to 5 seconds. It is useful for monitoring long-running queries. The same is true for the data in SQL statistics.

  • Logical Reads (num_data_page_fetches)

    Number of data pages retrieved from memory. Databases often look up data in memory before reading it from disk. This metric plays an important role in evaluating the efficiency of the database by using caches or buffers. A higher value indicates that more data is fetched from memory, which helps reduce disk I/O burden.

  • Pysical Reads (num_data_page_ioreads)

    Number of data pages read from disk. A higher value indicates that more data is being read from disk instead of memory. This may negatively affect the system performance. It is important to optimize this value as higher values ​​can result in lower hit rates for the database and slower I/O performance.

  • Executions (executions)

    Number of executions of DML (Data Manipulation Language) commands. It includes executing queries such as SELECT, INSERT, UPDATE, and DELETE. This metric helps you see the overall amount of work being performed on the database and is a key factor in monitoring the throughput of the database.

    Note

    Calculation method: num_query_selects + num_query_inserts + num_query_updates + num_query_deletes

  • Full Scans (num_query_sscans)

    Number of full scans. A full scan is a low-performance operation that retrieves data by scanning the entire table without using any index. A higher number of full scans can affect the query performance and it indicates the need for index optimization.

  • Buffer Hit Ratio(%) (data_page_buffer_hit_ratio)

    This metric represents the hit rate of the data page buffer as a percentage. A higher hit rate indicates that data is being retrieved from the memory buffer quickly, which helps improve the system performance. On the contrary, a low hit rate can result in increased physical I/O, which can lead to poor performance.

    Note

    Calculation method: ((Num_data_page_fetches - Num_data_page_ioreads) / Num_data_page_fetches) * 100

  • Disk Sorts (num_sort_io_pages)

    Number of pages fetched while performing sort operation on disk. Disk sorting indicates a sorting operation that has not been processed in memory, and a higher value may result in poor performance. You may need to adjust the memory size or sorting strategy to increase the number of sorts that can be processed in memory.

  • CAS Memory size (psize)

    Size of memory being used by the cub_cas (CUBRID Application Server) process. This value indicates the amount of memory occupied by the CUBRID broker (CAS) process, and displays the sum when multiple brokers are running. An abnormal high memory usage may indicate a memory leak or system under stress.

  • CAS count (broker_count)

    Number of cub_cas (CUBRID Application Server) processes running. This value is the number of broker processes. The more brokers there are, the more requests can be processed in parallel. However, as the number of brokers increases, resource consumption also rises, so proper configuration is required.

  • Replication Delay (time_ha_replication_delay)

    It displays the replication delay time in seconds in the CUBRID's High Availability (HA) environment. This metric measures the time taken for data to be synchronized from the Primary server to the Replica server. A higher value indicates that there is a delay in data synchronization. If replication delay persists, it can affect the system availability and data consistency.

Session Table widget

You can view real-time active sessions in the Session Table widget at the bottom of the screen.

  • Active sessions
    • You can view active sessions and queries. If you select an item in the rightmost query column in the table, the SQL details window appears. You can see the full text and plan information for the selected query. For more information, see the following.
Note

In the table list, the text colors are changed black → orangeRed, which means that the performance of the session is getting slower.

See query details

To check the SQL query information of the executing session, select the query (or sql_text) column in the Active sessions section. The SQL details window appears. You can check the SQL query statements and plan information.

SQL details

  • View SQL Statistics: You can go to the SQL statistics menu where you can check statistical information related to the SQL query statement.
  • Default Bind: You can bind the part set as a variable in the query sentence to the default value.

  • Reset Bind: You can release the bound default value and check the variable.

  • Formatting: You can improve readability by applying indentation and formatting to a SQL query statement.

  • Plan: To check plan information, enter DB Name, User Name, and Password, and then select Search icon.

Filtering the table data

Filter

  1. Select Filter icon on the upper right of the table.

  2. Select a column header and a condition in the table.

  3. Enter a desired value in the Enter conditions field.

  4. Select Save.

Setting the table columns

You can hide the table header columns or add any of them. You can also change the column order. Select Column icon.

Column Settings

Note
  • After configuration, select Confirm to apply the settings in the table.

  • In the number 3 search bar, enter text to search the desired columns. Only the columns that meet the entered text are displayed.

  • Images may differ depending on the product, project, or menu.

Adding columns

From the Number 1 list, select the items to add as table header columns. To select all items, select Select All.

Deleting columns

From the number 1 list, unselect the columns to delete. Alternatively, select Delete icon on the right of the item to delete from the number 2 list.

Changing the column order

Drag an item to reposition from the number 2 list, and then move it to the desired position.

Initializing the configuration

To cancel all changes and reset them, select Reset icon Initialized.

Column information guide

ItemDescription
instanceAgent or instance name.
pidPID of the database process.
dbnameName of the connected database.
userUser name connected to the database.
query_timeQuery execution time.
transtatusCurrent state of the transaction.
queryExecuted SQL query.
query_hashHash value of the query.
query_paramParameters used for a query.
programProgram information executed by the client.
tranindexUnique number that identifies the running transaction.
tran_timeTime elapsed since the transaction began.
sql_idUnique ID for the running SQL query.
timeTask operation time
lock_holderSession that has locked the resources in the current transaction.
Note

WhaTap basically stores the client-related information.

Downloading the view list

You can download the current Session Table list in CSV format. Select Download icon on the upper right of the Session Table section.

The naming format of the downloaded file is as follows:

Viewing in a new window

You can see the Session Table list on a new wider screen. Select New window icon on the upper right of the Session Table section.