mvx-lib
COMMON
Version history
Unreleased
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Installation
Errors
StructuredError
ReasonedError
InvalidFunctionArgumentError
RuntimeExtendedError
RuntimeUnexpectedError
Helpers
get_func_module_and_qualname
api_error_processor
run_with_cancellation_policy
Logger
From the author
Getting started
Starting to use MVX Logger
Logging contexts (LogContext)
Context naming rules
Creating and getting a context
Context configuration
Context usage
Logging pipeline
Logging event (LogEvent)
Event policy
Event metadata
Pattern event policy
Writing an event policy
Configuring event policy
Payload processor
Payload depth
Configuring processor
Error payloads
Default payload processor (LogPayloadProcessor)
Settings
Normalization rules
Object-provided payloads
External object adapters
Custom processor
Sinks
Stream sink
File sink
Custom sinks
Logging infrastructure errors
Architecture
Event model
Context tree
Policy and payload separation
Pattern event policy
Sink delivery
AsyncioLogSink
Package bootstrap
Error boundaries
Thread safety
Log components
log_invocation
Invocation lifecycle
Context resolution
Payload fields
Result logging
Error and cancellation handling
Verbosity
Context formatter
Examples
Public API method
Context fields
Invoke kwargs
Result logging
Error policy
Cancellation
Context formatter
Standalone function
Awaitable result
Verbosity
Architecture
API
Advanced Usage
Direct LogContext usage
Custom payload provider
Custom sink
Asyncio sink backend
Embedding in libraries
Manual LogEvent emission
Custom payload processor
API
Package-level API
LogContext
Events
Event policy
Pattern event policy
Payload processing
Sinks
Ready-to-use sinks
Stream sink
File sink
Sink components
Sink contracts
AsyncioLogSink
Errors
mvx-lib
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
_dispatch_core() (mvx.common.logger.AsyncioLogSink method)
_on_starting() (mvx.common.logger.AsyncioLogSink method)
_on_stopped() (mvx.common.logger.AsyncioLogSink method)
A
ALLOW (mvx.common.logger.PatternLogEventPolicyAction attribute)
api_error_processor() (in module mvx.common.helpers)
AsyncioLogSink (class in mvx.common.logger)
AsyncioLogSinkDispatcherCancelledError (class in mvx.common.logger)
AsyncioLogSinkError (class in mvx.common.logger)
AsyncioLogSinkEventLoopUnavailableError (class in mvx.common.logger)
AsyncioLogSinkInvalidStateError (class in mvx.common.logger)
AsyncioLogSinkOnStartingHookFailedError (class in mvx.common.logger)
AsyncioLogSinkOnStoppedHookFailedError (class in mvx.common.logger)
AsyncioLogSinkOpResult (class in mvx.common.logger)
AsyncioLogSinkQueueOverflowError (class in mvx.common.logger)
AsyncioLogSinkUnexpectedError (class in mvx.common.logger)
AsyncioLogSinkWaitHandle (class in mvx.common.logger)
B
build_descriptor() (mvx.common.logger.AsyncioLogSink class method)
(mvx.common.logger.FileLogSink class method)
(mvx.common.logger.LogSinkClassProto class method)
(mvx.common.logger.StreamLogSink class method)
build_error_payload() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
C
CancellationPolicy (class in mvx.common.helpers)
CANCELLED (mvx.common.logger.AsyncioLogSinkState attribute)
close() (mvx.common.logger.StreamLogSink method)
close_log_sink() (in module mvx.common.logger)
configure_log_context() (in module mvx.common.logger)
configure_log_sink() (in module mvx.common.logger)
create() (mvx.common.logger.AsyncioLogSink class method)
(mvx.common.logger.FileLogSink class method)
(mvx.common.logger.LogSinkClassProto class method)
(mvx.common.logger.StreamLogSink class method)
CRITICAL (mvx.common.logger.LogLevel attribute)
D
DEBUG (mvx.common.logger.LogLevel attribute)
DENY (mvx.common.logger.PatternLogEventPolicyAction attribute)
DISPATCHER_UNEXPECTEDLY_CANCELLED (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
DROP (mvx.common.logger.AsyncioLogSinkQueueOverflowPolicy attribute)
E
emit_log_event() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
encoding (mvx.common.logger.LoggingFileConfig property)
ERROR (mvx.common.logger.LogLevel attribute)
EVENT_LOOP_UNAVAILABLE (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
event_policy (mvx.common.logger.LogContext property)
F
FAILURE (mvx.common.logger.AsyncioLogSinkState attribute)
file_path (mvx.common.logger.LoggingFileConfig property)
FileLogSink (class in mvx.common.logger)
from_mapping() (mvx.common.logger.PatternLogEventPolicyConfig class method)
(mvx.common.logger.PatternLogEventPolicyRuleConfig class method)
G
get_configured_log_sink_names() (in module mvx.common.logger)
get_local_log_sink() (mvx.common.logger.LogContext method)
get_log_context() (in module mvx.common.logger)
(mvx.common.logger.LogContextProviderProto method)
get_log_context_namespaces() (in module mvx.common.logger)
get_log_sink() (in module mvx.common.logger)
get_plain_verbosity_level() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
(mvx.common.logger.LogPayloadProcessor method)
(mvx.common.logger.LogPayloadProcessorProto method)
get_root_log_context() (in module mvx.common.logger)
get_status() (mvx.common.logger.AsyncioLogSink method)
H
has_configured_log_sinks() (in module mvx.common.logger)
has_log_context() (in module mvx.common.logger)
I
identity (mvx.common.logger.LogEntityIdProviderProto property)
IGNORE (mvx.common.logger.LogErrorHandlingPolicy attribute)
INFO (mvx.common.logger.LogLevel attribute)
INVALID_LOG_SINK_STATE (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
InvalidFunctionArgumentError (class in mvx.common.errors)
is_error_logged() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
is_event_enabled() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
(mvx.common.logger.LogEventPolicyProto method)
(mvx.common.logger.PatternLogEventPolicy method)
is_root (mvx.common.logger.LogContext property)
L
log() (mvx.common.logger.AsyncioLogSink method)
(mvx.common.logger.LogSinkProto method)
(mvx.common.logger.StreamLogSink method)
log_adapter_resolver (mvx.common.logger.LogPayloadProcessor property)
log_debug_event() (mvx.common.logger.LogContext method)
log_error_event() (mvx.common.logger.LogContext method)
log_error_handling_policy (mvx.common.logger.LogContext property)
log_event() (mvx.common.logger.LogContext method)
log_info_event() (mvx.common.logger.LogContext method)
log_invocation() (in module mvx.common.logger)
log_sink (mvx.common.logger.LogContext property)
log_warning_event() (mvx.common.logger.LogContext method)
LogContext (class in mvx.common.logger)
LogContextError (class in mvx.common.logger)
LogContextProto (class in mvx.common.logger)
LogContextProviderProto (class in mvx.common.logger)
LogContextResetError (class in mvx.common.logger)
LogContextUnableToLog (class in mvx.common.logger)
LogEntityIdProviderProto (class in mvx.common.logger)
LogEvent (class in mvx.common.logger)
LogEventMeta (class in mvx.common.logger)
LogEventPolicyProto (class in mvx.common.logger)
LoggerError (class in mvx.common.logger)
LoggingFileConfig (class in mvx.common.logger)
LoggingStreamConfig (class in mvx.common.logger)
LogPayloadProcessor (class in mvx.common.logger)
LogPayloadProcessorProto (class in mvx.common.logger)
LogPayloadProvider (class in mvx.common.logger)
LogSinkClassProto (class in mvx.common.logger)
LogSinkCloseError (class in mvx.common.logger)
LogSinkConfigurationConflictError (class in mvx.common.logger)
LogSinkConfigurationError (class in mvx.common.logger)
LogSinkCreateError (class in mvx.common.logger)
LogSinkDescriptor (class in mvx.common.logger)
LogSinkDescriptorBuildError (class in mvx.common.logger)
LogSinkIsInUseError (class in mvx.common.logger)
LogSinkProto (class in mvx.common.logger)
M
mark_error_logged() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
max_items (mvx.common.logger.LogPayloadProcessor property)
max_str_len (mvx.common.logger.LogPayloadProcessor property)
MAXIMUM (mvx.common.logger.LogVerbosityLevel attribute)
MINIMAL (mvx.common.logger.LogVerbosityLevel attribute)
mode (mvx.common.logger.LoggingFileConfig property)
N
namespace (mvx.common.logger.LogContext property)
(mvx.common.logger.LogContextProto property)
NORMAL (mvx.common.logger.LogVerbosityLevel attribute)
normalize_payload() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogPayloadProcessor method)
(mvx.common.logger.LogPayloadProcessorProto method)
normalize_value_for_log() (mvx.common.logger.LogContext method)
(mvx.common.logger.LogContextProto method)
(mvx.common.logger.LogPayloadProcessor method)
(mvx.common.logger.LogPayloadProcessorProto method)
O
ON_STARTING_HOOK_FAILED (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
ON_STOPPED_HOOK_FAILED (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
P
parent (mvx.common.logger.LogContext property)
PatternLogEventPolicy (class in mvx.common.logger)
PatternLogEventPolicyConfig (class in mvx.common.logger)
PatternLogEventPolicyRuleConfig (class in mvx.common.logger)
payload_processor (mvx.common.logger.LogContext property)
PRINT_STDERR (mvx.common.logger.LogErrorHandlingPolicy attribute)
Q
QUEUE_OVERFLOW (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
R
RAISE (mvx.common.logger.LogErrorHandlingPolicy attribute)
RAISE_ERROR (mvx.common.logger.AsyncioLogSinkQueueOverflowPolicy attribute)
ReasonedError (class in mvx.common.errors)
reset_event_policy() (mvx.common.logger.LogContext method)
reset_log_adapter_resolver() (mvx.common.logger.LogPayloadProcessor method)
reset_log_contexts() (in module mvx.common.logger)
reset_log_error_handling_policy() (mvx.common.logger.LogContext method)
reset_log_sink() (mvx.common.logger.LogContext method)
reset_logger() (in module mvx.common.logger)
reset_max_items() (mvx.common.logger.LogPayloadProcessor method)
reset_max_str_len() (mvx.common.logger.LogPayloadProcessor method)
reset_payload_processor() (mvx.common.logger.LogContext method)
reset_verbosity_level() (mvx.common.logger.LogPayloadProcessor method)
run_with_cancellation_policy() (in module mvx.common.helpers)
RUNNING (mvx.common.logger.AsyncioLogSinkState attribute)
RuntimeExtendedError (class in mvx.common.errors)
RuntimeUnexpectedError (class in mvx.common.errors)
S
set_event_policy() (mvx.common.logger.LogContext method)
set_log_adapter_resolver() (mvx.common.logger.LogPayloadProcessor method)
set_log_error_handling_policy() (mvx.common.logger.LogContext method)
set_log_sink() (mvx.common.logger.LogContext method)
set_max_items() (mvx.common.logger.LogPayloadProcessor method)
set_max_str_len() (mvx.common.logger.LogPayloadProcessor method)
set_payload_processor() (mvx.common.logger.LogContext method)
set_verbosity_level() (mvx.common.logger.LogPayloadProcessor method)
START (mvx.common.logger.AsyncioLogSinkOp attribute)
start() (mvx.common.logger.AsyncioLogSink method)
STARTING (mvx.common.logger.AsyncioLogSinkState attribute)
STDERR (mvx.common.logger.LogStreamOutput attribute)
STDOUT (mvx.common.logger.LogStreamOutput attribute)
STOP (mvx.common.logger.AsyncioLogSinkOp attribute)
stop() (mvx.common.logger.AsyncioLogSink method)
STOPPED (mvx.common.logger.AsyncioLogSinkState attribute)
STOPPING (mvx.common.logger.AsyncioLogSinkState attribute)
stream_output (mvx.common.logger.LoggingStreamConfig property)
StreamLogSink (class in mvx.common.logger)
StructuredError (class in mvx.common.errors)
T
to_log_payload() (mvx.common.errors.ReasonedError method)
(mvx.common.errors.RuntimeExtendedError method)
(mvx.common.errors.StructuredError method)
(mvx.common.logger.LogPayloadProvider method)
(mvx.common.logger.LogSinkDescriptor method)
U
UNEXPECTED_ERROR (mvx.common.logger.AsyncioLogSinkErrorReason attribute)
V
verbosity_level (mvx.common.logger.LogPayloadProcessor property)
VIRGIN (mvx.common.logger.AsyncioLogSinkState attribute)
W
wait() (mvx.common.logger.AsyncioLogSinkWaitHandle method)
WARNING (mvx.common.logger.LogLevel attribute)
with_detail() (mvx.common.errors.StructuredError method)
with_details() (mvx.common.errors.StructuredError method)