Skip to content

xNekOIx/ios-sdk

 
 

Repository files navigation

AppSpector

With AppSpector you can remotely debug your app running in the same room or on another continent. You can measure app performance, view database content, logs, network requests and many more in realtime. This is the instrument that you've been looking for. Don't limit yourself only to simple logs. Debugging don't have to be painful!

GitHub release

Installation

Each app you want to use with AppSpector SDK you have to register on the web (https://app.appspector.com). After adding the application navigate to app settings and copy API key.

Manually

To manually link just download AppSpectorSDK.zip, extract it and drop AppSpectorSDK.framework to your XCode project. Then navigate to your project settings and under 'General' tab add AppSpectorSDK framework to 'Embedded Binaries' section.

If you plan either to submit builds with AppSpector SDK to the Apple TestFlight for testing or archive them for AdHoc distribution you'll have to perform one more step: create a new “Run Script Phase” in your app’s target’s “Build Phases” and paste the following script:

file="AppSpectorSDK.framework/AppSpectorSDK"
archs="$(lipo -info "${file}" | rev | cut -d ':' -f1 | rev)"
stripped=""
for arch in $archs; do
    if ! [[ "${VALID_ARCHS}" == *"$arch"* ]]; then
        lipo -remove "$arch" -output "$file" "$file" || exit 1
        stripped="$stripped $arch"
    fi
done
echo "AppSPector: stripped archs: $stripped"

This script is required as a workaround for this Apple AppStore bug

CocoaPods

To use cocoapods add this line to your podfile and run pod install:

pod 'AppSpectorSDK'

Carthage

  • Install Carthage
  • Add github "appspector/ios-sdk" to your Cartfile
  • Run carthage update
  • Drag AppSpectorSDK.framework from the appropriate platform directory in Carthage/Build/ to the “Linked Frameworks and Libraries” section of your Xcode project’s “General” settings

Join our slack to discuss setup process and features

Features

AppSpector provides 8 monitors that tracks different activities inside your app:

Screenshot monitor

Simply captures screenshot from the device.

SQLite monitor

Provides browser for sqlite databases found in your app. Allows to track all queries, shows DB scheme and data in DB. You can issue custom SQL query on any DB and see results in browser immediately.

HTTP monitor

Shows all HTTP traffic in your app. You can examine any request, see request/response headers and body. We provide XML and JSON highliting for request/responses with formatting and folding options so even huge responses are easy to look through.

CoreData monitor

Browser for CoreData stores in your app. Shows model scheme just like Xcode editor, allows to navigate data, follow relations, switching contexts and running custom fetch requests against any model / context.

Performance monitor

Displays real-time graphs of the CPU / Memory/ Network / Disk / Battery usage.

Logs monitor

Displays all logs generated by your app. We provide integration with popular logging framework CocoaLumberjack, all your logs written with loggers from it will be displayed with respect to their logging levels.

Location monitor

Most of the apps are location-aware. Testing it requires changing locations yourself. In this case, location mocking is a real time saver. Just point to the location on the map and your app will change its geodata right away.

Environment monitor

Gathers all of the environment variables and arguments in one place, info.plist, cli arguments and much more.

Configure

AppSpector uses modules called monitors to track different app activities and gather stats. We provide a bunch of monitors out of the box which could be used together or in any combinations. To start AppSpector you need to build instance of AppSpectorConfig and provide your API key. You can start exact monitors with:

configWithAPIKey:(NSString *)apiKey monitorIDs:(NSSet <NSString *> *)monitorIDs

Or start all available with:

configWithAPIKey:(NSString *)apiKey

Available monitors:

AS_SCREENSHOT_MONITOR
AS_SQLITE_MONITOR
AS_HTTP_MONITOR
AS_COREDATA_MONITOR
AS_PERFORMANCE_MONITOR
AS_LOG_MONITOR
AS_LOCATION_MONITOR

Objective-C

Starting only selected monitors:

NSSet *monitorIDs = [NSSet setWithObjects:AS_HTTP_MONITOR, AS_LOG_MONITOR, nil];
AppSpectorConfig *config = [AppSpectorConfig configWithAPIKey:@"API_KEY" monitorIDs:monitorIDs];
[AppSpector runWithConfig:config];

Or all at once:

AppSpectorConfig *config = [AppSpectorConfig configWithAPIKey:@"API_KEY"];
[AppSpector runWithConfig:config];

Swift

Starting only selected monitors:

let config = AppSpectorConfig(apiKey: "API_KEY", monitorIDs: [AS_HTTP_MONITOR, AS_LOG_MONITOR])
AppSpector.run(with: config)

or to start all monitors:

let config = AppSpectorConfig(apiKey: "API_KEY")
AppSpector.run(with: config)

Feedback

Let us know what do you think or what would you like to be improved: info@appspector.com.

About

AppSpector is a debugging service for mobile apps

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%