StreamBase Engine Configuration

The data distribution policy to use for parallel region queues. This property is only valid if the parallel region in question uses transactional memory for storage, in which case it enables high availability of that storage. Its value must be a valid data distribution policy as declared in your application configuration. This property is optional and has no default value. If it is not set, then high availability for this region's queues is not enabled.

The initial buffer size for a parallel region queue to use. Must be a power of 2. These buffers can grow, so setting this is not technically necessary. This property is optional and its default value is 16.

For example:

defaultInitialBufferSize = 16

The maximum queue size in tuples for a parallel region queue. This must be a power of 2. This property is optional and its default value is 2^30.

For example:

defaultMaxBufferSize = 1073741824

The number of tuples to process from a parallel region queue before blocking the caller. This property is optional and its default value is zero, meaning unlimited.

The maximum batch size in tuples to process from a parallel region queue at once. This property is optional and its default value is zero, meaning unlimited.

For example:

defaultMaxProcessingBatchSize = 0

The default storage method to use for all parallel region queues. Valid values are HEAP or TRANSACTIONAL_MEMORY. This property is optional and its default value is HEAP.

For example:

defaultStorageMethod = "HEAP"

The default wait strategy used by the disruptor that controls parallel region queues. Valid values are BLOCKING, BUSY_SPIN, SLEEPING, and YIELDING. This property is optional and its default value is BLOCKING.

For example:

defaultWaitStrategy = "BLOCKING"

Drain all parallel region queues before shutdown. This property is optional and its default value is true.

For example:

drainBeforeShutdown = true

The time in milliseconds to wait for a parallel region queue to have space, before expanding it. This property is optional and its default value is 1000.

For example

expansionDelayMilliseconds = 1000

When a parallel region queue expansion has to wait, report the wait time if above this threshold in milliseconds. A value of zero means do not report. This property is optional and its default value is zero.

For example:

expansionDelayReportThresholdMilliseconds = 1000

The percentage of total memory to allow a parallel region queue to take up, before switching to blocking and linear growth. This value only applies to queues that use heap memory for storage. This property is optional and its default value is one percent.

For example:

perQueueHeapMemoryThresholdPercent = 1

Bool. This is required in order to use the engine monitor. This property is optional and if it is not present, defaults to false. If this property is false then all all other properties are ignored.

For example:

enabled = false

Int. Configures how frequently monitoring stats are produced. This property is optional and its default value is 1000.

For example:

statsFrequencyMilliseconds = 2000

Configures whether or not decision table statistics are enabled and optionally configures filters to control which decision table statistics are published. This field is optional. If this field is not specified then decision table statistics are enabled.

Configures whether or not garbage collection statistics are enabled. If this field is not specified then garbage collection statistics are enabled.

Configures whether or not operator statistics are enabled and optionally configures filters to control which operator statistics are published. This field is optional. If this field is not specified then operator statistics are enabled.

Configures whether or not queue statistics are enabled and optionally configures filters to control which queue statistics are published. This field is optional. If this field is not specified then queue statistics are enabled.

Configures whether or not stream statistics are enabled and optionally configures filters to control which stream statistics are published. This field is optional. If this field is not specified then stream statistics are enabled.

Configures whether or not system statistics are enabled. If this field is not specified then system statistics are enabled.

Configures whether or not thread statistics are enabled. If this field is not specified then thread statistics are enabled.

String. Regular expression pattern to specify the names of the entities that this filter applies to. This field is required.

Bool. Whether or not to publish statistics for the entities matching the pattern field. This field is optional and its default value is true.

Array. Defines thresholds so that a statistic tuple is published only if the specified statistic value in the statistic tuple is greater than the threshold. This field is optional. If no thresholds are specified then system-defined thresholds are used. Typically this means that only non-zero values are reported but this may vary per type of statistic.

Time service type, one of CONTROLLABLE or WALLCLOCK. WALLCLOCK uses the system clock internally. CONTROLLABLE can be initialized with a target time as specified below. This property is optional and its default is WALLCLOCK.

For example:

type = "WALLCLOCK"

Configures settings related to the Time Service. Initial time of the time service in milliseconds, if type above is CONTROLLABLE. If above is set to WALLCLOCK, the value is ignored. This property is optional and its default value is zero, which means initialize from the system clock.

For example:

targetTime = 2018-06-06 12:12:24.123+0000

This exception is caused by a variety of reasons, including errors that occur when evaluating expressions or when flushing disk-based query table logs, and incorrect timestamp formats. Continuing after such errors is not recommended.

For example:

evalError = "shutdown"

