Persistence Service Configuration Parameters

This topic presents the FTL server configuration parameters that apply to the persistence service.

Example

This example configuration file illustrates two ways to use the persistence section. First, it sets parameters for the persistence services in all servers. Second, it specifies a uniquely named persistence service on each of three servers, without overriding any of the parameters from the global persistence section. 

globals:

    core.servers: # The set of core servers and their locations.
        ftl1: host1:8585
        ftl2: host2:8585
        ftl3: host3:8585

services:
    persistence:
        logfile: p-log
        data: p-data
        savedir: p-dump
# ...

servers:

    ftl1:
        - realm: {}
        - persistence:
            name: p-svc-1

    ftl2:
        - realm: {}
        - persistence:
            name: p-svc-2

    ftl3:
        - realm: {}
        - persistence:
            name: p-svc-3

Name

Parameter Arguments Description
name service_name Required.
Set the name of this persistence service. The service_name must match one of the service names defined in the persistence cluster definition.
Note: The service name must be distinct for each FTL server.

File I/O

Parameter Arguments Description
data path Optional. Persistence services can inherit or override this value.

When present, the persistence service stores its working data files in this path location. (The directory at path must already exist, as the persistence service does not create it automatically.)

When absent, the default path is the current directory.

The persistence service stores quorum data in this directory, but typically not messages or message acknowledgments. However, if Messaging Swapping is enabled, the persistence services swaps out data messages into a file in this directory.

savedir path Optional.

When present, the persistence service can write its state file in this path location. (The directory at path must exist, as the persistence service does not create it automatically.)

When absent, the default path is the current directory.

The state file name is always service_name.state.

A persistence service writes its state file only in response to an explicit command. This parameter specifies the location, but does not trigger a save operation. See Saving the State of a Persistence Service and POST persistence/clus_name/servers/svc_name.

This parameter does not affect loading a state file.

load path Optional.

Use this parameter when moving operations to a new physical location. After saving the state of the persistence service, copy the state file to path at the new location. Then use the load parameter to load that state when the persistence service starts at the new location.

When present, the persistence service loads its state from this state file. (Specify the complete file pathname, not only the directory path.)

When absent, the service loads its state from the default state file, service_name.state.

For more information, see Restarting a Persistence Service with Saved State.

swapdir path Optional.

When present and disk_mode is set to swap, persistence service can write its message swap file in this path location. (The directory at path must exist, as the persistence service does not create it automatically.)

When absent, the default path is the designated data directory.

See Also:

Memory Reserve

Parameter Arguments Description
mem.reserve size Optional.

When present, the persistence service reserves memory so it can continue limited operations after exhausting available memory.

The size argument specifies the amount of memory in bytes. The minimum size is 100 megabytes.

When absent, the persistence service allocates the minimum size reserve.

For more information, see Memory Reserve for Persistence Services.

Tracing and Logging

Parameter Arguments Description
loglevel level Optional. Persistence services can inherit or override this value.

When present, the persistence service outputs log messages to stderr.

You may specify any of the standard log level strings (see “Tuning the Log Level” in TIBCO FTL Development). You can set a general log level, or custom log levels for different elements.

logfile logfile_prefix Optional. Persistence services can inherit or override this value.

When present, the persistence service logs to a rolling set of log files instead of the console. The logfile_prefix argument may denote a path. All of the directories in the path must already exist.

For more information about rotating log files, see “Log Output Targets” in TIBCO FTL Development.

When absent, the persistence service sends log output to the console, ignoring the parameters max.log.size and max.logs.

max.log.size size Optional. Persistence services can inherit or override this value.

Limits the maximum size, in bytes, of log files. The value must be greater than 100 kilobytes (102400 bytes).

max.logs logs Optional. Persistence services can inherit or override this value.

Limits the maximum number of rolling log files.