Using the Monitor

The Monitor icon enables you to monitor the status of Xcalar Compute Engine and specify the environment in which you use Xcalar Design. This section describes the tasks you can perform with the Monitor. The following screenshot shows the location of the icon.

NOTE: If you log in as administrator, a Setup icon () is available in the Monitor. See Using Setup (Xcalar admin only) for information about how to set up the cluster through this icon.

Monitoring operation status

Xcalar Design keeps a record of all operations since you logged in and displays information about them. The operations include the ones you have undone. Follow these steps to display operation status:

  1. Click to start the Monitor. By default, the Operations panel is displayed. The following screenshot illustrates the icons in the Operations panel that control how the list of operations are displayed.

    NOTE: The icon for removing an operation only affects the operation list in the Operations panel. It does not affect the output of the operation. For example, a table created by a Filter function remains in the worksheet even after you remove the Filter function from the Operations panel.
  2. Select an operation in the panel to see detailed information about it. For example, you can see how long the operation took to complete.

    NOTE: Some operations are grayed out. They represent the ones automatically started by Xcalar Compute Engine. You can configure Xcalar Design to hide automatic operations from this list. See Changing the environment settings for Xcalar Design.
  3. You can click VIEW OUTPUT to go to the table in the worksheet. If it is a hidden table, it is added back to the worksheet as an active table. You cannot click VIEW OUTPUT if the output of an operation is a table that has been dropped.

    NOTE: Because an operation that has been undone is preserved in the list of operations, you can select an undone operation to find its output, and then put the temporary table created by the operation back in the worksheet.

Canceling an operation

If for any reason you want to terminate an operation that is in progress, display the running operations in the Operations panel. Select the one you want to terminate and then click the Cancel icon either in the Operations panel or the Operation Details window. The following screenshot shows an operation (importing a data source) in progress and the location of the icon for terminating the operation.

TIP: There is another method for canceling an operation. You can cancel it when Xcalar Design displays the clock icon on the worksheet indicating the operation is in progress. If you mouse over the icon, it changes to a cancellation icon, which you can click to stop the operation. The following screenshots show the clock icon and the cancellation icon.

Monitoring the system

The System icon () in the Monitor enables you to view Xcalar Compute Engine statistics.

The following screenshot illustrates how you can use the icons in the System panel to perform various tasks.

NOTE: You can also view statistics when workbook activation is in progress by clicking the memory alert icon (the icon next to the user icon).

Changing the environment settings for Xcalar Design

The Monitor provides a Settings icon () for you to perform these tasks:

  • Customizing the environment in which you run Xcalar Design.
  • Submitting a support ticket.
  • Releasing memory.

Understanding Xcalar settings

The settings determine the following Xcalar Design behavior:

  • Whether the DATA column is displayed when Xcalar Design creates a table.
  • Whether the CREATE TABLE button is displayed in the Import Data Source window, which enables you create a dataset and a table from the dataset with one click.
  • Whether UDFs generated automatically by Xcalar are displayed in the UDF list.
  • Whether the operations list displayed by the Monitor includes operations started automatically by Xcalar Compute Engine. If you exclude these operations, the list only shows the operations started by you. For example, the ProfileSort operation is an automatic operation.
  • How often Xcalar Design saves your changes.
  • The default maximum size of the dataset shown in the Import Data Source window.

The following screenshot explains the fields in the General Settings window. For fields that accept a numeric value, you can type the value or drag the slider to make a change.

Understanding the support ticket

After you click , the Settings panel is displayed, which enables you to submit a support ticket. You can send a support ticket to report a problem or to send a comment to Xcalar. To send a ticket from the cluster, the cluster must have Internet connection.

Information in a support ticket

A support ticket includes the following types of information:

  • Type of issue
  • Comment
  • License key
  • Workbook name
  • Number of nodes
  • Status
  • Node information, which includes:
    • CPU usage in percentage
    • Memory used in percentage
    • Memory used in bytes
    • Number of bytes received from the network
    • Number of bytes sent to the network
    • Node ID
    • Memory available in bytes
  • User name
  • User unique ID
  • Xcalar version

Information in a support bundle

If you report a performance issue or a crash, you can include a support bundle, which contains additional information.

A support bundle includes the following types of information:

  • Any core dumps caused by a crash.
  • Xcalar configuration (/etc/xcalar/*) and Xcalar-generated data (/var/opt/xcalar/*).
  • System statistics and configuration, such as number of CPUs, memory, packages installed.
  • System and Xcalar logs if permissions allow (for example, /var/log/messages, /var/log/httpd/*, /var/log/Xcalar*.log, and /var/log/xcalar/*).
NOTE: The exact information included in the support bundle might vary, depending on the access rights given to Xcalar. Because by default, Xcalar does not run as root, the file permissions set by the system administrator can prevent some information from being sent to Xcalar. For example, by default, Xcalar cannot collect syslog information unless it has permission to read the syslog file.

Generating a support ticket

To generate a support ticket, follow these steps:

  1. In the MonitorSettings panel, click File Support Ticket. The File Support Ticket modal window is displayed.

  2. In the Type of issue field, use the drop-down menu to specify whether you are generating a new ticket or modifying an existing ticket.

    The following screenshot shows how to select the ticket type:

  3. If you select to modify a ticket, a list of existing tickets submitted by you is displayed. Click an existing ticket to modify.
  4. (Optional) Type a comment providing information about a new ticket or additional information about an existing ticket.
  5. Disable or enable the Regenerate Support Bundle option.

    NOTE: Generating a support bundle might take a long time.
  6. Click GENERATE TICKET. When the ticket generation is in progress, the File Support Ticket icon turns gray. After the ticket is generated, the icon resumes its original color (white).

What happens if a support ticket cannot be sent

The most common reason for failing to send a support ticket to Xcalar is that the Xcalar cluster is not connected to the Internet. If your ticket includes the support bundle, the bundle stays on the cluster until the Internet connection is available. Xcalar automatically sends the support bundle as soon as it can use the Internet.

The contents of the support ticket, excluding the support bundle, can be downloaded when Xcalar fails to send the ticket. When an error message indicates that the you can download the ticket, follow these steps to manually send the ticket to Xcalar:

  1. In the File Support Ticket modal window, click DOWNLOAD, which replaces GENERATE TICKET. A ticket file is created and downloaded to your computer.
  2. Upload the ticket file from your computer by using the Submit a request link on the portal.

Releasing memory

After you click , the Settings panel is displayed, which enables you to release memory.

For more information about memory usage and how to release memory by dropping tables, see Understanding memory usage.

Go to top