bytedance/tailor

Tailor

简体中文版说明 >>>

Tailor is a general-purpose hprof cropping and compression tool developed by Xigua video android team. Through it, a mini hprof file can be dump directly during exception handling. There is no sensitive information in the file。More importantly, the file is small but the data is relatively complete, which is very suitable for offline analysis of oom and other exceptions

Apps using Tailor

Get started

Step 1: Add the JitPack repository to your build file

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Step 2: Add the dependency

dependencies {
    implementation 'com.github.bytedance:tailor:1.1.6'
}

Step 3: Add code for simple usage

if (e instanceof java.lang.OutOfMemoryError) {
    String path = Environment.getExternalStorageDirectory().getAbsolutePath() + File.separator + "mini.hprof";
    try {
        Tailor.dumpHprofData(path, true);
    } catch (IOException ex) {
        ex.printStackTrace();
    }
}

// Crop and compress the existing hprof files directly
Tailor.cropHprofData(source, target, true);

Step 4: Upload data

## !!! App needs to implement upload logic by itself

Step 5: Process data (Python version >= 3.5)

## Data recovery
python3 library/src/main/python/decode.py -i mini.hprof -o target.hprof

## Hprof verify
python3 library/src/main/python/verify.py -i source.hprof

## Crop and compress
python3 library/src/main/python/encode.py -i source.hprof -o mini.hprof

Extra

1. Android Camera内存问题剖析
2. 西瓜视频稳定性治理体系建设一：Tailor 原理及实践
3. 西瓜视频稳定性治理体系建设二：Raphael 原理及实践

Support

1. Communicate on GitHub issues
2. Mail: shentianzhou.stz@gmail.com
3. WeChat: 429013449
4. QQ Group

License

Copyright (c) 2020 ByteDance Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.