Instance Methodswift-composable-architecture 1.18.0ComposableArchitecture

signpost(_:log:)

Instruments a reducer with signposts.

@warn_unqualified_access func signpost(_ prefix: String = "", log: OSLog = OSLog(
      subsystem: "co.pointfree.ComposableArchitecture",
      category: "Reducer Instrumentation"
    )) -> _SignpostReducer<Self>

Mangled symbol

s22ComposableArchitecture7ReducerPAAE8signpost_3logAA09_SignpostC0VyxGSS_So06OS_os_E0CtF What are these?

FNV24 hash: 7YURD

Parameters

prefix: A string to print at the beginning of the formatted message for the signpost.
log: An OSLog to use for signposts.

Returns

A reducer that has been enhanced with instrumentation.

Each invocation of the reducer will be measured by an interval, and the lifecycle of its effects will be measured with interval and event signposts.

To use, build your app for profiling, create a blank instrument, and add the signpost instrument. Start recording your app you will see timing information for every action sent to the store, as well as every effect executed.

Effect instrumentation can be particularly useful for inspecting the lifecycle of long-living effects. For example, if you start an effect (e.g., a location manager) in onAppear and forget to tear down the effect in onDisappear, the instrument will show that the effect never completed.