Skip to content

usage_guide.md

Latest commit

聽

History

History
204 lines (138 loc) 路 6.29 KB

usage_guide.md

File metadata and controls

204 lines (138 loc) 路 6.29 KB
Raw

馃殌 Quick Start

Note: ArkAnalyzer-HapRay is currently under active development. You may encounter some issues during deployment or usage. Our engineering team provides professional technical support. Please contact us if you encounter any deployment issues.

Environment Preparation

Prerequisites

  1. Hypium Test Framework Requirements

    • Must use Hypium 5.0.7.200 or higher version
    • Must have the ability to write Hypium test cases
    • Must use debug version packages for testing to obtain CPU instruction data
    • Test cases must be written according to Huawei Official Hypium Guide
    • Performance testing must follow Performance Testing Guide

  2. Development Environment Requirements

    • Ability to generate debug version packages
    • Knowledge of HarmonyOS application packaging and signing process
    • Understanding of the difference between debug and release packages

  3. HDC (Huawei Device Communication) Tool Dependencies

    • Ensure HDC tools are properly installed
    • Configure HDC path in environment variables so it can be called directly from command line
    • Use the following command to check if HDC is installed successfully: 
      hdc version
    • If not properly installed, please refer to HDC Installation Guide

  4. System Requirements

    • Ubuntu 22.04 or compatible system
    • Python 3.10 - 3.12 (required)
    • Node.js v22.14.0
    • Git
    • Other basic tools (vim, unzip, etc.)

//: # (# Command-Line(CMD) Alternative the python virtual environment)

Note:

  1. If you encounter dependency version compatibility issues, please contact our technical support team for assistance
  2. Ensure Hypium 5.0.7.200 is properly installed and can run test cases
  3. It is recommended to first run a simple Hypium test case to verify that the environment configuration is correct

馃搳 Usage Process

1. Preparation Phase

  • Configure Test Environment
    • Install dependencies and tools
    • Ensure using debug version packages
    • Configure Hypium test environment
    • Ensure Python 3.10 environment is properly configured
  • Prepare Test Cases
    • Write test cases according to Hypium guidelines
    • Ensure test cases cover key scenarios
    • Configure performance test parameters
  • Set Analysis Parameters
    • Configure load attribution rules
    • Set analysis granularity

2. Execution Phase

  • Run Tests
    • Use Hypium to execute tests
    • Generate trace files
    • Ensure CPU instruction data is obtained
  • Collect Data
    • Collect CPU instruction data
    • Record other performance metrics
  • Perform Analysis
    • Run load analysis tools
    • Process collected data

3. Analysis Phase

  • View Reports
    • Analyze generated HTML reports
    • Understand performance data
  • Identify Issues
    • Locate high-load modules
    • Discover potential optimization points
  • Develop Solutions
    • Determine optimization direction based on analysis results
    • Develop specific optimization strategies

Important Notes:

  1. Debug version packages must be used to obtain CPU instruction data
  2. Test cases must be written according to Hypium specifications
  3. Docker environment is recommended to avoid environment configuration issues
  4. First-time users are recommended to contact technical support team for guidance
  5. Python version must be 3.10, other versions may cause compatibility issues

Implementation Advice: When using the tool for the first time, we recommend staying in touch with our engineering team. We are happy to provide technical guidance to ensure you can smoothly conduct analysis work and obtain valuable results. Please contact the designated engineer for support.