whylogs.app.config
Classes/functions for configuring the whylogs app
.. autodata:: ALL_SUPPORTED_FORMATS
#
ALL_SUPPORTED_FORMATSSupported output formats for whylogs writer configuration
#
WriterConfig ObjectsConfig for whylogs writers
See also:
- :class:
WriterConfigSchema
- :class:
whylogs.app.writers.Writer
- :func:
whylogs.app.writers.writer_from_config
#
Parameterstype : str
Destination for the writer output, e.g. 'local' or 's3'
formats : list
All output formats. See :data:ALL_SUPPORTED_FORMATS
output_path : str
Prefix of where to output files. A directory for type = 'local'
,
or key prefix for type = 's3'
path_template : str, optional
Templatized path output using standard python string templates.
Variables are accessed via $identifier or ${identifier}.
See :func:whylogs.app.writers.Writer.template_params
for a list of
available identifers.
Default = :data:whylogs.app.writers.DEFAULT_PATH_TEMPLATE
filename_template : str, optional
Templatized output filename using standardized python string templates.
Variables are accessed via $identifier or ${identifier}.
See :func:whylogs.app.writers.Writer.template_params
for a list of
available identifers.
Default = :data:whylogs.app.writers.DEFAULT_FILENAME_TEMPLATE
#
to_yamlSerialize this config to YAML
#
Parametersstream If None (default) return a string, else dump the yaml into this stream.
#
from_yamlLoad config from yaml
#
Parametersstream : str, file-obj String or file-like object to load yaml from
kwargs ignored
#
Returnsconfig : WriterConfig
Generated config
#
SessionConfig ObjectsConfig for a whylogs session.
See also :class:SessionConfigSchema
#
Parametersproject : str
Project associated with this whylogs session
pipeline : str
Name of the associated data pipeline
writers : list
A list of WriterConfig
objects defining writer outputs
verbose : bool, default=False
Output verbosity
with_rotation_time: str, default = None, to rotate profiles with time, takes values of overall rotation interval,
"s" for seconds
"m" for minutes
"h" for hours
"d" for days
cache_size: int default =1, sets how many dataprofiles to cache in logger during rotation
#
to_yamlSerialize this config to YAML
#
Parametersstream If None (default) return a string, else dump the yaml into this stream.
#
from_yamlLoad config from yaml
#
Parametersstream : str, file-obj String or file-like object to load yaml from
#
Returnsconfig : SessionConfig Generated config
#
WriterConfigSchema ObjectsMarshmallow schema for :class:WriterConfig
class.
#
SessionConfigSchema ObjectsMarshmallow schema for :class:SessionConfig
class.
#
load_configLoad logging configuration, from disk and from the environment.
Config is loaded by attempting to load files in the following order. The first valid file will be used
- Path set in
WHYLOGS_CONFIG
environment variable - Current directory's
.whylogs.yaml
file ~/.whylogs.yaml
(home directory)/opt/whylogs/.whylogs.yaml
path
#
Returnsconfig : SessionConfig, None
Config for the logger, if a valid config file is found, else returns
None
.