rsb.introspection¶

This package contains partial introspection functionality for RSB.

The introspection functionality is implemented in terms of RSB events and thus built on top of “ordinary” RSB communication.

This package implements the “local introspection” (i.e. introspection sender) part of the introspection architecture.

Code author: jmoringe

Functions

`handle_participant_creation`(participant[, …])	Notify about a created participant.
`handle_participant_destruction`(participant)	Notify about a removed participant.
`host_id`()	Return a unique id string for the current host.
`machine_type`()
`machine_version`()
`participant_scope`(participant_id[, base_scope])
`process_scope`(host_id, process_id[, base_scope])
`process_start_time`()	Return the start time of the current process (or an approximation).
`program_name`()
`rsb_initialize`()	Initialize the introspection module.

Classes

`HostInfo`([host_id, hostname, machine_type, …])	Instances of this class store information about a host.
`IntrospectionSender`()	Sends introspection information to other RSB processes.
`ParticipantInfo`(kind, participant_id, scope, …)	Instances of this class store information about a participant.
`ProcessInfo`([process_id, program_name, …])	Stores information about operating system processes.

class rsb.introspection.HostInfo(host_id='ca3da57ca9d08ecb38950efe5a0cc06c', hostname='travis-job-cd21fa78-a0e7-45a8-b2eb-af77fea00efb', machine_type='x86_64', machine_version='Intel(R) Xeon(R) CPU @ 2.30GHz', software_type='linux', software_version='4.4.0-101-generic')¶

Bases: object

Instances of this class store information about a host.

The stored information can describe the local host or a remote host.

Code author: jmoringe

property host_id¶

Return the unique id string for the host.

Returns: The platform-dependent, (hopefully) unique id string.
Rtype: str or None

property hostname¶

Return the hostname of the host.

Returns: The hostname.
Rtype: str

property machine_type¶

Return the type of the machine, usually CPU architecture.

Returns: The machine type when known.
Rtype: str or NoneType

property machine_version¶

Return the version of the machine within its type.

Usually the CPU identification string.

Returns: The machine version when known.
Rtype: str or NoneType

property software_type¶

Return the type of the operating system running on the host.

Usually the kernel name.

Returns: The software type when known.
Rtype: str or NoneType

property software_version¶

Return version information about the operating systems.

Provides the version of the operating system within its type, usually the kernel version string.

Returns: The software version when known.
Rtype: str or NoneType

class rsb.introspection.IntrospectionSender¶

Bases: object

Sends introspection information to other RSB processes.

Instances of this class (usually zero or one per process) send information about participants in the current process, the current process itself and the local host to receivers of introspection information.

Instances need to be notified of created and destroyed participants via calls of the add_participant and remove_participant methods.

Code author: jmoringe

add_participant(participant, parent=None)¶

deactivate()¶

remove_participant(participant)¶

send_bye(participant)¶

send_hello(participant, query=None)¶

send_pong(participant, query=None)¶

property host¶

property process¶

class rsb.introspection.ParticipantInfo(kind, participant_id, scope, data_type, parent_id=None, transport_urls=None)¶

Bases: object

Instances of this class store information about a participant.

The participant can reside in the current process or in a remote process.

Code author: jmoringe

property data_type¶

Return a representation of the type of the participant, if available.

Note that this is a temporary solution and will change in future versions.

Returns: A representation of the type.
Rtype: type or tuple

property kind¶

Return the kind of the participant.

Examples include “listener”, “informer” and “local-server”.

Returns: A lower-case, hyphen-separated string identifying the kind of participant.
Rtype: str

property parent_id¶

Return the unique id of the parent participant.

May return None if no parent participant exists.

Returns: None or the unique id of the participant’s parent.
Rtype: uuid.uuid or NoneType

property participant_id¶

Return the unique id of the participant.

Returns: The unique id of the participant.
Rtype: uuid.uuid

property scope¶

Return the scope of the participant.

Returns: The scope of the participant.
Rtype: rsb.Scope

property transport_urls¶

Return list of transport URLs.

Returns: List of transport URLs describing the transports used by the participant.
Rtype: list

class rsb.introspection.ProcessInfo(process_id=10982, program_name='python3.6 /home/travis/virtualenv/python3.6.3/bin/sphinx-build', arguments=['/home/travis/virtualenv/python3.6.3/bin/sphinx-build', '-a', '.', 'build'], start_time=1559864225.42, executing_user=None, rsb_version='1.0.0-dev-archive')¶

Bases: object

Stores information about operating system processes.

The stored information can describe the current process, a different process on the local machine or a remote process.

Code author: jmoringe

property arguments¶

Return the list of commandline argument to the process.

Returns: A list of commandline argument strings
Rtype: list

property executing_user¶

Return the login- or account-name of the user executing the process.

Returns: login- or account-name of the user executing the process or None if not determinable
Rtype: str

property process_id¶

Return the numeric id of the process.

Returns: The numeric id of the process.
Rtype: int

property program_name¶

Return the name of the program being executed in the process.

Returns: The name of the program.
Rtype: str

property rsb_version¶

Return the version of the RSB implementation used in this process.

Returns

Version string of the form:

MAJOR.MINOR.REVISION[-COMMIT]

Rtype

str

property start_time¶

Return the start time of the process.

Returns: start time in fractional seconds since UNIX epoch.
Rtype: float

rsb.introspection.handle_participant_creation(participant, parent=None)¶

Notify about a created participant.

This function is intended to be connected to rsb.participant_creation_hook and calls IntrospectionSender.add_participant when appropriate, first creating the IntrospectionSender instance, if necessary.

rsb.introspection.handle_participant_destruction(participant)¶

Notify about a removed participant.

This function is intended to be connected to rsb.participant_destruction_hook and calls IntrospectionSender.remove_participant when appropriate, potentially deleting the IntrospectionSender instance afterwards.

rsb.introspection.host_id()¶

Return a unique id string for the current host.

Returns: A platform-dependent, string (hopefully) uniquely identifying the current host or None if such an id cannot be obtained.
Rtype: str or NoneType

rsb.introspection.machine_type()¶

rsb.introspection.machine_version()¶

rsb.introspection.participant_scope(participant_id, base_scope=Scope('/__rsb/introspection/participants/'))¶

rsb.introspection.process_scope(host_id, process_id, base_scope=Scope('/__rsb/introspection/hosts/'))¶

rsb.introspection.process_start_time()¶

Return the start time of the current process (or an approximation).

Returns: Start time in factional seconds since UNIX epoch.
Rtype: float

rsb.introspection.program_name()¶

rsb.introspection.rsb_initialize()¶

Initialize the introspection module.

Plugin hook implementation.

rsb.introspection.BASE_SCOPE = Scope('/__rsb/introspection/')¶

rsb.introspection.HOSTS_SCOPE = Scope('/__rsb/introspection/hosts/')¶

rsb.introspection.PARTICIPANTS_SCOPE = Scope('/__rsb/introspection/participants/')¶