Show TOC

Editing Advanced Options in Project ConfigurationLocate this document in the navigation structure

Modify project deployment properties, project options, and instances in a project configuration file.

Procedure

  1. In the CCR Project Configuration editor, select the Advanced tab.
  2. (Optional) If no project deployment item exists, select Add.
  3. Choose a project deployment type from the Project Deployment Details window. The options are:
    Type Description
    Non-HA Non-HA deployments create one project option item and one instance item as children under the project deployment item.
    HA HA deployments create one project option item and two instance items as children under the project deployment item. HA provides for hot project failover between instances.
  4. Options are shown in the main Project Deployment Node as Project Deployment Details. To add a deployment option to your project, click the check box to enable it, then set a value for it or accept the default. The following table describes these options and provides information on their settings.
    Project Option Description
    Debug Level

    (debug-level)

    Sets a logging level for debugging the project, ranging from 0 to 7. The default level is 3.
    • 0: LOG_EMERG - system is unusable
    • 1: LOG_ALERT - action must be taken immediately
    • 2: LOG_CRIT - critical conditions
    • 3: LOG_ERR - error conditions
    • 4: LOG_WARNING - warning conditions
    • 5: LOG_NORMAL - normal but significant conditions
    • 6: LOG_INFO - informational
    • 7: LOG_DEBUG - debug level messages
    Performance Monitor Refresh Interval

    (time-granularity)

    Defines the performance monitor refresh interval, or time granularity, within the project. This option specifies, in seconds, how often the set of performance records—one per stream and one per gateway connection—is obtained from the running Event Stream Processor. By default, the refresh interval is 5. Set the interval to 0 to disable monitoring; this also optimizes performance.
    Java Classpath The path to the Java classpath file.
    Java Max Heap

    (java-max-heap)

    The max Java heap for the project. Default is 256 megabytes.
    Bad Record File

    (bad-record-file)

    Defining this option causes bad records to be saved to a file instead of being discarded (which is the default).

    If defining this option, you need to specify a filepath. For example, <base-directory>/<workspace-name>.<project-name>.<instance-number>.

    UTF-8 Enables or disables UTF-8 functionality on the server. Default value is false; set to true to enable.
    Web Service Enabled Enables and disables project access to Web services so that Web services clients can connect to the ESP Web Services Provider. This connection allows access to project data and can be used to publish data to project streams and windows. Default value is false (disabled).
    Optimize Suppresses redundant store updates. When set to true, if a window gets updates for a key, but the window's column value does not change, no update is sent. You receive output only when the column value changes. When set to false, you receive output with every update, regardless of whether the column value changes. Default value is true.
    On Error Discard Record If set to true, the record being computed is discarded when a computation failure occurs. If set to false, any uncomputed columns are null-padded and record processing continues. The default value is true.
    Note If the computation of a key column fails, the record is discarded, regardless of this option.
    On Error Log If set to true, any computation errors that occur are logged in the error message. The default value is true.
    Maximum Log File Size Sets the maximum size of a log file before a new log file is started. The default is 1MB.

    Setting this parameter to “0” enables an unrestricted, unlimited size for a single log file.

    Note Setting a higher file size is beneficial for projects that involve higher logging levels. However, a higher limit for a prolonged period may lead to performance and latency issues.
    Maximum Number of Backup Log Files Sets the maximum number of log files stored before the oldest files are completely overwritten. When there are multiple backup log files, files are named esp_server-<number>.log, with the lowest <number> representing the most recent file.

    This parameter is unnecessary if the log file size parameter is set to zero.

    Time Interval Sets the constant interval expression that specifies the maximum age of rows in a window, in seconds. Default value is 1.
    Precision Sets decimal display characteristics for number characters in the project. Default value is 6.
    Memory Sets memory usage limits for the project in megabytes. Default is 0, meaning unlimited.
    Command Port Sets an explicit command port number. Change the value only to expose the port outside the firewall.

    Ensure that the port is available on all machines that can run the project.

    If the port is 0, the program selects an arbitrary port.

    Valid port numbers are between 1 and 65535. Default value is 65535.
    SQL Port Sets an explicit SQL port number. Change the value only to expose the port outside the firewall.

    Ensure that the port is available on all machines that can run the project.

    If the port is 0, the program selects an arbitrary port.

    Valid port numbers are between 1 and 65535. Default value is 65534.
    Gateway Port Sets an explicit gateway port number. Change the value only to expose the port outside the firewall.

    Ensure that the port is available on all machines that can run the project.

    If the port is 0, the program selects an arbitrary port.

    Valid port numbers are between 1 and 65535. Default value is 65533.
    Consistent Recovery If set to true, the project runs in consistent recovery mode. Any window assigned to a log store is recoverable to the last checkpointed state. Since checkpointing of multiple log stores is done together, related windows need not be assigned to a single log store. If the server or connection fails during the checkpoint of a log store, the server restarts the project at the last successful checkpointed state.

    If you are not using log stores, consistent recovery mode is ignored.

    Defaults:
    • New projects created in Studio: True
    • Existing projects: False
    Auto Checkpoint Sets the maximum number of input transactions, across all input streams and windows, that are processed before the server issues a checkpoint. A checkpoint may occur before the maximum number of transactions, if the server deems it necessary, or if the server is in conistent recovery mode, and the publisher issues a commit.

    If you are not using log stores, Auto Checkpoint is ignored. When using Auto Checkpoint without consistent recovery mode, if the server fails during the checkpoint of a log store, the server does not roll back to the last successful checkpointed state on restart.

    A value of 1 checkpoints is done after every input transaction. Only the last record (which would not be completely processed and checkpointed) has the potential of not being recovered.

    A value greater than 1 has better system performance, but the potential for higher data loss.

    A value of 0 deactivates Auto Checkpoint. Checkpoints occur only as the server determines, or if a publisher issues a commit. Default value is 0 (Auto Checkpoint disabled).

    Meta Store Size To persist the state across server restarts, the server creates a metadata log store to store the information (tracked by the ESP_GD_Sessions metadata stream) regarding the amount of data each guaranteed delivery subscriber for this project has read for a given stream. A valid size is between 32 and 2147483647 (231-1). Default is 64 MB.
    Meta Store Directory The location of the metadata log store. The default location is a subdirectory of the project working directory: STREAMING_HOME/cluster/projects/<cluster-name>/<workspace-name>.<project-name>.<instance-number>/esp_metadata

    The esp_metadata directory must be located on a shared disk accessible to all nodes in the cluster.

    Memory Reserve

    (memory-reserve)

    (Linux and Solaris platforms only) Specifies the amount of reserved memory, in megabytes, required to properly shut down a project for ESP in the event that all available memory is used. The default value is 0. The recommended value is 10. Only Linux and Solaris platforms support this function.
  5. To configure an option item, fill out the Name and Value fields. Refer to the table above for name options.
    Note To return options to their default settings, click Reset All.
  6. To add an affinity under the instance item, right-click the instance item, and select Start of the navigation path New Next navigation step Affinity End of the navigation path. Fill out the Name, Strength, Type, and Charge fields.
  7. (Optional) To add a processor affinity to an instance:
    1. Click Add Processor Affinity. This creates an entry for the primary instance under Project Runtime.
    2. Select the instance.
    3. In the Processor Affinity option, enter a list of processors for the instance to run on. This list is comma-delimited and accepts dashes to denote range. For example, 0,1,3-5.
    4. To add a processor affinity to a secondary instance, repeat steps a-c.
  8. To remove items from the All Advanced Configurations list:
    • Select a project deployment item and click Remove.
    • Right-click an option or affinity item and select Delete.