Skip to main content

SoloX - Real-time collection tool for Android/iOS performance data.

Project description

English | 中文 | FAQ

SoloX

solox preview

🔎Preview

SoloX - Real-time collection tool for Android/iOS performance data.

We are committed to solving inefficient, cumbersome test execution, and our goal is Simple Test In SoloX!

preview

📦Requirements

  • Install Python 3.10 + Download
  • Install adb and configure environment variables (SoloX's adb may not necessarily fit your computer) Download

💡 Python 3.6 ~ 3.9 , please download a version of solox lower than 2.5.4.

💡 If Windows users need to test ios, install and start Itunes. Documentation

📥Installation

default

pip install -U solox    (pip install solox=={version})

mirrors

pip install -i  https://mirrors.ustc.edu.cn/pypi/web/simple -U solox

💡 If your network is unable to download through [pip install -U solox], please try using mirrors to download, but the download of SoloX may not be the latest version.

🚀Quickstart

default

python -m solox

customize

python -m solox --host={ip} --port={port}

🏴󠁣󠁩󠁣󠁭󠁿Collect in python

# solox version : >= 2.8.1
from solox.public.apm import AppPerformanceMonitor
from solox.public.common import Devices

d = Devices()
pids = d.getPid(deviceId='ca6bd5a5', pkgName='com.bilibili.app.in') # for android

apm = AppPerformanceMonitor(pkgName='com.bilibili.app.in',platform='Android', deviceId='ca6bd5a5', surfaceview=True, noLog=False, pid=None, record=False, collect_all=False)
# apm = AppPerformanceMonitor(pkgName='com.bilibili.app.in', platform='iOS') only supports one device
# surfaceview: False = gfxinfo (Developer - GPU rendering mode - adb shell dumpsys gfxinfo)
# noLog : False (Save test data to log file)

# ************* Collect a performance parameter ************* #
cpu = apm.collectCpu() # %
memory = apm.collectMemory() # MB
flow = apm.collectFlow(wifi=True) # KB
fps = apm.collectFps() # HZ
battery = apm.collectBattery() # level:% temperature:°C current:mA voltage:mV power:w
gpu = apm.collectGpu() # % only supports ios

# ************* Collect all performance parameter ************* #
 
if __name__ == '__main__':
  apm = AppPerformanceMonitor(pkgName='com.bilibili.app.in',platform='Android', deviceId='ca6bd5a5', surfaceview=True, noLog=False, pid=None, record=False, collect_all=True)
  # apm = AppPerformanceMonitor(pkgName='com.bilibili.app.in', platform='iOS',  deviceId='xxxx', noLog=False, record=False, collect_all=True)
  #record: record android screen
  apm.collectAll() # will generate HTML report

# in other python file
from solox.public.apm import initPerformanceService  

initPerformanceService.stop() # stop solox

🏴󠁣󠁩󠁣󠁭󠁿Collect in API

Start the service in the background

# solox version >= 2.1.5

macOS/Linux: nohup python3 -m solox &
Windows: start /min python3 -m solox &

Request apm data from api

Android: http://{ip}:{port}/apm/collect?platform=Android&deviceid=ca6bd5a5&pkgname=com.bilibili.app.in&target=cpu
iOS: http://{ip}:{port}/apm/collect?platform=iOS&pkgname=com.bilibili.app.in&target=cpu

target in ['cpu','memory','network','fps','battery','gpu']

🔥Features

  • No ROOT/Jailbreak: No need of Root for Android devices, Jailbreak for iOS devices. Efficiently solving the test and analysis challenges in Android & iOS performance.

  • Data Integrality: We provide the data about CPU, GPU, Memory, Battery, Network,FPS, Jank, etc., which you may easy to get.

  • Beautiful Report: A beautiful and detailed report analysis, where to store, visualize, edit, manage, and download all the test cases collected with SoloX no matter where you are or when is it.

  • Useful Monitoring Settings: Support setting alarm values, collecting duration, and accessing mobile devices on other PC machines during the monitoring process.

  • PK Model: Supports simultaneous comparative testing of two mobile devices.

    • 🌱2-devices: test the same app on two different phones.
    • 🌱2-apps: test two different apps on two phones with the same configuration.
  • Collect In Python/API: Support Python and API to collect performance data, helping users easily integrate into automated testing processes.

Develop

debug

  • remove [solox] moudel in all python file
example
from solox.view.apis import api  
change to 
from view.apis import api
  • run [python ./solox/debug.py]
cd solox
python debug.py

Browser

Chrome

Terminal

💕Thanks

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solox-2.8.4.tar.gz (17.2 MB view hashes)

Uploaded Source

Built Distribution

solox-2.8.4-py3-none-any.whl (17.3 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page