Logger¶
veltix.logger.core.Logger
¶
Thread-safe singleton logger backed by stdlib logging.
The logger is implemented as a singleton: calling Logger() or
Logger.get_instance() always returns the same object.
Typical usage::
from veltix import Logger
logger = Logger.get_instance()
logger.info("Server started")
get_instance
classmethod
¶
Get or create the singleton instance.
trace
¶
Log a TRACE-level message (severity 5).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
debug
¶
Log a DEBUG-level message (severity 10).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
info
¶
Log an INFO-level message (severity 20).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
success
¶
Log a SUCCESS-level message (severity 25).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
warning
¶
Log a WARNING-level message (severity 30).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
error
¶
Log an ERROR-level message (severity 40).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
critical
¶
Log a CRITICAL-level message (severity 50).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
The log message. |
required |
veltix.logger.config.LoggerConfig
dataclass
¶
Configuration for Veltix logger.
Attributes:
| Name | Type | Description |
|---|---|---|
level |
LogLevel
|
Minimum log level to display |
enabled |
bool
|
Enable/disable all logging |
use_colors |
bool
|
Enable colored output for console |
show_timestamp |
bool
|
Show timestamp in logs |
show_level |
bool
|
Show log level name |
show_caller |
bool
|
Show caller file and line number (e.g. server.py:42) |
file_path |
Optional[Union[str, Path]]
|
Path to log file |
file_rotation_size |
int
|
Max file size in bytes before rotation |
file_backup_count |
int
|
Number of backup files to keep |
stream |
TextIO
|
Output stream for console logs |
veltix.logger.levels.LogLevel
¶
Bases: IntEnum
Log severity levels.
Levels are ordered by severity, allowing simple filtering: - TRACE: Detailed debugging information - DEBUG: General debugging information - INFO: Informational messages - SUCCESS: Successful operations (between INFO and WARNING) - WARNING: Warning messages for potential issues - ERROR: Error messages for failures - CRITICAL: Critical errors requiring immediate attention