https://github.com/willpowell8/remotelog
Remote Logging, Analytics and Support for iOS Applications with full information and screenshots
https://github.com/willpowell8/remotelog
cocoapods debugging-tool ios ios-sdk logging-library remote-control support-system swift swift3
Last synced: about 2 months ago
JSON representation
Remote Logging, Analytics and Support for iOS Applications with full information and screenshots
- Host: GitHub
- URL: https://github.com/willpowell8/remotelog
- Owner: willpowell8
- License: mit
- Created: 2017-04-23T14:06:26.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-18T14:28:34.000Z (over 5 years ago)
- Last Synced: 2025-03-04T18:04:08.915Z (over 1 year ago)
- Topics: cocoapods, debugging-tool, ios, ios-sdk, logging-library, remote-control, support-system, swift, swift3
- Language: Objective-C
- Homepage: http://www.willpowell.co.uk
- Size: 61.5 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# RemoteLog - Easiest remote logging and support framework for iOS iPad and iPhone
This quick and easy to use framework allows you to connect remotely to a device and retrieve a full log of what is going on and even screenshots of what the user can see and is doing.
[](https://travis-ci.org/willpowell8/RemoteLog)
[](http://cocoapods.org/pods/RemoteLog)
[](http://cocoapods.org/pods/RemoteLog)
[](http://cocoapods.org/pods/RemoteLog)
## Events Logged by Remote Log
##### Console Print
Any print events written within the application will be fed to the remote logging framework.
##### Network request
Any request made within the application will be logged as far as URL, duration etc. to make it easy to see what is going on from a network stance.
##### Touch Event
RemoteLog inteligently works out what is happening within app and we are building out events monitoring for components. RemoteLog monitors the events from buttons so if a user touches up on a screen and there is an attached event the application will take a screenshot and record the touch events for the application and report it as a single event to the support user.
## Sample User Journey
RemoteLog is not designed to be on permanently, but is designed to find out what is going wrong for a user and what the user can see during testing or production deployment.
- User is within app and comes across issue
- User contacts support and asks for help. Support can ask User to shake device and then start RemoteLog
- RemoteLog provides a uuid that the User tells support
- Support can now enter the uuid within the support app or the mac client to see the realtime log from the device
- User can now perform same issue again and support can see exactly what is happening on device
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first. This shows the RemoteLog Framework integrated and it shows the connected uuid string at the bottom of the screen.
## Requirements
## Installation
First you need to add RemoteLog to your project. It is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile and then pod install:
```swift
pod "RemoteLog"
```
To include it within your application import the RemoteLogLibrary within your AppDelegate
```swift
import "RemoteLogLibrary"
```
Then add the RemoteLog to your application at in the didFinishLaunchingWithOptions
```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
RemoteLog.load() // this sets up the remote logging session
return true
}
```
The to start the logging service use the following code
```swift
RemoteLog.start() // this starts the logging process
```
## Author
willpowell8, willpowell8@gmail.com
## License
RemoteLog is available under the MIT license. See the LICENSE file for more info.