Difference between revisions of "IOS log doc"

From Beiwe Wiki
Jump to: navigation, search
(iOS_log documentation added)
 
 
Line 1: Line 1:
ios_log documentation
+
=== ios_log documentation ===
# IOS_LOG Events #
+
<nowiki>#</nowiki> IOS_LOG Events #
  
## HEADERS ##
+
<nowiki>##</nowiki> HEADERS ##
#### launchId ####
 
unique ID for this app launch.  Changes when app terminates and is restarted.
 
  
#### memory ####
+
<nowiki>####</nowiki> launchId ####
Approx. number of megabytes app is using. May fluctuate, but should not steadily increase forever.
+
 
 +
unique ID for this app launch. Changes when app terminates and is restarted.
 +
 
 +
<nowiki>####</nowiki> memory ####
 +
 
 +
Approx. number of megabytes app is using.  May fluctuate, but should not steadily increase forever.
 +
 
 +
<nowiki>####</nowiki> battery ####
  
#### battery ####
 
 
Battery percentage at time of this event
 
Battery percentage at time of this event
  
#### event ####
+
<nowiki>####</nowiki> event ####
 +
 
 
The type of event occurring
 
The type of event occurring
  
#### msg ####
+
<nowiki>####</nowiki> msg ####
 +
 
 
Human readable msg for this event
 
Human readable msg for this event
  
#### d1-d3 ####
+
<nowiki>####</nowiki> d1-d3 ####
 +
 
 
Additional data, specific to each event type and outlined below.
 
Additional data, specific to each event type and outlined below.
  
#### d4 ####
+
<nowiki>####</nowiki> d4 ####
Sequence number of this event. Starts at zero and increments for each event logged until the app is restarted, at which time it resets to zero.
+
 
 +
Sequence number of this event. Starts at zero and increments for each event logged until the app is restarted, at which time it resets to zero.
 +
 
 +
Should not be any gaps in the sequence.  If there are, it represents events that somehow did not get logged into ios_log
  
Should not be any gaps in the sequence.  If there are, it represents events that somehow did not get logged into ios_log
+
<nowiki>##</nowiki> Event Types ##
  
## Event Types ##
+
<nowiki>###</nowiki> launch ###
  
### launch ###
 
 
App was launched
 
App was launched
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
Reason app was launched. Will contain "location" if app was launched in the background due to significant location change.
+
 
 +
Reason app was launched.  Will contain "location" if app was launched in the background due to significant location change.
 +
 
 +
<nowiki>###</nowiki> collecting ###
  
### collecting ###
 
 
App is now collecting data
 
App is now collecting data
  
### stop_collecting ###
+
<nowiki>###</nowiki> stop_collecting ###
 +
 
 
App has stopped collecting data
 
App has stopped collecting data
  
### foreground ###
+
<nowiki>###</nowiki> foreground ###
 +
 
 
App was brought into the foreground
 
App was brought into the foreground
  
### background ###
+
<nowiki>###</nowiki> background ###
 +
 
 
App was put into the background
 
App was put into the background
  
### terminate ###
+
<nowiki>###</nowiki> terminate ###
OS is about to terminate the app. Not always logged, as sometimes OS terminates without any notification.
+
 
 +
OS is about to terminate the app.  Not always logged, as sometimes OS terminates without any notification.
 +
 
 +
<nowiki>###</nowiki> memory_warn ###
  
### memory_warn ###
 
 
OS is requesting app releases as much memory as possible
 
OS is requesting app releases as much memory as possible
  
### locked ###
+
<nowiki>###</nowiki> locked ###
 +
 
 
OS has locked the keychain (phone is locked)
 
OS has locked the keychain (phone is locked)
  
### unlocked ###
+
<nowiki>###</nowiki> unlocked ###
 +
 
 
OS has unlocked the keychain (phone is unlocked)
 
OS has unlocked the keychain (phone is unlocked)
  