Java plug-ins can get eval-plugin-error exceptions for a variety of reasons, including TupleExceptions, errors, and when setting parameters. Continuing after such errors is not recommended.

For example:

evalPluginError = "ignore"

The Gather operator throws this error when an order by field value is null or the current value is less then a previous value.

For example:

orderingError = "continue"

Specifies the top-level EventFlow module to reside in this container, expressed as an EventFlow module reference. This property is required.

An EventFlow parameter settings object contains a set of names and corresponding values for parameters in EventFlow modules, as well as inclusions of other parameter settings. Parameter settings are named and can be included by any container configuration or other parameter settings object.

An EventFlow parameter settings object contains a set of names and corresponding values for parameters in EventFlow modules, as well as inclusions of other parameter settings. Parameter settings are named and can be included by any container configuration or other parameter settings object.

One of {ENABLED | DISABLED | DROP_TUPLES} to specify the startup state of dequeuing for this container. If you specify DISABLED, dequeue attempts are actively refused and exceptions are thrown. If you specify DROP_TUPLES, tuples are silently dropped. This property is optional and its default value is ENABLED.

One of {ENABLED | DISABLED | DROP_TUPLES} to specify the startup state of enqueuing for this container. If you specify DISABLED, enqueue attempts are actively refused and exceptions are thrown. If you specify DROP_TUPLES, tuples are silently dropped. This property is optional and its default value is ENABLED.

Set this value to true to specify that the module in this container should start up suspended. Set it to false to have the module start running when the container is added. This property is optional and its default value is false.

For example:

suspend = false

The pluginFunctions object is deprecated as of TIBCO® Streaming 10.5.0. Migrate your custom function and alias definitions to use the CustomFunctionGroup root object and its customFunctions object.

An associative array of extension point target IDs and their contents. This property is optional and has no default value.

Configures runtime tracing for this container's module. This array is optional and has no default value.

A list of zero or more parameter settings objects included by this parameter settings object. All parameter names and values in the included settings (and their respective included settings, and so on) become part of this parameter settings object. Multiple and nested inclusions are processed depth-first, and duplicate parameter values are overwritten, with the latest value taking precedence. Parameter names that also appear in the parameters section supersede any included values. This array is optional and has no default value.

For example:

includes = [ "my-referenced-parameter-settings" ]

A set of one or more EventFlow parameter name-value bindings to use in expressions in any module or container run by this EventFlow engine. This object is optional and has no default value.

String, one of simple or aggregate. This property is optional and its default value is simple. For example:

type = "simple"

String. Identifies the public static method in className to be called by this EventFlow function definition. For simple functions, this property is required.

When type = "aggregate", your custom aggregate function extends the StreamBase Client API's com.streambase.sb.operator.AggregateWindow class and its accumulate method. For this reason, methodName is optional for aggregate functions, but must be "accumulate" if expressed.

...
configuration = {
  CustomFunctionGroup = {
    customFunctions = {
      // Register a custom simple function with alias:
      calchyp = {
        type = "simple"
        methodName = "calculate"
        className = "com.tibco.ep.sample.Hypotenuse"
        autoArguments = true
      }
      // Declare an alias for a standard library function:
      hypot = {
        type = "simple"
        methodName = "hypot"
        className = "java.lang.Math"
        autoArguments = true
      }
      // Register a custom aggregate function with alias:
      enth = {
        className = "com.streambase.sample.Nth"
        type = "aggregate"
        autoArguments = true
      }
    }
  }
}

String. The fully qualified class name where the named function is found. The class must be locatable in the Maven search path in a standard Java library, or Java code in this project, or Java code in a dependency of this project. This property is required. For example:

className = "com.example.dept.Sbfuncs"
className = "java.lang.Math"

Bool. Set this property to true to have the StreamBase engine auto-detect the arguments and return type of the current function. This property is optional and its default value is false. This property is ignored if you also specify argumentTypes and/or returnType. For example:

autoArguments = true

An array of function arguments and their data type information. Use this array to list your function's argument data types instead of using autoArguments. (Specifying argumentTypes disables autoArguments if also expressed for the same function declaration.) This property is optional and has no default value.

The Full CustomFunctionGroup Example below shows a full use of the argumentTypes and returnType parameters for the showme function.

Function return type. (Specifying returnType disables autoArguments if also expressed for the same function declaration.) This property is optional and has no default value.

Set this to true if the last argument is variable length and you want to declare the individual argument elements. In this case, do not set autoArguments = true. When you use autoArguments = true, the isVarargs attribute is ignored. The default value is false. For example:

isVarargs = true