Common Constants

File location:

  • Bundled implementation: source/server/python/const.py

  • Cluster implementation: cluster/daemon/python/const.py

const.KILL_SIGNAL
Type:

int

Environ:

BROAPT_KILL_SIGNAL

Daemon kill signal.

const.SERVER_NAME_HOST
Type:

str

Environ:

BROAPT_SERVER_HOSTs

The hostname to listen on.

const.SERVER_NAME_PORT
Type:

int

Environ:

BROAPT_SERVER_PORT

const.DOCKER_COMPOSE
Type:

str

Environ:

BROAPT_DOCKER_COMPOSE

Path to BroAPT’s compose file.

const.DUMP_PATH
Type:

str

Environ:

BROAPT_DUMP_PATH

Path to extracted files.

const.LOGS_PATH
Type:

str

Environ:

BROAPT_LOGS_PATH

Path to log files.

const.API_LOGS
Type:

str

Environ:

BROAPT_API_LOGS

Path to API runtime logs.

const.API_ROOT
Type:

str

Environ:

BROAPT_API_ROOT

Path to detection APIs.

const.INTERVAL
Type:

float

Environ:

BROAPT_INTERVAL

Sleep interval.

const.MAX_RETRY
Type:

str

Environ:

BROAPT_MAX_RETRY

Command retry.

const.EXIT_SUCCESS = 0
Type:

int

Exit code upon success.

const.EXIT_FAILURE = 1
Type:

int

Exit code upon failure.

const.FILE
Type:

str

os.path.join(LOGS_PATH, 'dump.log')

Path to file system database of processed extracted files.

const.FAIL
Type:

str

os.path.join(LOGS_PATH, 'fail.log')

Path to file system database of failed processing extracted files.