Sample YAML configuration file for the correlator
The following sample shows the format of a YAML configuration file for the correlator.
correlator:
runtime: compiled
runtime-cache: ${PARENT_DIR}/cache
environment:
KEY1: value
KEY2: value
messaging:
maxOutstandingSecs: 3.5
maxOutstandingBytes: 10000000
server:
bindAddress:
- host:${server.port}
- host:${server.port}
allowClient:
- network/mask
- network/mask
pidfile: ${PARENT_DIR}/${server.port}.pid
eplLogging:
.root: { file: foo.log }
com.myCompany.Client:
file: apama/Client.log
level: DEBUG
com.myCompany.Internal: { level: ERROR }
includes:
- myFurtherConfig.yaml
runtime,
runtime-cache and
pidfile have the same syntax and options as for the command line. See the descriptions of the
--runtime,
--runtime-cache and
--pidfile options in
Starting the correlator.
maxOutstandingSecs and
maxOutstandingBytes also have the same syntax and options as for the command line. See the descriptions of the
--maxoutstandingack and
--maxoutstandingkb options in
Starting the correlator. There is one difference however:
maxOutstandingBytes, which is specified in the YAML configuration file, counts the size in bytes (and not in kilobytes as done with
--maxoutstandingkb).
For paths, we recommend using replacements like
${PARENT_DIR} or
${APAMA_WORK} to make the configuration files portable. See also the list of predefined properties in
Using properties files.
You can use multi-line and single-line syntax for maps as shown above in the
eplLogging case. See also
Setting log files and log levels in a YAML configuration file.
You can use the
includes section to specify further YAML configuration files that are to be processed. See also
Including YAML configuration files inside another YAML configuration
file.