Configuration¶
Every application supports multiple means for adjusting the internal configurations. When appropriate the default values for each configuration is hardcoded in module source code. However there are several options to change the value:
- Override the internal default value when instantinating the application object by passing different value to object constructor.
- Pass the different value by configuration file.
- Pass the different value by command line option.
The configuration values are assigned from the sources mentioned above in that particular order, so the value given by command line option overwrites the value written in configuration file.
Command line parameters¶
Configuration can be passed down to application by command line options. These options have the highest priority and will overwrite any other configuration values. Depending on the base object of the application different set of options is available.
Common application options¶
Following configuration options are available for all applications based on
pyzenkit.baseapp
:
--help
- Display help and usage description and exit (flag).
--debug
Run in debug mode (flag).
Input various status information to
stderr
.Type:
boolean
, default:False
--quiet
Run in quiet mode (flag).
Do not write anything to
stdout
orstderr
.Type:
boolean
, default:False
--verbose
Increase application output verbosity (flag, repeatable).
Type:
boolean
, default:False
--name alternative-name
Alternative name for application instead of default
$0
.This value will be used to generate names for log, runlog, pid, status and other application files.
Type:
string
, default:$0
--config-file file-name
Name of the configuration file.
Type:
string
, default: autodetected--config-file-silent
Do not complain in case given configuration file does not exist (flag).
Type:
boolean
, default:False
--config-dir file-name
Name of the configuration directory.
Type:
string
, default: autodetected--config-file-silent
Do not complain in case given configuration directory does not exist (flag).
Type:
boolean
, default:False
--log-file file-name
Name of the log file.
Type:
string
, default: autodetected--log-level level
Logging level [
debug
,info
,warning
,error
,critical
].Type:
string
, default:info
--runlog-dir dir-name
Name of the runlog directory.
Type:
string
, default: autodetected--runlog-dump
Dump runlog to stdout when done processing (flag).
Type:
boolean
, default:False
--runlog-log
Write runlog to logging service when done processing (flag)
Type:
boolean
, default:False
--pstate-file file-name
Name of the persistent state file.
Type:
string
, default: autodetected--pstate-dump
Dump persistent state to stdout when done processing (flag).
Type:
boolean
, default:False
--pstate-log
Write persistent state to logging service when done processing (flag).
Type:
boolean
, default:False
--action action
Execute given quick action and exit. List of available actions can be displayed with
--help
option.Type:
string
, default:None
--user name-or-id
Name/gid of the system user for process permissions.
Type:
string
, default:None
--group name-or-id
Name/gid of the system group for process permissions.
Type:
string
, default:None
Common script options¶
Following configuration options are available on top of common applicationsoptions
for all applications based on pyzenkit.zenscript
:
--regular
Operational mode: regular script execution (flag).
Conflicts with
--shell
option.Type:
boolean
, default:False
--shell
Operational mode: manual script execution from shell (flag).
Conflicts with--regular
option.Type:
boolean
, default:False
--command name
Name of the script command to be executed.
Type:
string
, default: autodetected--interval interval
Execution interval. This value should correspond with related cron script.
Type:
string
, default:daily
--adjust-thresholds
Round-up time interval threshols to interval size (flag).
Type:
boolean
, default:False
--time-high time
Upper time interval threshold.
Type:
float
, default: time.time
Common daemon options¶
Following configuration options are available on top of common application options
for all applications based on pyzenkit.zendaemon
:
--no-daemon
Do not daemonize and stay in foreground (flag).
Type:
boolean
, default:False
--chroot-dir dir-name
Name of the chroot directory.
Type:
string
, default:None
--work-dir dir-name
Name of the process work directory.
Type:
string
, default:/
--pid-file file-name
Name of the pid file.
Type:
string
, default: autodetected--state-file file-name
Name of the state file.
Type:
string
, default: autodetected--umask mask
Default file umask.
Type:
string
, default:0o002
--stats-interval interval
Processing statistics display interval in seconds.
Type:
integer
, default:300
--runlog-interval interval
Application runlog dump interval in seconds.
Type:
integer
, default:300
--paralel
Run in paralel mode (flag).
Type:
boolean
, default:False
Configuration files and directories¶
Configurations can be passed down to application using a combination of configuration file or configuration directory. Values from configuration files override the values from configuration directories. Configuration directories can therefore be used to define common or default configuration values and those can be overriden when necessary for given application component.
The available configuration keys are very similar to command line options and the
names differ only in the use of _
character instead of -
. However there is
a certain set of configuration keys that is available only through command line
options and not through configuration file and vice versa.