Configuration Options
The following is an overview of all available configuration options in Nova. For a sample configuration file, refer to Sample Configuration File.
DEFAULT
- listen_ip
- Type:
string
- Default:
127.0.0.1
IP address on which the DEEPaaS API will listen.
The DEEPaaS API service listens on this IP address for incoming requests.
- listen_port
- Type:
port number
- Default:
5000
- Minimum Value:
0
- Maximum Value:
65535
Port on which the DEEPaaS API will listen.
The DEEPaaS API service listens on this port number for incoming requests.
- base_path
- Type:
string
- Default:
''
Base path for the API. This is useful when the API is served behind a reverse proxy that is not at the root of the domain. For example, if the API is served at https://example.com/deepaas, then the base path should be set to /deepaas. Defaults to the root of the domain.
- train_endpoint
- Type:
boolean
- Default:
True
Specify whether DEEPaaS should provide a train endpoint (default: True).
- predict_endpoint
- Type:
boolean
- Default:
True
Specify whether DEEPaaS should provide a predict endpoint (default: True).
- debug_endpoint
- Type:
boolean
- Default:
False
Enable debug endpoint. If set we will provide all the information that you print to the standard output and error (i.e. stdout and stderr) through the “/debug” endpoint. Default is to not provide this information. This will not provide logging information about the API itself.
- doc_endpoint
- Type:
boolean
- Default:
True
Enable documentation endpoint. If set we will provide the documentation through the “/api” endpoint. Default is to provide this information.
- workers
- Type:
integer
- Default:
1
Specify the number of workers to spawn. If using a CPU you probably want to increase this number, if using a GPU probably you want to leave it to 1. (defaults to 1)
- client_max_size
- Type:
integer
- Default:
0
- Minimum Value:
0
Client’s maximum size in a request, in bytes. If a POST request exceeds this value, it raises an HTTPRequestEntityTooLarge exception. If set to 0, no file size limit will be enforced.
- warm
- Type:
boolean
- Default:
True
Pre-warm the modules (eg. load models, do preliminary checks, etc). You might want to disable this option if DEEPaaS is loading more than one module because you risk getting out of memory errors.
- model_name
- Type:
string
- Default:
''
Specify the model to be used. If not specified, DEEPaaS will serve all the models that are available. If specified, DEEPaaS will serve only the specified model. You can also use the DEEPAAS_V2_MODEL environment variable.
- WARNING: Serving multiple models is deprecated and will be removed in the future,
therefore it is strongly suggested that you specify the model you want to or that you ensure that only one model is available.
Logging options
DEFAULT
- debug
- Type:
boolean
- Default:
False
- Mutable:
This option can be changed without restarting.
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
- log_config_append
- Type:
string
- Default:
<None>
- Mutable:
This option can be changed without restarting.
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).
Deprecated Variations Group
Name
DEFAULT
log-config
DEFAULT
log_config
- log_date_format
- Type:
string
- Default:
%Y-%m-%d %H:%M:%S
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
- log_file
- Type:
string
- Default:
<None>
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
Deprecated Variations Group
Name
DEFAULT
logfile
- log_dir
- Type:
string
- Default:
<None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Deprecated Variations Group
Name
DEFAULT
logdir
- watch_log_file
- Type:
boolean
- Default:
False
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
- use_syslog
- Type:
boolean
- Default:
False
Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
- use_journal
- Type:
boolean
- Default:
False
Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.
- syslog_log_facility
- Type:
string
- Default:
LOG_USER
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
- use_json
- Type:
boolean
- Default:
False
Use JSON formatting for logging. This option is ignored if log_config_append is set.
- use_stderr
- Type:
boolean
- Default:
False
Log output to standard error. This option is ignored if log_config_append is set.
- use_eventlog
- Type:
boolean
- Default:
False
Log output to Windows Event Log.
- log_rotate_interval
- Type:
integer
- Default:
1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
- log_rotate_interval_type
- Type:
string
- Default:
days
- Valid Values:
Seconds, Minutes, Hours, Days, Weekday, Midnight
Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.
- max_logfile_count
- Type:
integer
- Default:
30
Maximum number of rotated log files.
- max_logfile_size_mb
- Type:
integer
- Default:
200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
- log_rotation_type
- Type:
string
- Default:
none
- Valid Values:
interval, size, none
Log rotation type.
Possible values
- interval
Rotate logs at predefined time intervals.
- size
Rotate logs once they reach a predefined size.
- none
Do not rotate log files.
- logging_context_format_string
- Type:
string
- Default:
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s
Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter
- logging_default_format_string
- Type:
string
- Default:
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
- logging_debug_format_suffix
- Type:
string
- Default:
%(funcName)s %(pathname)s:%(lineno)d
Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
- logging_exception_prefix
- Type:
string
- Default:
%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
- logging_user_identity_format
- Type:
string
- Default:
%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s
Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter
- default_log_levels
- Type:
list
- Default:
['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
- publish_errors
- Type:
boolean
- Default:
False
Enables or disables publication of error events.
- instance_format
- Type:
string
- Default:
"[instance: %(uuid)s] "
The format for an instance that is passed with the log message.
- instance_uuid_format
- Type:
string
- Default:
"[instance: %(uuid)s] "
The format for an instance UUID that is passed with the log message.
- rate_limit_interval
- Type:
integer
- Default:
0
Interval, number of seconds, of log rate limiting.
- rate_limit_burst
- Type:
integer
- Default:
0
Maximum number of logged messages per rate_limit_interval.
- rate_limit_except_level
- Type:
string
- Default:
CRITICAL
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
- fatal_deprecations
- Type:
boolean
- Default:
False
Enables or disables fatal status of deprecations.