https://github.com/kean/pulse

Network Logger for Apple platforms
https://github.com/kean/pulse

ios logger logging macos networking swift

Last synced: 14 days ago
JSON representation

Network Logger for Apple platforms

• Host: GitHub
• URL: https://github.com/kean/pulse
• Owner: kean
• License: mit
• Created: 2020-02-13T13:11:32.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T11:22:12.000Z (7 months ago)
• Last Synced: 2024-05-02T16:18:39.285Z (6 months ago)
• Topics: ios, logger, logging, macos, networking, swift
• Language: Swift
• Homepage: https://pulselogger.com
• Size: 6.47 MB
• Stars: 5,925
• Watchers: 58
• Forks: 282
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        








**Pulse** is a powerful logging system for Apple Platforms. Native. Built with SwiftUI.

Record and inspect logs and `URLSession` network requests right from your iOS app. Share logs and view them in [Pulse Pro](https://pulselogger.com) or use remote logging to see them in real time. Logs are stored locally and never leave your devices.

## About

`Pulse` is not just a tool, it's a framework. It records events from `URLSession` or from frameworks that use it, such as [Alamofire](https://github.com/Alamofire/Alamofire) or [Get](https://github.com/kean/Get), and displays them using `PulseUI` views that you integrate directly into your app. This way 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.

> Pulse is **not** a network proxy. If you need one, check out [**Proxyman**](https://proxyman.io).

## Getting Started

The best way to start using Pulse is with the [**Getting Started**](https://kean-docs.github.io/pulse/documentation/pulse/gettingstarted) guide. There are many ways to use it and to learn more, see the dedicated docs: 

- [**Pulse Docs**](https://kean-docs.github.io/pulse/documentation/pulse/) describe how to integrate the main framework and enable logging

- [**PulseUI Docs**](https://kean-docs.github.io/pulseui/documentation/pulseui/) contains information about adding the debug menu and console into your app

- [**PulseLogHandler Docs**](https://kean-docs.github.io/pulseloghandler/documentation/pulseloghandler/) describe how to use Pulse as [SwiftLog](https://github.com/apple/swift-log) backend







## Pulse Pro

[**Pulse Pro**](https://pulselogger.com) is a professional macOS app that allows you to view logs in real time. The app is designed to be flexible, expansive, and precise while using all the familiar macOS patterns. It makes it easy to navigate large log files with table and text modes, filters, an all-new network inspector, JSON filters, and more.

## Minimum Requirements

| Pulse      | Swift      | Xcode       | Platforms                                        |

|------------|------------|-------------|--------------------------------------------------|

| Pulse 5.0  | Swift 5.10 | Xcode 15.4  | iOS 15, tvOS 15, watchOS 8, macOS 12, visionOS 1 |

| Pulse 4.0  | Swift 5.7  | Xcode 14.1  | iOS 14, tvOS 15, watchOS 8, macOS 12             |

## License

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