### audio_save_closing ###
+
<nowiki>###</nowiki> audio_save_closing ###
 +
 
 
An audio file has completed saving and is being closed.
 
An audio file has completed saving and is being closed.
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Filename of audio file
 
Filename of audio file
  
### audio_save ###
+
<nowiki>###</nowiki> audio_save ###
 +
 
 
The save button was pressed on an audio file
 
The save button was pressed on an audio file
  
### audio_save_fail ###
+
<nowiki>###</nowiki> audio_save_fail ###
 +
 
 
There was a failure while trying to save the audio file to the filesystem.
 
There was a failure while trying to save the audio file to the filesystem.
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
String describing the error
 
String describing the error
  
### uploaded ###
+
<nowiki>###</nowiki> uploaded ###
 +
 
 
A data file was succesfully uploded.
 
A data file was succesfully uploded.
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Filename of uploaded file
 
Filename of uploaded file
  
### upload_file_failed ###
+
<nowiki>###</nowiki> upload_file_failed ###
 +
 
 
A data file failed to upload
 
A data file failed to upload
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Filename of uploaded file that failed
 
Filename of uploaded file that failed
  
### upload_complete ###
+
<nowiki>###</nowiki> upload_complete ###
 +
 
 
Finished uploading a set of data files
 
Finished uploading a set of data files
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Number of files uploaded
 
Number of files uploaded
  
### upload_incomplete ###
+
<nowiki>###</nowiki> upload_incomplete ###
 +
 
 
Upload completed but not all (or any) files were uploaded.
 
Upload completed but not all (or any) files were uploaded.
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
The size of the data files still left to be uploaded
 
The size of the data files still left to be uploaded
  
### upload_incomplete ###
+
<nowiki>###</nowiki> upload_incomplete ###
 +
 
 
Upload completed but not all (or any) files were uploaded.
 
Upload completed but not all (or any) files were uploaded.
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
The size of the data files still left to be uploaded
 
The size of the data files still left to be uploaded
  
### purge ###
+
<nowiki>###</nowiki> purge ###
 +
 
 
There is a large backlog of data that was unable to be uploaded, so older data is being purged (which will result in lost data).
 
There is a large backlog of data that was unable to be uploaded, so older data is being purged (which will result in lost data).
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
The size of the data files still left to be uploaded
 
The size of the data files still left to be uploaded
  
### file_init ###
+
<nowiki>###</nowiki> file_init ###
 +
 
 
A new data file is being initialized.
 
A new data file is being initialized.
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Name of data file
 
Name of data file
  
##### d2 #####
+
<nowiki>#####</nowiki> d2 #####
 +
 
 
false if file has no errors, true if there are errors
 
false if file has no errors, true if there are errors
 +
 
(So should be false all the time)
 
(So should be false all the time)
  
##### d3 #####
+
<nowiki>#####</nowiki> d3 #####
 +
 
 
Error message for error (if above is true)
 
Error message for error (if above is true)
  
### file_flush ###
+
<nowiki>###</nowiki> file_flush ###
 +
 
 
All current lines of this data file are being flushed (if any)
 
All current lines of this data file are being flushed (if any)
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Name of data file
 
Name of data file
  
##### d2 #####
+
<nowiki>#####</nowiki> d2 #####
 +
 
 
Number of lines to be flushed
 
Number of lines to be flushed
  
### file_create ###
+
<nowiki>###</nowiki> file_create ###
 +
 
 
The data file is actually being created in the filesystem
 
The data file is actually being created in the filesystem
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Name of data file
 
Name of data file
  
##### d2 #####
+
<nowiki>#####</nowiki> d2 #####
 +
 
 
false if file has no errors, true if there are errors
 
false if file has no errors, true if there are errors
 +
 
(So should be false all the time)
 
(So should be false all the time)
  
##### d3 #####
+
<nowiki>#####</nowiki> d3 #####
 +
 
 
Error message for error (if above is true)
 
Error message for error (if above is true)
  
