Struct OsLogLayer 

pub struct OsLogLayer { /* private fields */ }

Available on Apple only.

A composable [tracing_subscriber::Layer] that writes to Apple unified logging.

Implementations

impl OsLogLayer

pub fn new( subsystem: impl AsRef<str>, category: impl AsRef<str>, ) -> Result<Self, OsLogError>

Create a layer for one fixed Apple subsystem/category pair.

Apple caches these pairs for the lifetime of the process, so callers should create a small, fixed set rather than derive categories from request or span data.

pub fn with_privacy(self, privacy: Privacy) -> Self

Set the privacy applied to all dynamic text emitted by this layer.

pub fn set_privacy(&mut self, privacy: Privacy) -> &mut Self

Set the privacy applied to all dynamic text emitted by this layer.

pub fn with_span_mode(self, span_mode: SpanMode) -> Self

Configure native signpost export for spans.

Defaults to SpanMode::Signposts.

pub fn set_span_mode(&mut self, span_mode: SpanMode) -> &mut Self

Configure native signpost export for spans.

Defaults to SpanMode::Signposts.

pub fn with_level_map(self, level_map: LevelMap) -> Self

Set the tracing-to-Apple level mapping.

pub fn set_level_map(&mut self, level_map: LevelMap) -> &mut Self

Set the tracing-to-Apple level mapping.

pub fn with_target(self, include_target: bool) -> Self

Include or omit the tracing target in event and signpost messages.

pub fn set_target(&mut self, include_target: bool) -> &mut Self

Include or omit the tracing target in event and signpost messages.

pub fn with_span_context(self, include_span_context: bool) -> Self

Include or omit the event’s explicit/contextual span path and fields.

pub fn set_span_context(&mut self, include_span_context: bool) -> &mut Self

Include or omit the event’s explicit/contextual span path and fields.

pub fn with_max_message_bytes(self, max_message_bytes: usize) -> Self

Bound the formatted dynamic payload.

Apple caps persisted dynamic content at roughly 1 KiB. Values below three bytes are raised to three so truncation can be represented by ....

pub fn set_max_message_bytes(&mut self, max_message_bytes: usize) -> &mut Self

Bound the formatted dynamic payload.

Apple caps persisted dynamic content at roughly 1 KiB. Values below three bytes are raised to three so truncation can be represented by ....

Trait Implementations

impl Clone for OsLogLayer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OsLogLayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Layer<S> for OsLogLayer

where S: Subscriber + for<'lookup> LookupSpan<'lookup>,

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.

fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.

fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a Subscriber.

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite.

fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current [Context], similarly to Subscriber::enabled.

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>

where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer.

fn with_subscriber(self, inner: S) -> Layered<Self, S>

where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber.

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>

where Self: Sized, F: Filter<S>,

Available on crate features registry and std only.

Combines self with a [Filter], returning a Filtered layer.

fn boxed(self) -> Box<dyn Layer<S> + Sync + Send>

where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

Available on crate features alloc or std only.

Erases the type of this [Layer], returning a Boxed dyn Layer trait object.