Editing Advanced Options in Project Configuration

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

  1. In the CCR Project Configuration editor, select the Advanced tab.
  2. 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. Each number represents the following:
    • 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 performance monitor refresh interval is set to 5. Set this option to 0 to disable monitoring; this also optimizes performance.
    Java Classpath Sets the Java classpath. Value is the path to the classpath file.
    Java Max Heap

    (java-max-heap)

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

    (bad-record-file)

    Saves bad records to a file that you specify. When this option is omitted (the default), bad records are discarded. Default file name is esp_bad_record_file.

    If the value is a file name with no path, ESP places the file in a default location:
    <base-directory>/<workspace-name>.<project-name>.<instance-number>
    where <base-directory> is a property defined in the cluster configuration file:
    • In the local (Studio) cluster: ESP_HOME/studio/clustercfg/localnode.xml
    • In a remote cluster: ESP_HOME/cluster/nodes/<node-name>/<node-name>.xml
    Utf8 Enables Utf8 functionality on the server. Default value is true; set to false to disable.
    Web Service Enabled When this value is set to true, it enables 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.
    Optimize Suppresses redundant store updates. For example, when set to true, you don't receive output if a window gets updates for a key but the window's column value does not change. 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 will be discarded regardless of this option.
    On Error Log If set to true, any computation errors that occur will be logged in the error message. The default value is true.
    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 if you need to expose the port outside the firewall. Otherwise, do not modify this value.

    If you set an explicit command port, ensure that port is available on all machines that can run the project.

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

    To define a specific port, set a value between 1 and 65535. Default value is 65535.
    SQL Port Sets an explicit SQL port number. Change the value if you need to expose the port outside the firewall. Otherwise, do not modify this value.

    If you set an explicit SQL port, ensure that port is available on all machines that can run the project.

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

    To define a specific port, set a value between 1 and 65535. Default value is 65534.
    Gateway Port Sets an explicit gateway port number. Change the value if you need to expose the port outside the firewall. Otherwise, do not modify this value.

    If you set an explicit gateway port, ensure that port is available on all machines that can run the project.

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

    To define a specific port, set a value between 1 and 65535. Default value is 65533.
    Consistent Recovery If set to true, the project runs in consistent recovery mode. Any window that you have assigned to a log store will be recoverable to the last checkpointed state. Related windows do not have to be assigned to a single log store because checkpointing of multiple log stores is done together. If the server or connection fails in the middle of checkpointing a log store, the server restarts the project at the last successful checkpointed state.

    If you are not using log stores, consistent recovery mode does not take effect.

    Defaults:
    • For new projects created in Studio: True
    • For existing projects: False
    Auto Checkpoint Sets the maximum number of input transactions, across all input streams and windows, that will be 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 does not take effect. When you use Auto Checkpoint without consistent recovery mode, if the server fails in the middle of checkpointing a log store, the server does not roll back to the last successful checkpointed state on restart.

    If you set the value to 1, a checkpoint is done after every input transaction. This means that only the last record (which would not be completely processed and checkpointed) has the potential of not being recovered.

    If you set the value higher than 1, you have the potential for higher data loss, but will have better system performance.

    If you set the value to 0, Auto Checkpoint is not activated. Checkpoints occur only as the server determines, or if a publisher issues a commit.

    Default value is 0 (Auto Checkpoint disabled).

    Meta Store Size In order to persist state across server restarts, the server creates a metadata log store. This store holds 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. Default store size is 64 MB.
    Meta Store Directory You can change the location of the metadata log store. The default location is a subdirectory of the project working directory: ESP_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.

  5. To configure an option item, complete these fields:
    Option Description
    Name Select from the list of available options shown in the above table.
    Value Enter a value for the property option.
    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 New > affinity. Complete these fields:
    Option Description
    Name Enter a name for the affinity item.
    Strength Select a strength level.
    Type Select a type. (for example, controller).
    Charge Select a charge.
  7. 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.
Related concepts
Advanced Project Deployment Options
Related tasks
Editing Cluster Parameters in Project Configuration
Editing Bindings in Project Configuration
Editing Adapter Property Sets in Project Configuration
Setting Parameters in Project Configuration