bittensor.utils.btlogging.loggingmachine

Module provides a logging framework for Bittensor, managing both Bittensor-specific and third-party logging states. It leverages the StateMachine from the statemachine package to transition between different logging states such as Default, Debug, Trace, and Disabled.

Attributes

CUSTOM_LOGGER_METHOD_STACK_LEVEL

Classes

LoggingConfig	Named tuple to hold the logging configuration.
LoggingMachine	Handles logger states for bittensor and 3rd party libraries.

Module Contents

bittensor.utils.btlogging.loggingmachine.CUSTOM_LOGGER_METHOD_STACK_LEVEL = 2

class bittensor.utils.btlogging.loggingmachine.LoggingConfig

Bases: NamedTuple

Named tuple to hold the logging configuration.

debug: bool

info: bool

logging_dir: str

record_log: bool

trace: bool

class bittensor.utils.btlogging.loggingmachine.LoggingMachine(config, name=BITTENSOR_LOGGER_NAME)

Bases: statemachine.StateMachine, logging.Logger

Handles logger states for bittensor and 3rd party libraries.

Initialize the logger with a name and an optional level.

Parameters:

• config (bittensor.core.config.Config)

• name (str)

Debug

Default

Disabled

Info

Trace

Warning

classmethod add_args(parser, prefix=None)

Accept specific arguments fro parser

Parameters:

• parser (argparse.ArgumentParser)

• prefix (str)

after_disable_debug()

Logs status after disable Debug.

after_disable_trace()

Logs status after disable Trace.

after_enable_debug()

Logs status after enable Debug.

after_enable_default()

after_enable_info()

Logs status after enable info.

after_enable_trace()

Logs status after enable Trace.

after_enable_warning()

Logs status after enable Warning.

after_transition(event, state)

Starts listener after transition.

before_disable_debug()

Logs status before disable Debug.

before_disable_logging()

Prepares the logging system for disabling.

This method performs the following actions: 1. Logs an informational message indicating that logging is being disabled. 2. Disables trace mode in the stream formatter. 3. Sets the logging level to CRITICAL for all loggers.

This ensures that only critical messages will be logged after this method is called.

before_disable_trace()

Logs status before disable Trace.

before_enable_console()

Logs status before enable Console.

before_enable_debug()

Logs status before enable Debug.

before_enable_default()

Logs status before enable Default.

before_enable_info()

Logs status before enable info.

before_enable_trace()

Logs status before enable Trace.

before_enable_warning()

Logs status before enable Warning.

before_transition(event, state)

Stops listener after transition.

check_config(config)

Parameters:

config (bittensor.core.config.Config)

classmethod config()

Get config from the argument parser.

Returns:

config object

Return type:

config (bittensor.core.config.Config)

console

critical(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps critical message with prefix and suffix.

debug(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps debug message with prefix and suffix.

deregister_primary_logger(name)

De-registers a primary logger

This function removes the logger from the _primary_loggers set and deinitializes its queue handler

Parameters:

name (str) – the name of primary logger.

disable_debug

disable_info

disable_logging

disable_third_party_loggers()

Disables logging for third-party loggers by removing all their handlers.

disable_trace

disable_warning

enable_console

enable_debug

enable_default

enable_info

enable_third_party_loggers()

Enables logging for third-party loggers by adding a queue handler to each.

enable_trace

enable_warning

error(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps error message with prefix and suffix.

exception(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps exception message with prefix and suffix.

get_config()

get_level()

Returns Logging level.

Return type:

int

get_queue()

Get the queue the QueueListener is publishing from.

To set up logging in a separate process, a QueueHandler must be added to all the desired loggers.

help()

info(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps info message with prefix and suffix.

off()

Disables all states.

on()

Enable default state.

register_primary_logger(name)

Register a logger as primary logger

This adds a logger to the _primary_loggers set to ensure it doesn’t get disabled when disabling third-party loggers. A queue handler is also associated with it.

Parameters:

name (str) – the name for primary logger.

setLevel(level)

Set the specified level on the underlying logger.

set_config(config)

Set config after initialization, if desired.

Parameters:

config (bittensor.core.config.Config) – Bittensor config instance.

set_console()

Sets Console state.

set_debug(on=True)

Sets Debug state.

Parameters:

on (bool)

set_default()

Sets Default state.

set_info(on=True)

Sets Info state.

Parameters:

on (bool)

set_trace(on=True)

Sets Trace state.

Parameters:

on (bool)

set_warning(on=True)

Sets Warning state.

Parameters:

on (bool)

success(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps success message with prefix and suffix.

trace(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps trace message with prefix and suffix.

warning(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps warning message with prefix and suffix.