### file_error ###
+
<nowiki>###</nowiki> file_error ###
 +
 
 
There was an error creating the file
 
There was an error creating the file
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Name of data file
 
Name of data file
  
##### d2 #####
+
<nowiki>#####</nowiki> d2 #####
 +
 
 
Will be true since this represents an error
 
Will be true since this represents an error
  
 +
<nowiki>#####</nowiki> d3 #####
  
##### d3 #####
 
 
Error message for error (if above is true)
 
Error message for error (if above is true)
  
### poll_service ###
+
<nowiki>###</nowiki> poll_service ###
 +
 
 
Polling to see if data needs to be uploaded or new surveys checked.
 
Polling to see if data needs to be uploaded or new surveys checked.
  
### set_timer ###
+
<nowiki>###</nowiki> set_timer ###
 +
 
 
Next timer to check for services/data collection is set
 
Next timer to check for services/data collection is set
  
##### d1 #####
+
<nowiki>#####</nowiki> d1 #####
 +
 
 
Number of seconds when timer will fire
 
Number of seconds when timer will fire
  
### gps_on ###
+
<nowiki>###</nowiki> gps_on ###
 +
 
 
GPS data collection starting
 
GPS data collection starting
  
### gps_off ###
+
<nowiki>###</nowiki> gps_off ###
 +
 
 
GPS data collection stopping
 
GPS data collection stopping
  
### accel_on ###
+
<nowiki>###</nowiki> accel_on ###
 +
 
 
Accelerometer data collection starting
 
Accelerometer data collection starting
  
### accel_off ###
+
<nowiki>###</nowiki> accel_off ###
 +
 
 
Acceleromter data collection stopping
 
Acceleromter data collection stopping
  
### powerstate_on ###
+
<nowiki>###</nowiki> powerstate_on ###
 +
 
 
Power state data collection starting
 
Power state data collection starting
  
### powerstate_off ###
+
<nowiki>###</nowiki> powerstate_off ###
 +
 
 
Power state data collection stopping
 
Power state data collection stopping
  
### proximity_on ###
+
<nowiki>###</nowiki> proximity_on ###
 +
 
 
Proximity data collection starting
 
Proximity data collection starting
  
### proximity_off ###
+
<nowiki>###</nowiki> proximity_off ###
 +
 
 
Proximity data collection stopping
 
Proximity data collection stopping
  
### gyro_on ###
+
<nowiki>###</nowiki> gyro_on ###
 +
 
 
Gyro state data collection starting
 
Gyro state data collection starting
  
### gyro_off ###
+
<nowiki>###</nowiki> gyro_off ###
 +
 
 
Gyro state data collection stopping
 
Gyro state data collection stopping
  
### magnetometer_on ###
+
<nowiki>###</nowiki> magnetometer_on ###
 +
 
 
Magnetometer data collection starting
 
Magnetometer data collection starting
  
### magnetometer_off ###
+
<nowiki>###</nowiki> magnetometer_off ###
 +
 
 
Magnetometer data collection stopping
 
Magnetometer data collection stopping
  
### devicemotion_on ###
+
<nowiki>###</nowiki> devicemotion_on ###
 +
 
 
Device motion data collection starting
 
Device motion data collection starting
  
### devicemotion_off ###
+
<nowiki>###</nowiki> devicemotion_off ###
 +
 
 
Device motion data collection stopping
 
Device motion data collection stopping
  
### reachability_on ###
+
<nowiki>###</nowiki> reachability_on ###
 +
 
 
Reachability data collection starting
 
Reachability data collection starting
  
### reachability_off ###
+
<nowiki>###</nowiki> reachability_off ###
 +
 
 
Reachability data collection stopping
 
Reachability data collection stopping

Latest revision as of 14:00, 18 December 2017

ios_log documentation

# IOS_LOG Events #

## HEADERS ##

#### launchId ####

unique ID for this app launch. Changes when app terminates and is restarted.

