Project Deployment Options

Project deployment options determine how your project is deployed in a cluster and how it functions at runtime. Set these parameters, including project options, active-active instances, failover intervals, and project deployment type options, in the CCR file manually or within Studio.

Project options are used as runtime parameters for the project, and include a predefined list of available option names that reflect most command line entries.

This table outlines the project options you can set using the Project Configuration view in ESP Studio or by editing the CCR file.
Note: When you change options in a deployed project, use Studio or esp_cluster_admin to stop and remove the project from the node, then redeploy (add) the project.
Project Option Description
Debug Level Set 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 Define performance monitor refresh interval 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, performance monitor refresh interval is set to 5. Set this option to 0 to disable monitoring; this also optimizes performance.
Java Classpath Set the Java classpath. Value is a filepath to the classpath file.
Java Max Heap Set the max Java heap for the project. Default value is 256 megabytes.
Bad Record File To save bad records to a file, select the bad-record-file option for Project Type, and indicate the file name of an ESP project for Value Field. If a file name is not specified, bad records are discarded. Default file name is esp_bad_record_file.
Utf8 Enable 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 Set the constant interval expression that specifies the maximum age of rows in a window, in seconds. Default value is set to 1.
Precision Set decimal display characteristics for number characters in the project. Default value is 6.
Memory Set memory usage limits for the project. Default is 0, meaning unlimited.
Command Port Set an explicit command port number 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 Set an explicit SQL port number 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 Set an explicit gateway port number 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.
Related reference
Active-Active Deployments
Project Instances
Affinities
Failover
Sample Project Configuration File