12 |
13 | * [Installation](#installation)
14 | * [Add AppSpector plugin to pubspec.yaml](#add-appspector-plugin-to-pubspecyaml)
15 | * [Initialize AppSpector plugin](#initialize-appspector-plugin)
16 | * [Build and Run](#build-and-run)
17 | * [Getting session URL](#getting-session-url)
18 | * [Correct SQLite setup for the SDK](#correct-sqlite-setup-for-the-sdk)
19 | * [Configure](#configure)
20 | * [Start/Stop data collection](#startstop-data-collection)
21 | * [Custom device name](#custom-device-name)
22 | * [Getting session URL](#getting-session-url)
23 | * [Correct SQLite setup for the SDK](#correct-sqlite-setup-for-the-sdk)
24 | * [Features](#features)
25 | * [SQLite monitor](#sqlite-monitor)
26 | * [HTTP monitor](#http-monitor)
27 | * [Logs monitor](#logs-monitor)
28 | * [Logger](#logger)
29 | * [Location monitor](#location-monitor)
30 | * [Screenshot monitor](#screenshot-monitor)
31 | * [SharedPreference/UserDefaults monitor](#sharedpreferenceuserdefaults-monitor)
32 | * [Performance monitor](#performance-monitor)
33 | * [Environment monitor](#environment-monitor)
34 | * [Notification Center monitor (only for iOS)](#notification-center-monitor-only-for-ios)
35 | * [File System Monitor](#file-system-monitor)
36 | * [Feedback](#feedback)
37 |
38 |
39 | # Installation
40 |
41 | Before using AppSpector SDK in your Flutter app you have to register it on ([https://app.appspector.com](https://app.appspector.com?utm_source=android_readme)) via web or [desktop app](https://appspector.com/download/?utm_source=android_readme).
42 | To use SDK on both platforms (iOS and Android) you have to register two separate apps for different platforms.
43 | API keys required for the SDK initialisation will be available on the Apps settings pages
44 |
45 | ## Add AppSpector plugin to pubspec.yaml
46 | ```yaml
47 | dependencies
48 | appspector: '0.10.0'
49 | ```
50 |
51 | ## Initialize AppSpector plugin
52 | ```dart
53 | import 'package:appspector/appspector.dart';
54 |
55 | void main() {
56 | WidgetsFlutterBinding.ensureInitialized();
57 | runAppSpector();
58 | runApp(MyApp());
59 | }
60 |
61 | void runAppSpector() {
62 | final config = Config()
63 | ..iosApiKey = "Your iOS API_KEY"
64 | ..androidApiKey = "Your Android API_KEY";
65 |
66 | // If you don't want to start all monitors you can specify a list of necessary ones
67 | config.monitors = [Monitors.http, Monitors.logs, Monitors.screenshot];
68 |
69 | AppSpectorPlugin.run(config);
70 | }
71 | ```
72 |
73 | ## Build and Run
74 | Build your project and see everything work! When your app is up and running you can go to [https://app.appspector.com](https://app.appspector.com/?utm_source=flutter_readme) and connect to your application session.
75 |
76 |
77 | # Configure
78 |
79 | ## Start/Stop data collection
80 |
81 | After calling the `run` method the SDKs start data collection and
82 | data transferring to the web service. From that point you can see
83 | your session in the AppSpector client.
84 |
85 | Since plugin initialization should locate in the main function we provide
86 | methods to help you control AppSpector state by calling `stop()` and `start()` methods.
87 |
88 | **You are able to use these methods only after AppSpector was initialized.**
89 |
90 | The `stop()` tells AppSpector to disable all data collection and close current session.
91 |
92 | ```dart
93 | await AppSpectorPlugin.shared().stop();
94 | ```
95 |
96 | The `start()` starts it again using config you provided at initialization.
97 |
98 | ```dart
99 | await AppSpectorPlugin.shared().start();
100 | ```
101 |
102 | **As the result new session will be created and all activity between
103 | `stop()` and `start()` calls will not be tracked.**
104 |
105 | To check AppSpector state you can use `isStarted()` method.
106 |
107 | ```dart
108 | await AppSpectorPlugin.shared().isStarted();
109 | ```
110 |
111 | ## Custom device name
112 |
113 | You can assign a custom name to your device to easily find needed sessions
114 | in the sessions list. To do this you should add the desired name as a value
115 | for `MetadataKeys.deviceName` key to the `metadata` dictionary:
116 |
117 | ```dart
118 | void runAppSpector() {
119 | var config = new Config()
120 | ..iosApiKey = "Your iOS API_KEY"
121 | ..androidApiKey = "Your Android API_KEY"
122 | ..metadata = {MetadataKeys.deviceName: "CustomName"};
123 |
124 | AppSpectorPlugin.run(config);
125 | }
126 | ```
127 |
128 | Also, the plugin allows managing the device name during application lifetime using
129 |
130 | the `setMetadataValue` method to change device name
131 |
132 | ```dart
133 | AppSpectorPlugin.shared().setMetadataValue(MetadataKeys.deviceName, "New Device Name");
134 | ```
135 |
136 | or the `removeMetadataValue` to remove your custom device name
137 |
138 | ```dart
139 | AppSpectorPlugin.shared().removeMetadataValue(MetadataKeys.deviceName);
140 | ```
141 |
142 | ## Getting session URL
143 |
144 | Sometimes you may need to get URL pointing to current session from code.
145 | Say you want link crash in your crash reporter with it, write it to logs or
146 | display in your debug UI. To get this URL you have to add a session start callback:
147 |
148 | ```dart
149 | AppSpectorPlugin.shared()?.sessionUrlListener = (sessionUrl) => {
150 | // Save url for future use...
151 | };
152 | ```
153 |
154 |
155 | ## Correct SQLite setup for the SDK
156 |
157 | The SQLite monitor on Android demands that any DB files are located at the `database` folder.
158 | So, if you're using [sqflite](https://pub.dev/packages/sqflite) the code for opening db will be looks like that:
159 |
160 | ```dart
161 | var dbPath = await getDatabasesPath() + "/my_database_name";
162 | var db = await openDatabase(dbPath, version: 1, onCreate: _onCreate);
163 | ```
164 |
165 | The `getDatabasesPath()` method is imported from `package:sqflite/sqflite.dart`.
166 |
167 | # Features
168 |
169 | AppSpector provides many monitors that are can be different for both platforms.
170 |
171 | ### SQLite monitor
172 | 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.
173 |
174 | 
175 |
176 | #### HTTP monitor
177 | Shows all HTTP traffic in your app. You can examine any request, see request/response headers and body.
178 | We provide XML and JSON highliting for request/responses with formatting and folding options so even huge responses are easy to look through.
179 |
180 | 
181 |
182 | ### Logs monitor
183 | Displays all logs generated by your app.
184 |
185 | #### Logger
186 | AppSpector Logger allows you to collect log message only into AppSpector
187 | service. It is useful when you log some internal data witch can be leaked
188 | through Android Logcat or similar tool for iOS.
189 |
190 | It has a very simple API to use:
191 |
192 | ```dart
193 | Logger.d("MyTAG", "It won't be printed to the app console");
194 | ```
195 |
196 | **Don't forget to import it** from `package:appspector/appspector.dart`.
197 |
198 | 
199 |
200 | ### Location monitor
201 | 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.
202 |
203 | 
204 |
205 | ### Screenshot monitor
206 | Simply captures screenshot from the device.
207 |
208 | ### SharedPreference/UserDefaults monitor
209 | Provides browser and editor for SharedPreferences/UserDefaults.
210 |
211 | ### Performance monitor
212 | Displays real-time graphs of the CPU / Memory/ Network / Disk / Battery usage.
213 |
214 | ### Environment monitor
215 | Gathers all of the environment variables and arguments in one place, info.plist, cli arguments and much more.
216 |
217 | ### Notification Center monitor (only for iOS)
218 | Tracks all posted notifications and subscriptions. You can examine notification user info, sender/reciever objects, etc.
219 | And naturally you can post notifications to your app from the frontend.
220 |
221 | ### File System Monitor
222 | Provides access to the application internal storage on Android and sandbox and bundle on iOS.
223 | Using this monitor you're able to download, remove or upload files, create directories and just walk around your app FS.
224 |
225 | For mode details, you can visit [Android SDK](https://github.com/appspector/android-sdk/) and [iOS SDK](https://github.com/appspector/ios-sdk) pages.
226 |
227 |
228 | # Feedback
229 | Let us know what do you think or what would you like to be improved: [info@appspector.com](mailto:info@appspector.com).
230 |
231 | [Join our slack to discuss setup process and features](https://slack.appspector.com)
232 |
--------------------------------------------------------------------------------
/android/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | .gradle
3 | /local.properties
4 | /.idea/workspace.xml
5 | /.idea/libraries
6 | .DS_Store
7 | /build
8 | /captures
9 |
10 | **/GeneratedPluginRegistrant.java
11 |
--------------------------------------------------------------------------------
/android/build.gradle:
--------------------------------------------------------------------------------
1 | group 'com.appspector.flutter'
2 | version '1.0'
3 |
4 | buildscript {
5 | repositories {
6 | google()
7 | mavenCentral()
8 | }
9 |
10 | dependencies {
11 | classpath 'com.android.tools.build:gradle:8.0.2'
12 | }
13 | }
14 |
15 | rootProject.allprojects {
16 | repositories {
17 | google()
18 | maven { url "https://maven.appspector.com/artifactory/android-sdk" }
19 | }
20 | }
21 |
22 | apply plugin: 'com.android.library'
23 |
24 | android {
25 | compileSdkVersion 33
26 | if (project.android.hasProperty('namespace')) {
27 | namespace "com.appspector.flutter"
28 | }
29 | defaultConfig {
30 | minSdkVersion 21
31 | }
32 |
33 | lintOptions {
34 | disable 'InvalidPackage'
35 | }
36 |
37 | compileOptions {
38 | sourceCompatibility 1.8
39 | targetCompatibility 1.8
40 | }
41 | }
42 |
43 | dependencies {
44 | implementation("com.appspector:android-sdk:1.5.+") {
45 | exclude group:"org.jetbrains.kotlin"
46 | }
47 | implementation 'androidx.annotation:annotation:1.6.0'
48 | }
49 |
--------------------------------------------------------------------------------
/android/gradle.properties:
--------------------------------------------------------------------------------
1 | org.gradle.jvmargs=-Xmx1536M
2 | android.useAndroidX=true
3 |
--------------------------------------------------------------------------------
/android/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/appspector/flutter-plugin/dbbd326c5740ff27f670c3624bf03a912f261cbf/android/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/android/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Fri Jun 23 08:50:38 CEST 2017
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-all.zip
7 |
--------------------------------------------------------------------------------
/android/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # Attempt to set APP_HOME
46 | # Resolve links: $0 may be a link
47 | PRG="$0"
48 | # Need this for relative symlinks.
49 | while [ -h "$PRG" ] ; do
50 | ls=`ls -ld "$PRG"`
51 | link=`expr "$ls" : '.*-> \(.*\)$'`
52 | if expr "$link" : '/.*' > /dev/null; then
53 | PRG="$link"
54 | else
55 | PRG=`dirname "$PRG"`"/$link"
56 | fi
57 | done
58 | SAVED="`pwd`"
59 | cd "`dirname \"$PRG\"`/" >/dev/null
60 | APP_HOME="`pwd -P`"
61 | cd "$SAVED" >/dev/null
62 |
63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
64 |
65 | # Determine the Java command to use to start the JVM.
66 | if [ -n "$JAVA_HOME" ] ; then
67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
68 | # IBM's JDK on AIX uses strange locations for the executables
69 | JAVACMD="$JAVA_HOME/jre/sh/java"
70 | else
71 | JAVACMD="$JAVA_HOME/bin/java"
72 | fi
73 | if [ ! -x "$JAVACMD" ] ; then
74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
75 |
76 | Please set the JAVA_HOME variable in your environment to match the
77 | location of your Java installation."
78 | fi
79 | else
80 | JAVACMD="java"
81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
82 |
83 | Please set the JAVA_HOME variable in your environment to match the
84 | location of your Java installation."
85 | fi
86 |
87 | # Increase the maximum file descriptors if we can.
88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
89 | MAX_FD_LIMIT=`ulimit -H -n`
90 | if [ $? -eq 0 ] ; then
91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
92 | MAX_FD="$MAX_FD_LIMIT"
93 | fi
94 | ulimit -n $MAX_FD
95 | if [ $? -ne 0 ] ; then
96 | warn "Could not set maximum file descriptor limit: $MAX_FD"
97 | fi
98 | else
99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
100 | fi
101 | fi
102 |
103 | # For Darwin, add options to specify how the application appears in the dock
104 | if $darwin; then
105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
106 | fi
107 |
108 | # For Cygwin, switch paths to Windows format before running java
109 | if $cygwin ; then
110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
112 | JAVACMD=`cygpath --unix "$JAVACMD"`
113 |
114 | # We build the pattern for arguments to be converted via cygpath
115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
116 | SEP=""
117 | for dir in $ROOTDIRSRAW ; do
118 | ROOTDIRS="$ROOTDIRS$SEP$dir"
119 | SEP="|"
120 | done
121 | OURCYGPATTERN="(^($ROOTDIRS))"
122 | # Add a user-defined pattern to the cygpath arguments
123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
125 | fi
126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
127 | i=0
128 | for arg in "$@" ; do
129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
131 |
132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
134 | else
135 | eval `echo args$i`="\"$arg\""
136 | fi
137 | i=$((i+1))
138 | done
139 | case $i in
140 | (0) set -- ;;
141 | (1) set -- "$args0" ;;
142 | (2) set -- "$args0" "$args1" ;;
143 | (3) set -- "$args0" "$args1" "$args2" ;;
144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
150 | esac
151 | fi
152 |
153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
154 | function splitJvmOpts() {
155 | JVM_OPTS=("$@")
156 | }
157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
159 |
160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
161 |
--------------------------------------------------------------------------------
/android/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if "%ERRORLEVEL%"=="0" goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85 | exit /b 1
86 |
87 | :mainEnd
88 | if "%OS%"=="Windows_NT" endlocal
89 |
90 | :omega
91 |
--------------------------------------------------------------------------------
/android/settings.gradle:
--------------------------------------------------------------------------------
1 | rootProject.name = 'appspector_plugin'
2 |
--------------------------------------------------------------------------------
/android/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 | 47 | ///
Here is an example of how AppSpector is used: 48 | ///
49 | /// void main() {
50 | /// runAppSpector();
51 | /// runApp(MyApp());
52 | /// }
53 | ///
54 | /// void runAppSpector() {
55 | /// var config = new Config();
56 | /// config.iosApiKey = "Your iOS API_KEY";
57 | /// config.androidApiKey = "Your Android API_KEY";
58 | /// AppSpectorPlugin.run(config);
59 | /// }
60 | ///
61 | /// For more information visit the AppSpector Page.
62 | class AppSpectorPlugin { 63 | static AppSpectorPlugin _appSpectorPlugin = 64 | AppSpectorPlugin._privateConstructor(); 65 | 66 | final MethodChannel _channel = const MethodChannel('appspector_plugin'); 67 | final RequestReceiver _requestReceiver = new RequestReceiver(); 68 | Function(String)? _sessionUrlListener; 69 | 70 | set sessionUrlListener(Function(String)? listener) { 71 | _sessionUrlListener = listener; 72 | } 73 | 74 | AppSpectorPlugin._privateConstructor(); 75 | 76 | AppSpectorPlugin._withConfig( 77 | Config config, Function(String)? sessionUrlListener) { 78 | HttpOverrides.global = AppSpectorHttpOverrides(); 79 | _requestReceiver.observeChannel(); 80 | _channel.setMethodCallHandler(_handlePluginCalls); 81 | _sessionUrlListener = sessionUrlListener; 82 | _appSpectorPlugin = this; 83 | } 84 | 85 | Future