Realm Service Configuration Parameters

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

Example

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

globals:

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

services:
    realm:
        max.logs: 100
        loglevel: warn
# ...

servers:

    ftl1:
        - realm: {}

    ftl2:
        - realm: {}

    ftl3:
        - realm: {}

Logging

Parameter Arguments Description
loglevel level When present, the realm service logs protocol communication at this level of detail.

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

When this parameter is absent, the default level is info.

logfile logfile_prefix When present, the realm 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 realm service sends log output to the console, ignoring the parameters max.log.size and max.logs.

max.log.size size Limits the maximum size, in bytes, of log files. The value must be greater than 100 kilobytes (102400). The default value is 2 megabytes (2*1024*1024).
max.logs logs Limits the maximum number of rolling log files. The default is 50.

Initial Configuration

Parameter Arguments Description
initial.realm.config filepath/filename

During the initial deployment, if this parameter is set, the contents of this file are deployed. Otherwise, the default realm configuration asset is deployed. this parameter is not used on subsequent runs of the FTL server.

Note that clients are unable to connect to the realm server until after the initial deployment has successfully completed.

The FTL server logs any validation errors regarding the contents of the initial deployment file, and deployment will fail.

Backward Compatibility

Parameter Arguments Description
http host:port Connect Port

Optional for backward compatibility with legacy clients.

Legacy clients send initial contact requests to this port. The FTL server redirects them appropriately.

host indicates one of the host computer’s network interfaces. The asterisk character (*) indicates all available interfaces.

ftl host:port Client Port

Optional for backward compatibility with legacy clients.

Connected legacy clients communicate over this port.

host indicates one of the host computer’s network interfaces. The asterisk character (*) indicates all available interfaces.