Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.logger Namespace Reference

Namespaces

 const
 
 helpers
 
 websocket_api
 

Functions

None _add_log_filter (logging.Logger logger, list[re.Pattern] patterns)
 
type[logging.Logger] _get_logger_class (dict[str, int] hass_overrides)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _VALID_LOG_LEVEL = vol.All(vol.Upper, vol.In(LOGSEVERITY), LOGSEVERITY.__getitem__)
 
 CONFIG_SCHEMA
 
 SERVICE_SET_DEFAULT_LEVEL_SCHEMA = vol.Schema({ATTR_LEVEL: _VALID_LOG_LEVEL})
 
 SERVICE_SET_LEVEL_SCHEMA = vol.Schema({cv.string: _VALID_LOG_LEVEL})
 

Detailed Description

Support for setting the level of logging for components.

Function Documentation

◆ _add_log_filter()

None homeassistant.components.logger._add_log_filter ( logging.Logger  logger,
list[re.Pattern]  patterns 
)
private
Add a Filter to the logger based on a regexp of the filter_str.

Definition at line 104 of file __init__.py.

◆ _get_logger_class()

type[logging.Logger] homeassistant.components.logger._get_logger_class ( dict[str, int]  hass_overrides)
private
Create a logger subclass.

logging.setLoggerClass checks if it is a subclass of Logger and
so we cannot use partial to inject hass_overrides.

Definition at line 113 of file __init__.py.

◆ async_setup()

bool homeassistant.components.logger.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the logger component.

Definition at line 52 of file __init__.py.

Variable Documentation

◆ _VALID_LOG_LEVEL

homeassistant.components.logger._VALID_LOG_LEVEL = vol.All(vol.Upper, vol.In(LOGSEVERITY), LOGSEVERITY.__getitem__)
private

Definition at line 33 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.logger.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Optional(LOGGER_DEFAULT): _VALID_LOG_LEVEL,
6  vol.Optional(LOGGER_LOGS): vol.Schema({cv.string: _VALID_LOG_LEVEL}),
7  vol.Optional(LOGGER_FILTERS): vol.Schema({cv.string: [cv.is_regex]}),
8  }
9  )
10  },
11  extra=vol.ALLOW_EXTRA,
12 )

Definition at line 38 of file __init__.py.

◆ SERVICE_SET_DEFAULT_LEVEL_SCHEMA

homeassistant.components.logger.SERVICE_SET_DEFAULT_LEVEL_SCHEMA = vol.Schema({ATTR_LEVEL: _VALID_LOG_LEVEL})

Definition at line 35 of file __init__.py.

◆ SERVICE_SET_LEVEL_SCHEMA

homeassistant.components.logger.SERVICE_SET_LEVEL_SCHEMA = vol.Schema({cv.string: _VALID_LOG_LEVEL})

Definition at line 36 of file __init__.py.