#### memory ####

Approx. number of megabytes app is using.  May fluctuate, but should not steadily increase forever.

#### battery ####

Battery percentage at time of this event

#### event ####

The type of event occurring

#### msg ####

Human readable msg for this event

#### d1-d3 ####

Additional data, specific to each event type and outlined below.

#### d4 ####

Sequence number of this event. Starts at zero and increments for each event logged until the app is restarted, at which time it resets to zero.

Should not be any gaps in the sequence.  If there are, it represents events that somehow did not get logged into ios_log

## Event Types ##

### launch ###

App was launched

##### d1 #####

Reason app was launched.  Will contain "location" if app was launched in the background due to significant location change.

### collecting ###

App is now collecting data

### stop_collecting ###

App has stopped collecting data

### foreground ###

App was brought into the foreground

### background ###

App was put into the background

### terminate ###

OS is about to terminate the app.  Not always logged, as sometimes OS terminates without any notification.

### memory_warn ###

OS is requesting app releases as much memory as possible

### locked ###

OS has locked the keychain (phone is locked)

### unlocked ###

OS has unlocked the keychain (phone is unlocked)

### audio_save_closing ###

An audio file has completed saving and is being closed.

##### d1 #####

Filename of audio file

### audio_save ###

The save button was pressed on an audio file

### audio_save_fail ###

There was a failure while trying to save the audio file to the filesystem.

##### d1 #####

String describing the error

### uploaded ###

A data file was succesfully uploded.

##### d1 #####

Filename of uploaded file

### upload_file_failed ###

A data file failed to upload

##### d1 #####

Filename of uploaded file that failed

### upload_complete ###

Finished uploading a set of data files

##### d1 #####

Number of files uploaded

### upload_incomplete ###

Upload completed but not all (or any) files were uploaded.

##### d1 #####

The size of the data files still left to be uploaded

### upload_incomplete ###

Upload completed but not all (or any) files were uploaded.

##### d1 #####

The size of the data files still left to be uploaded

### purge ###

There is a large backlog of data that was unable to be uploaded, so older data is being purged (which will result in lost data).

##### d1 #####

The size of the data files still left to be uploaded

### file_init ###

A new data file is being initialized.

##### d1 #####

Name of data file

##### d2 #####

false if file has no errors, true if there are errors

(So should be false all the time)

##### d3 #####

Error message for error (if above is true)

### file_flush ###

All current lines of this data file are being flushed (if any)

##### d1 #####

Name of data file

##### d2 #####

Number of lines to be flushed

### file_create ###

The data file is actually being created in the filesystem

##### d1 #####

Name of data file

##### d2 #####

false if file has no errors, true if there are errors

(So should be false all the time)

##### d3 #####

Error message for error (if above is true)

### file_error ###

There was an error creating the file

##### d1 #####

Name of data file

##### d2 #####

Will be true since this represents an error

##### d3 #####

Error message for error (if above is true)

### poll_service ###

Polling to see if data needs to be uploaded or new surveys checked.

### set_timer ###

Next timer to check for services/data collection is set

##### d1 #####

Number of seconds when timer will fire

### gps_on ###

GPS data collection starting

### gps_off ###

GPS data collection stopping

### accel_on ###

Accelerometer data collection starting

### accel_off ###

Acceleromter data collection stopping

### powerstate_on ###

Power state data collection starting

### powerstate_off ###

Power state data collection stopping

### proximity_on ###

Proximity data collection starting

### proximity_off ###

Proximity data collection stopping

### gyro_on ###

Gyro state data collection starting

### gyro_off ###

Gyro state data collection stopping

### magnetometer_on ###

Magnetometer data collection starting

### magnetometer_off ###

Magnetometer data collection stopping

### devicemotion_on ###

Device motion data collection starting

### devicemotion_off ###

Device motion data collection stopping

### reachability_on ###

Reachability data collection starting

### reachability_off ###

Reachability data collection stopping