instruments

Documentation

Index

• func GetMetrics(device ios.DeviceEntry) (func() (map[string]interface{}, error), func() error, error)
• func ListenAppStateNotifications(device ios.DeviceEntry) (func() (map[string]interface{}, error), func() error, error)
• func VerifyProfileAndType(types []ProfileType, profileTypeIdentifier string, profileIdentifier string) (ProfileType, Profile, error)
• type DeviceInfoService
  • func NewDeviceInfoService(device ios.DeviceEntry) (*DeviceInfoService, error)
  • func (d *DeviceInfoService) Close()
  • func (d DeviceInfoService) HardwareInformation() (map[string]interface{}, error)
  • func (d DeviceInfoService) NameForPid(pid uint64) error
  • func (d DeviceInfoService) NetworkInformation() (map[string]interface{}, error)
  • func (d DeviceInfoService) ProcessList() ([]ProcessInfo, error)
• type DeviceStateControl
  • func NewDeviceStateControl(device ios.DeviceEntry) (*DeviceStateControl, error)
  • func (d DeviceStateControl) Disable(pType ProfileType) error
  • func (d DeviceStateControl) Enable(pType ProfileType, profile Profile) error
  • func (d DeviceStateControl) List() ([]ProfileType, error)
• type ProcessControl
  • func NewProcessControl(device ios.DeviceEntry) (*ProcessControl, error)
  • func (p *ProcessControl) Close() error
  • func (p ProcessControl) KillProcess(pid uint64) error
  • func (p *ProcessControl) LaunchApp(bundleID string) (uint64, error)
  • func (p ProcessControl) StartProcess(bundleID string, envVars map[string]interface{}, arguments []interface{}, ...) (uint64, error)
• type ProcessInfo
• type Profile
• type ProfileType

Functions

func GetMetrics

func GetMetrics(device ios.DeviceEntry) (func() (map[string]interface{}, error), func() error, error)

func ListenAppStateNotifications

func ListenAppStateNotifications(device ios.DeviceEntry) (func() (map[string]interface{}, error), func() error, error)

func VerifyProfileAndType

func VerifyProfileAndType(types []ProfileType, profileTypeIdentifier string, profileIdentifier string) (ProfileType, Profile, error)

VerifyProfileAndType checks that the given string profileTypeIdentifier and profileIdentifier are contained in the given types.

Types

type DeviceInfoService

type DeviceInfoService struct {
	// contains filtered or unexported fields
}

DeviceInfoService gives us access to retrieving process lists and resolving names for PIDs

func NewDeviceInfoService

func NewDeviceInfoService(device ios.DeviceEntry) (*DeviceInfoService, error)

NewDeviceInfoService creates a new DeviceInfoService for a given device

func (*DeviceInfoService) Close

func (d *DeviceInfoService) Close()

Close closes up the DTX connection

func (DeviceInfoService) HardwareInformation

func (d DeviceInfoService) HardwareInformation() (map[string]interface{}, error)

HardwareInformation gets some nice extra details from Instruments. Here is an example result for an old iPhone 5: map[hwCPU64BitCapable:1 hwCPUsubtype:1 hwCPUtype:16777228 numberOfCpus:2 numberOfPhysicalCpus:2 speedOfCpus:0]

func (DeviceInfoService) NameForPid

func (d DeviceInfoService) NameForPid(pid uint64) error

NameForPid resolves a process name for a given pid

func (DeviceInfoService) NetworkInformation

func (d DeviceInfoService) NetworkInformation() (map[string]interface{}, error)

NetworkInformation gets a list of all network interfaces for the device. Example result: map[en0:Wi-Fi en1:Ethernet Adaptor (en1) en2:Ethernet Adaptor (en2) lo0:Loopback pdp_ip0:Cellular (pdp_ip0) pdp_ip1:Cellular (pdp_ip1) pdp_ip2:Cellular (pdp_ip2) pdp_ip3:Cellular (pdp_ip3) pdp_ip4:Cellular (pdp_ip4)]

func (DeviceInfoService) ProcessList

func (d DeviceInfoService) ProcessList() ([]ProcessInfo, error)

ProcessList returns a []ProcessInfo, one for each process running on the iOS device

type DeviceStateControl

type DeviceStateControl struct {
	// contains filtered or unexported fields
}

DeviceStateControl allows to access the ConditionInducer so we can set device states like

"SlowNetworkCondition"  and  "SlowNetwork3GGood".

Use the List() command to get all available ProfileType and Profile combinations. Then use Enable() and Disable() to control them.

func NewDeviceStateControl

func NewDeviceStateControl(device ios.DeviceEntry) (*DeviceStateControl, error)

NewDeviceStateControl creates and connects a new DeviceStateControl that is ready to use

func (DeviceStateControl) Disable

func (d DeviceStateControl) Disable(pType ProfileType) error

Disable deactivates the currently active profileType

func (DeviceStateControl) Enable

func (d DeviceStateControl) Enable(pType ProfileType, profile Profile) error

Enable activates a given profileType and profile received from a List command. Note, that the device will automatically deactivate the profile if this dtx connection closes f.ex. when the process is terminated. Make sure to keep it open if you use this and use the Disable command.

func (DeviceStateControl) List

func (d DeviceStateControl) List() ([]ProfileType, error)

List returns a list of all available profile types and profiles.

type ProcessControl

type ProcessControl struct {
	// contains filtered or unexported fields
}

func NewProcessControl

func NewProcessControl(device ios.DeviceEntry) (*ProcessControl, error)

func (*ProcessControl) Close

func (p *ProcessControl) Close() error

func (ProcessControl) KillProcess

func (p ProcessControl) KillProcess(pid uint64) error

KillProcess kills the process on the device.

func (*ProcessControl) LaunchApp

func (p *ProcessControl) LaunchApp(bundleID string) (uint64, error)

LaunchApp launches the app with the given bundleID on the given device.LaunchApp Use LaunchAppWithArgs for passing arguments and envVars. It returns the PID of the created app process.

func (ProcessControl) StartProcess

func (p ProcessControl) StartProcess(bundleID string, envVars map[string]interface{}, arguments []interface{}, options map[string]interface{}) (uint64, error)

StartProcess launches an app on the device using the bundleID and optional envvars, arguments and options. It returns the PID.

type ProcessInfo

type ProcessInfo struct {
	IsApplication bool
	Name          string
	Pid           uint64
	RealAppName   string
	StartDate     time.Time
}

ProcessInfo contains all the properties for a process running on an iOS devices that we get back from instruments

type Profile

type Profile struct {
	Description string
	Identifier  string
	Name        string
}

Profile belongs to a ProfileType

type ProfileType

type ProfileType struct {
	ActiveProfile  string
	Identifier     string
	ProfilesSorted bool
	IsActive       bool
	Name           string
	IsDestructive  bool
	IsInternal     bool
	Profiles       []Profile
}

ProfileType a profile type we can activate