Propagation parameters

Propagation parameters enable you to configure propagation and destination buffers.

The format for propagation parameter definitions is:

PropagationParameter = destination1=value,destination2=value, ...

You can configure multiple destinations for each propagation parameter using a comma-separated list. For example,

DestinationBufferReconnectInterval = MyCell=10,SlowCell=1200

In this example, the interval to try to reconnect to the destination is configured for 10 seconds for the cell named MyCell and configured for 1200 seconds for the cell named SlowCell.

Note

To indicate 'any destination', leave the name part empty.

You can configure these parameters for individual destinations and also configure a default value for all other unspecified destinations. If you do not specify a destination, that value is applied to all unspecified destinations by default. The following parameter definition illustrates how to configure a default value for these parameters for all unspecified destinations (note the two equal to signs):

DestinationBufferReconnectInterval ==600

This example specifies that the interval to try to reconnect to the destination is 600 seconds for all destinations.

You can configure a parameter for specific destinations and also include a default value to be applied to all other unspecified destinations. For example,

DestinationBufferReconnectInterval = MyCell=10,SlowCell=1200,=600

In this example, the interval to try to reconnect to the destination is configured for 10 seconds for the cell named MyCell and configured for 1200 seconds for the cell named SlowCell. For all other destinations, the interval to try to reconnect to the destination is 600 seconds.

If you have a high availability cell, the destination names #1 and #2 are reserved to indicate the primary and secondary nodes of a high availability cell, respectively. For example,

DestinationBufferReconnectInterval = #1=10,#2=10,=600,SlowCell=1200
DestinationBufferKeepWait=#1=1d,#2=1d,=1h
DestinationBufferKeepSent=#1=3,#2=3,=2m
DestinationBufferResendCount=#1=0,#2=0,=1

This example specifies that the interval to try to reconnect to the destination is 10 seconds for the high availability nodes, 1200 seconds for a cell named SlowCell, and 600 seconds for all other destinations. The KeepWait parameter is set to one hour. KeepWait is the parameter that applies in case the destination is unreachable. The KeepSent parameter is two minutes. The KeepSent parameter is the time to wait for an acknowledge after the message has been sent to the destination.

To avoid messages to be dropped from propagation in case the destination is down for more than an hour, only KeepWait has to be increased. If you want to set KeepWait to 1 day, change the configuration to:

DestinationBufferKeepWait=#1=1d,#2=1d,=1d

If you want to remove the HA cell configuration, use the following definition (note the two equal to signs):

DestinationBufferKeepWait==1d

Propagation parameters

Parameter	Description	Type
DestinationBufferBaseSize	Initial number of messages, or events, retained in the buffer.	Number
DestinationBufferExpandPercentage	Percentage of the actual buffer size that the buffer expands when events continue to be propagated after the buffer is full.	Number
DestinationBufferSizeLimit	Maximum allowed buffer size. The default value of 0 means the buffer size is unlimited. In practice, the size is limited to 2^32-1, or to the available amount of memory. If the limit is set to a value lower than DestinationBufferBaseSize, the buffer does not expand beyond DestinationBufferBaseSize.	Number
DestinationBufferReducePercentage	Minimum percentage of free buffer size required to perform a reduction.	Number
DestinationBufferKeepSent	Amount of time, in seconds, to keep sent events buffered while waiting for an answer.	Number
DestinationBufferKeepWait	Amount of time, in seconds, events are retained in the buffer until they can be sent. After the specified time elapses, the retained events are removed from the buffer.	Number
DestinationBufferReconnectInterval	Time interval, in seconds, in which the cell attempts to reconnect to a destination if the original connection fails. The cell continues to reestablish a connection as long as there are events in the buffer.	Number
DestinationBufferResendCount	Number of times to resend unanswered events.	Number
PropagateBufferBaseSize	Number of requests for propagation to retain in the propagation buffer. Such a request corresponds to firing a Propagate rule. There is one propagate buffer per cell with as many places for requests as set by the parameter.	Number
PropagateBufferExpandPercentage	Percentage of the actual buffer size that the buffer expands when events continue to be propagated after the buffer is full.	Number
PropagateBufferSizeLimit	Maximum allowed buffer size. The default value of 0 means the buffer size is unlimited. In practice, the size is limited to 2^32-1, or to the available amount of memory. If the limit is set to a value lower than PropagateBufferBaseSize, the buffer does not expand beyond PropagateBufferBaseSize.	Number
PropagateBufferReducePercentage	Minimum percentage of free buffer size required to perform a reduction.	Number
PropagateConfigFileName	Name of the propagation configuration file.	Path

Propagation parameters

On this page