LogServer brick

The LogServer brick controls the use of the Endeca Log Server.

LogServer brick settings

Setting

Description

port

The port to listen on. The default value is 8002 (that is, the default Dgraph port plus two).

log_file_prefix

The file path prefix to use for log files.

gzip

If true, compresses the generated log files using gzip compression and appends a .gz suffix to the log file name.

Important: If you use this option, logs will not be written to disk as soon as they are received. That means that if the Log Server crashes unexpectedly, you may lose some log entries.

LogServer commands

The commands listed below can be used within Script bricks to control the Log Server:

Command

Description

start

Starts the Log Server.

Note: This command succeeds even if the Log Server is already started.

running

Succeeds if the Log Server is running. This operation can be used to conditionalize a script (for example, “if logserver.running …”), or to check assumptions, like an assertion that the Log Server is running at a certain time.

stop

Stops the Log Server.

Note: This command succeeds even if the Log Server is already stopped.

roll

Causes the Log Server to close its log and open a new one with a new timestamp.

In the following Windows example, the Log Server is launched:
log_server : LogServer
		port = 8002
		log_file_prefix = C:\endeca\logs\log