flytekit.loggers

Directory

Methods

Method	Description
`get_level_from_cli_verbosity()`	Converts a verbosity level from the CLI to a logging level.
`initialize_global_loggers()`	Initializes the global loggers to the default configuration.
`is_display_progress_enabled()`
`is_rich_logging_enabled()`
`set_developer_properties()`	developer logger is only used for debugging.
`set_flytekit_log_properties()`	flytekit logger, refers to the framework logger.
`set_user_logger_properties()`	user_space logger, refers to the user’s logger.
`upgrade_to_rich_logging()`

Variables

Property	Type	Description
`LOGGING_DEV_ENV_VAR`	`str`
`LOGGING_ENV_VAR`	`str`
`LOGGING_FMT_ENV_VAR`	`str`
`LOGGING_RICH_FMT_ENV_VAR`	`str`

Methods

get_level_from_cli_verbosity()

        
    
def get_level_from_cli_verbosity(
    verbosity: int,
) -> int

Converts a verbosity level from the CLI to a logging level.

Parameter	Type	Description
`verbosity`	`int`	verbosity level from the CLI :return: logging level

initialize_global_loggers()

def initialize_global_loggers()

Initializes the global loggers to the default configuration.

is_display_progress_enabled()

def is_display_progress_enabled()

is_rich_logging_enabled()

def is_rich_logging_enabled()

set_developer_properties()

        
    
def set_developer_properties(
    handler: typing.Optional[logging.Handler],
    filter: typing.Optional[logging.Filter],
    level: typing.Optional[int],
)

developer logger is only used for debugging. It is possible to selectively tune the logging for the developer.

Parameter	Type	Description
`handler`	`typing.Optional[logging.Handler]`	logging.Handler to add to the user_space_logger
`filter`	`typing.Optional[logging.Filter]`	logging.Filter to add to the user_space_logger
`level`	`typing.Optional[int]`	logging level to set the user_space_logger to

set_flytekit_log_properties()

        
    
def set_flytekit_log_properties(
    handler: typing.Optional[logging.Handler],
    filter: typing.Optional[logging.Filter],
    level: typing.Optional[int],
)

flytekit logger, refers to the framework logger. It is possible to selectively tune the logging for flytekit.

Sets the flytekit logger to the specified handler, filter, and level. If any of the parameters are None, then the corresponding property on the flytekit logger will not be set.

Parameter	Type	Description
`handler`	`typing.Optional[logging.Handler]`	logging.Handler to add to the flytekit logger
`filter`	`typing.Optional[logging.Filter]`	logging.Filter to add to the flytekit logger
`level`	`typing.Optional[int]`	logging level to set the flytekit logger to

set_user_logger_properties()

        
    
def set_user_logger_properties(
    handler: typing.Optional[logging.Handler],
    filter: typing.Optional[logging.Filter],
    level: typing.Optional[int],
)

user_space logger, refers to the user’s logger. It is possible to selectively tune the logging for the user.

Parameter	Type	Description
`handler`	`typing.Optional[logging.Handler]`	logging.Handler to add to the user_space_logger
`filter`	`typing.Optional[logging.Filter]`	logging.Filter to add to the user_space_logger
`level`	`typing.Optional[int]`	logging level to set the user_space_logger to

upgrade_to_rich_logging()

        
    
def upgrade_to_rich_logging(
    log_level: typing.Optional[int],
)

Parameter	Type	Description
`log_level`	`typing.Optional[int]`