Using Setup (Xcalar admin only)

As a Xcalar administrator, you can click the Monitor icon () in the Xcalar Design menu to perform all functions described in Using the Monitor. In addition, you can click the Setup icon () to perform these tasks:

  • Configuring Xcalar Compute Engine parameters.
  • Managing the cluster, which includes the following tasks:
    • starting a cluster.
    • stopping a cluster.
    • restarting a cluster.
    • checking the cluster status.
    • updating the cluster license.
  • Managing users, which includes the following tasks:
  • Viewing Xcalar log files.

You can perform these tasks without having an active workbook.

Configuring parameters

The Xcalar Compute Engine parameters affect how your cluster works. In certain circumstances, Xcalar technical support might instruct you to fine-tune some parameters to improve performance or to customize your cluster for your particular environment. The list of parameters shown in the Monitor might vary from one cluster to another.

IMPORTANT: Leave the parameters at their defaults unless you are told otherwise by Xcalar technical support or by the instructions in this topic.

If a Config Parameter Name field does not contain a name, you can enter a parameter name in the field, but do so only if you are under the guidance of Xcalar technical support.

When changes take effect

Changes to parameter values take effect after you restart the cluster.

Parameter descriptions

The following table explains the parameters:

Parameter Description
Constants.XdbLocalSerDesPath

(Only for Xcalar in operational mode) Full path to which Xcalar Compute Engine serializes data to a lower tier of the memory hierarchy if needed.

IMPORTANT: Always change this parameter from its default to a path backed by local disks. A path backed by SSDs (solid state drives) is strongly recommended for performance reasons.
Constants.SendSupportBundle

Boolean value specifying whether support bundles are automatically sent to Xcalar when you generate a support ticket. For information about support bundles, see Generating a support ticket.

The default value is false, which means that support bundles are saved only in XcalarRootCompletePath/support, where XcalarRootCompletePath is the full path where Xcalar is installed. If Xcalar needs diagnostic information about your cluster for troubleshooting, you have to manually send it.

Steps for changing parameter values

If you are instructed by Xcalar to configure the parameters, follow these steps:

  1. Click Configuration in the Setup panel.
  2. In the Configure Parameter window, enter the new value of a parameter in the New Value field and then click CONFIRM & SAVE.

    If you want to restore the parameter to its default value, click .

  3. Restart the cluster to make the changes take effect.

Stopping and starting the cluster

After you install Xcalar, the cluster is started automatically. You need to start the cluster manually in these situations:

  • after the cluster crashes.
  • after you stop the cluster for maintenance or troubleshooting.
  • after you change a parameter value.

Steps for stopping the cluster

To stop the cluster, follow these steps:

  1. Click Configuration in the Setup panel to display a menu.
  2. Click Stop Cluster.

Results of stopping a cluster

All nodes are stopped at the same time. The following list describes the effects of stopping the cluster:

  • Xcalar Design displays the following message for all the logged in users:

  • Operations in progress are canceled.

Steps for starting the cluster

The cluster can be started if the cluster is currently stopped (that is, if all the nodes are stopped). To start the cluster, follow these steps:

  1. Click Configuration in the Setup panel to display a menu.
  2. Click Start Cluster.

If the cluster is running or if some nodes are running, and you want to start the cluster again, click Restart cluster.

Updating the license

In the Setup panel, you can click Cluster Status to display a modal window with status information. Report the information to Xcalar technical support if needed.

To update a license, click Update License. Paste the license key given to you by Xcalar in the modal window and then click CONFIRM.

Sending a message to all users

Follow these steps to send an alert message to all users who are using Xcalar Design:

  1. Click Admin Alert in the Setup panel.
  2. In the Admin Alert window, type a message.
  3. Click SEND.The message is displayed in each user's Xcalar Design window.

Managing users

In the Setup panel, you can click Users to display a list of users that have logged in to the cluster. The user names are listed regardless of whether the users are currently logged in or whether the users have any workbooks.

You cannot edit the user list. You can, however, perform the following tasks:

  • Sorting user names alphabetically by memory usage.
  • Hovering over a user's memory usage icon to display the amount of memory consumed by that user.
  • Clicking a user's memory usage icon to display the amount of memory used by the user's workbooks.
  • Logging in as another user.

The following partial screenshot shows the Setup panel containing the user list:

The following screenshot shows the modal window that displays the memory used by the user's workbook. It includes a breakdown of memory consumed by the tables. The information helps you determine which tables to delete for the purpose of releasing memory.

As shown in the screenshot, you see a breakdown of memory consumed by each table. The information helps you determine which tables you can delete for the purpose of releasing memory.

Logging in as another user

You can switch to another user's account so that you can work on the user's behalf. You can perform all the operations that the user can perform, If the user is already logged in, switching to that user's account logs the user out of Xcalar Design.

After you finish working in Xcalar Design as a user, you can return to the administrator's account.

Follow these steps to use Xcalar Design as another user:

  1. In the Setup panel, click the Use Xcalar as this user icon as shown in the following partial screenshot:

  2. Click CONFIRM in the Confirmation dialog box.

    After you switch to the other user (for example, a user named user3), a message similar to the following is displayed in the lower right corner of the Xcalar Design window:

    This is what Xcalar Design looks like to: user3

To return to the administrator's account, click the Cancel icon as shown in the following screenshot:

Understanding log messages

Xcalar Compute Engine generates log messages and saves them to log files. By default, the log files are in the directory named /var/log/xcalar.

You can use Xcalar Design to view log messages generated by each node, which are in a file named /var/log/xcalar/node.X.log, where X is the node number. For example, on a two-node cluster, the log directory contains /var/log/xcalar/node.0.log and /var/log/xcalar/node.1.log.

NOTE: If you want Xcalar logs to be saved at a different location, contact Xcalar for instructions on changing the path to the log directory.

Methods for viewing logs

You can view log messages through Xcalar Design in one of two ways:

  • Viewing a specified number of recent messages.
  • Streaming messages as they are generated.

Specifying the nodes from which you retrieve the logs

You can view messages from all nodes or from particular nodes. Follow these steps if you want Xcalar to retrieve the logs from particular nodes:

  1. Display the Setup panel in the Monitor. The Logs window is displayed below the Configure Parameter window.
  2. In the Host Name Pattern field, enter a regular expression. If a node has a host name that matches the regular expression, its log will be displayed. If you leave this field blank, logs from all nodes will be displayed.

Viewing recent log messages

Follow these steps to view recent log messages:

  1. Display the Setup panel in the Monitor. The Logs window is displayed below the Configure Parameter window.
  2. In the Logs window, type the log file name. To display messages for all nodes, you can type the following:

    node.*.log

  3. Enter the number of messages from each log file to display, which can be from 1 to 500. For example, if you enter 10, then 10 messages from each log file are displayed.
  4. Click the check mark icon to submit the values. The specified number of messages for each log file appear in the window immediately.

Streaming log messages

Follow these steps to view log messages as they are generated:

  1. Display the Setup panel in the Monitor. The Logs window is displayed below the Configure Parameter window.
  2. In the Logs window, type the log file name. To display messages for all nodes, you can type the following:

    node.*.log

  3. Click Start Monitor Stream. The log messages from the specified log files are displayed in real time.
  4. If you want to stop the streaming, click Stop Stream.
NOTE: If you previously set a number of messages to display, the value has no effect on message streaming.

Clearing log messages

To remove all log messages from the Logs window, click CLEAR LOGS. This button clears the messages from Xcalar Design only. The messages remain in the log files on the nodes.

Go to top