rti.logging package

Submodules

rti.logging.distlog module

class rti.logging.distlog.LogLevel

Bases: pybind11_builtins.pybind11_object

Members:

SILENT

FATAL

SEVERE

ERROR

WARNING

NOTICE

INFO

DEBUG

TRACE

DEBUG = LogLevel.DEBUG
ERROR = LogLevel.ERROR
FATAL = LogLevel.FATAL
INFO = LogLevel.INFO
NOTICE = LogLevel.NOTICE
SEVERE = LogLevel.SEVERE
SILENT = LogLevel.SILENT
TRACE = LogLevel.TRACE
WARNING = LogLevel.WARNING
property name

(self: handle) -> str

class rti.logging.distlog.Logger

Bases: pybind11_builtins.pybind11_object

debug(self: rti.logging.distlog.Logger, arg0: str) → None

Log a debug message.

error(self: rti.logging.distlog.Logger, arg0: str) → None

Log an error message.

fatal(self: rti.logging.distlog.Logger, arg0: str) → None

Log a fatal message.

property filter_level

The logger filter level.

static finalize() → None

Destroy the Logger. It should not be accessed after this call.

info(self: rti.logging.distlog.Logger, arg0: str) → None

Log an info message.

instance = <rti.logging.distlog.Logger object>
log(*args, **kwargs)

Overloaded function.

  1. log(self: rti.logging.distlog.Logger, log_level: rti.logging.distlog.LogLevel, message: str) -> None

Log a message with the given log level

  1. log(self: rti.logging.distlog.Logger, log_level: rti.logging.distlog.LogLevel, message: str, category: str) -> None

Log a message with the given log level and category

  1. log(self: rti.logging.distlog.Logger, message_params: rti.logging.distlog.MessageParams) -> None

Log a message with the given log level and category

notice(self: rti.logging.distlog.Logger, arg0: str) → None

Log a notice message.

static options(options: rti.logging.distlog.LoggerOptions) → bool

Set the options for the Logger instance (must be set prior to accessing the instance.

property print_format

The logger print format.

severe(self: rti.logging.distlog.Logger, arg0: str) → None

Log a severe message.

trace(self: rti.logging.distlog.Logger, arg0: str) → None

Log a trace message.

property verbosity

The logger’s verbosity.

warning(self: rti.logging.distlog.Logger, arg0: str) → None

Log a warning message.

class rti.logging.distlog.LoggerOptions

Bases: pybind11_builtins.pybind11_object

property application_kind

The application_kind.

property domain_id

The domain ID for logging.

property echo_to_stdout

Toggle for echo to stdout.

property filter_level

Toggle for log filter level.

property log_infrastructure_messages

Toggle for logging infrastructure messages.

property participant

The DomainParticipant to use for the logger.

property qos_library

The QoS library name.

property qos_profile

The QoS profile name.

property queue_size

The logger’s queue size.

property remote_administration_enabled

Toggle for remote administration.

property thread_settings

The settings for the thread handling logging.

class rti.logging.distlog.MessageParams

Bases: pybind11_builtins.pybind11_object

property category

The log message category.

property log_level

The message log level.

property message

The log message.

property timestamp

The timestamp of the log message.

rti.logging.handler module

class rti.logging.handler.DistlogHandler(options: Optional[distlog.LoggerOptions] = None)

Bases: logging.Handler

close() → None

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

emit(record: logging.LogRecord) → None

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

Module contents