LoggingMeshClient

Struct LoggingMeshClient 

Source
pub struct LoggingMeshClient { /* private fields */ }
Expand description

LoggingMeshClient is the Python-facing handle for distributed logging over a ProcMesh.

Calling spawn(...) builds three pieces of logging infra:

  • client_actor: a single LogClientActor running in the local process. It aggregates forwarded stdout/stderr, batches it, and coordinates sync flush barriers.

  • forwarder_mesh: (optional) an ActorMesh<LogForwardActor> with one actor per remote proc. Each LogForwardActor sits in that proc and forwards its stdout/stderr back to the client. This mesh only exists if MESH_ENABLE_LOG_FORWARDING was true at startup; otherwise it’s None and we never spawn any forwarders.

  • logger_mesh: an ActorMesh<LoggerRuntimeActor> with one actor per remote proc. Each LoggerRuntimeActor controls that proc’s Python logging runtime (log level, handlers, etc.). This mesh is always created, even if forwarding is disabled.

The Python object you get back holds references to all of this so that you can:

  • toggle streaming vs “stay quiet” (set_mode(...)),
  • adjust the per-proc Python log level (set_mode(...)),
  • force a sync flush of forwarded output and wait for completion (flush(...)).

Drop semantics: Dropping the Python handle runs Drop on this Rust struct, which drains/stops the local LogClientActor but does not synchronously tear down the per-proc meshes. The remote LogForwardActor / LoggerRuntimeActor instances keep running until the remote procs themselves are shut down (e.g. via host_mesh.shutdown(...) in tests).

Trait Implementations§

Source§

impl Drop for LoggingMeshClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'py> IntoPyObject<'py> for LoggingMeshClient

Source§

type Target = LoggingMeshClient

The Python output type
Source§

type Output = Bound<'py, <LoggingMeshClient as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for LoggingMeshClient

Source§

type Frozen = True

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for LoggingMeshClient

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// `LoggingMeshClient` is the Python-facing handle for distributed /// logging over a `ProcMesh`. /// /// Calling `spawn(...)` builds three pieces of logging infra: /// /// - `client_actor`: a single `LogClientActor` running in the /// *local* process. It aggregates forwarded stdout/stderr, /// batches it, and coordinates sync flush barriers. /// /// - `forwarder_mesh`: (optional) an `ActorMesh<LogForwardActor>` /// with one actor per remote proc. Each `LogForwardActor` sits in /// that proc and forwards its stdout/stderr back to the client. /// This mesh only exists if `MESH_ENABLE_LOG_FORWARDING` was `true` /// at startup; otherwise it's `None` and we never spawn any /// forwarders. /// /// - `logger_mesh`: an `ActorMesh<LoggerRuntimeActor>` with one /// actor per remote proc. Each `LoggerRuntimeActor` controls that /// proc's Python logging runtime (log level, handlers, etc.). /// This mesh is always created, even if forwarding is disabled. /// /// The Python object you get back holds references to all of this so /// that you can: /// - toggle streaming vs "stay quiet" (`set_mode(...)`), /// - adjust the per-proc Python log level (`set_mode(...)`), /// - force a sync flush of forwarded output and wait for completion /// (`flush(...)`). /// /// Drop semantics: /// Dropping the Python handle runs `Drop` on this Rust struct, /// which drains/stops the local `LogClientActor` but does *not* /// synchronously tear down the per-proc meshes. The remote /// `LogForwardActor` / `LoggerRuntimeActor` instances keep running /// until the remote procs themselves are shut down (e.g. via /// `host_mesh.shutdown(...)` in tests).

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<LoggingMeshClient>

This handles following two situations: Read more
Source§

type Inventory = Pyo3MethodsInventoryForLoggingMeshClient

Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder LoggingMeshClient

Source§

type Holder = Option<PyClassGuard<'a, LoggingMeshClient>>

Source§

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

Source§

impl PyTypeInfo for LoggingMeshClient

Source§

const NAME: &'static str = "LoggingMeshClient"

Class name.
Source§

const MODULE: Option<&'static str>

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
Source§

impl DerefToPyAny for LoggingMeshClient

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<A, M> Handler<IndexedErasedUnbound<M>> for A
where A: Handler<M>, M: Castable,

Source§

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, A>, msg: IndexedErasedUnbound<M>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, A: 'async_trait,

Handle the next M-typed message.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoPyObjectBox for T
where T: for<'py> IntoPyObject<'py> + Send,

Source§

fn into_py_object(self: Box<T>, py: Python<'_>) -> Result<Py<PyAny>, PyErr>

§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = <T as PyTypeInfo>::NAME

Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
§

impl<T> QuoteExt for T
where T: ?Sized,

§

fn push_quoted<'q, Q, S>(&mut self, _q: Q, s: S)
where Q: QuoteInto<T>, S: Into<Quotable<'q>>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<M> Message for M
where M: Send + Sync + 'static,

§

impl<T> Ungil for T
where T: Send,