Next Steps

Learn how to configure Pulse to best suit your app needs.

Console

Pulse is highly customizable and you can tweak it to best match your style and your backend. To learn more, see PulseUI: Overview.

Logger

Configure Store

LoggerStore is the primary way to configure how logs are stored. It uses a database to record logs in an efficient binary format and employs a number of space optimization techniques, including fast lzfse compression. The store automatically limits how much space it takes and also removes old logs.

LoggerStore.shared.configuration.sizeLimit = 512 * 1_000_000  

important: Make sure to change it at the app launch before sending any logs.

tip: Use LoggerStore/Options-swift.struct/inMemory if you want to prevent any logs from being recorded persistently

Exporting Logs

If you want to provide additional ways to share the logs recorded by the store, use LoggerStore/export(to:options:).

try await store.export(to: <#targetURL#>)

Export can be configured with a predicate to limit what gets exported:

var options = LoggerStore.ExportOptions(
    predicate: <#predicate#>,
    sessions: [<#sessionID#>]
)

note: The exported store is in a Pulse document format (.pulse extension)

Accessing Logs

LoggerStore uses Core Data and provides full access to its underlying entities, which you can use to access any previously stored logs, export them, or create custom views for your logs.

struct AnalyticsLogsView: View {
    @FetchRequest(
        sortDescriptors: [NSSortDescriptor(keyPath: \LoggerMessageEntity.createdAt, ascending: true)],
        predicate: NSPredicate(format: "label == %@", "analytics")
    ) var messages: FetchedResults<LoggerMessageEntity>

    var body: some View {
        List(messages, id: \.objectID) { message in
            <#view#>
        }
    }
}

important: In the current schema, the logger creates an associated LoggerMessageEntity entity for every NetworkTaskEntity, but it will likely change in the future.

Network Logging & Debugging

See doc:NetworkLogging-Article for more information about how to configure network logging if your app does not use URLSession directly, how to further customize it, how to capture and display decoding errors, and more.