Skip to content
master
Switch branches/tags
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Feb 13, 2020

README.md


Pulse Logo


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 recorded locally and never leave your device.





promo-4


promo-5


promo-1


promo-2


promo-3


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 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.

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.

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 messages = try LoggerMessageStore.default.allMessages()

// NSPersistentContainer
let container = LoggerMessageStore.default.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

Pulse macOS pre-Alpha is now available as early access. Requires Big Sur. No optimizations have been done yet.


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.

About

Structured Logging System

Resources

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages