Need help with Pulse?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

kean
375 Stars 6 Forks 169 Commits 0 Opened issues

Description

Structured Logging System

Services available

!
?

Need anything else?

Contributors list

# 16,513
Swift
webp
Objecti...
uistack...
157 commits
# 76,169
swift-s...
snapsho...
XML
time-ma...
6 commits


Untitled-2


Pulse is a powerful logging system. Record and inspect network requests and logs right from your iOS app using Pulse Console. Share and view logs in Pulse macOS app. Logs are recoded locally and never leave your device.





promo-1


promo-2


promo-3


promo-4


About

Pulse
is not a tool, it's a framework. It records events from
URLSession
or from frameworks that use it, such as
Alamofire
, and displays them using
PulseUI
views that you integrate directly into your app.

Pulse is distributed using Swift Package Manager as a binary framework. It is built using SwiftUI and includes no resources to ensure its tiny size. The thinned

.ipa
with Pulse included takes <640 KB. You can simply leave it in your app store builds. And because it's a binary framework, it doesn't increase your compile time.

Pulse is not a network debugging proxy tool like Proxyman, Charles, or Wireshark. It won't automatically intercept all network traffic coming from your app or device.

Pulse is integrated directly into your app and is always recording (when your code tells it to). Pulse console is available for everyone who has your test builds. You or your QA team can view the logs on the device and easily share them to attach to bug reports. That's powerful.


Installation

Pulse is available only for GitHub sponsors. Once the number of sponsors reaches a certain level, the project will become available to everyone.

The access to the private project manifest is provided manually, there might be a bit of a delay before you get access after sponsoring.

Please follow the Installation Guide.


Usage: Pulse

The primary class in Pulse is

PersistentLogHandler
which can be used as a logging backend for SwiftLog.

Bootstrapping

LoggingSystem.bootstrap(PersistentLogHandler.init)

If you are not using SwiftLog in your project, you can use

Pulse.PersistentLogHandler
directly without the need for bootstrapping.

Logging

Use SwiftLog as usual to start logging messages.

let logger = Logger(label: "com.yourcompany.yourapp")

/// ...

logger.info("This message will be stored persistently")

Logging Network Request

Pulse supports logging

URLSession
tasks and offers a simple Alamofire integration.

For more information, please follow the dedicated guide.

Storage

All logged messages are stored persistently using Core Data, including metadata and other information. You get full access to all of the recorded messages at any time using

LoggerMessageStore
.
let message = try LoggerMessageStore.default.allMessage()

// NSPersistentStoreContainer let container = logger.store.container


Usage: PulseUI

PulseUI framework provides all of the views that you saw on the screenshots.

Use

MainView
(or
MainViewController
for convenient UIKit integration) to display the root view with tabs. Use
ConsoleView
,
NetworkView
, and
PinView
to display individual tabs.
let view = MainView()

Pulse views are built using SwiftUI and require iOS 13. But even if your app requires iOS 11, no need to worry. Pulse can still be easily integrated into your project. The framework itself requires iOS 11 and Pulse views can be easily added conditionally on iOS 13+. To show Pulse from UIKit, use convenience

MainViewController
class.


Pulse macOS App

Upcoming


Minimum Requirements

| Pulse | Swift | Xcode | Platforms | |---------------|-----------------|-----------------|---------------------------------------------------| | Pulse 0.9.2 | Swift 5.3 | Xcode 12.0 | iOS 11.0 (views requires iOS 13) | | Pulse 0.9.0 | Swift 5.3 | Xcode 12.0 | iOS 13.0 (Upcoming conditional iOS 11+ and other platforms) | | Pulse 0.3 | Swift 5.2 | Xcode 11.3 | iOS 11.0 / watchOS 4.0 / macOS 10.13 / tvOS 11.0 |

License

Pulse is available under the MIT license. See the LICENSE file for more info.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.