快速启动
该门户网站正在开发中。文档的完整版本请看这里.
注册和设置
首先你需要:
-
登录 Tracer 账户。
-
创建或加入组织。
-
添加 Android 项目(需要是组织的管理员或所有者)。
将追踪器的依赖项添加到项目中
在您的 <project>/settings.gradle
pluginManagement {
repositories {
maven { url 'https://artifactory-external.vkpartner.ru/artifactory/maven/' }
}
}
dependencyResolutionManagement {
repositories {
maven { url 'https://artifactory-external.vkpartner.ru/artifactory/maven/' }
}
}
在您的 <project>/<app-module>/build.gradle
plugins {
id
'ru.ok.tracer' version '0.2.7'}
tracer {
defaultConfig {
// 参见"设置"部分
pluginToken = "PLUGIN_TOKEN"
appToken = "APP_TOKEN"
// 包括为构建加载映射。默认启用
uploadMapping = true }
// 也可以为每个 flavor, buildType, buildVariant设置配置.
// 配置继承自 defaultConfig.
debug {
// 参数\...
}
demoDebug {
// 参数...
}
}
dependencies {
// 插件相互独立。可以只连接,
// 当前所需的.
// 收集和分析崩溃及 ANR
implementation "ru.ok.tracer:tracer-crash-report:0.2.7"
// 收集和分析原生崩溃
implementation "ru.ok.tracer:tracer-crash-report-native:0.2.7"
// 收集和分析OOM时的堆转储
implementation "ru.ok.tracer:tracer-heap-dumps:0.2.7"
// 分析设备的磁盘空间使用
implementation "ru.ok.tracer:tracer-disk-usage:0.2.7"
// 采样分析器
implementation "ru.ok.tracer:tracer-profiler-sampling:0.2.7"
// 系统追踪
implementation "ru.ok.tracer:tracer-profiler-systrace:0.2.7"}
启用追踪器插件及其在项目中的配置
在您的 Application.kt 中,实现 HasTracerConfiguration 接口。
class MyApplication : Application(), HasTracerConfiguration {
override val tracerConfiguration: List<TracerConfiguration>
get() = listOf(
CoreTracerConfiguration.build {
// 追踪器核心选项
},
CrashReportConfiguration.build {
// 崩溃报告选项
},
CrashFreeConfiguration.build {
// crash free统计选项
},
HeapDumpConfiguration.build {
// ООМ时堆转储选项
},
DiskUsageConfiguration.build {
// 磁盘使用分析选项
},
SystraceProfilerConfiguration.build {
// 生产环境中的systrace分析器选项
},
SamplingProfilerConfiguration.build {
// 采样分析器选项},
)
}
HasTracerConfiguration.tracerConfiguration属性将在进程启动时仅被请求一次,这发生在Application.onCreate被调用之前但在Application.attachBaseContext之后。在getter中,您已经可以访问应用程序的上下文,但还为时过早访问在onCreate中初始化的内容。
各选项的详细描述
-
CoreTracerConfiguration --- 请参阅本页下方;
-
CrashReportConfiguration 和 CrashFreeConfiguration --- 请参阅"Crash 和 ANR"页面;
-
HeapDumpConfiguration --- 请参阅"Heap Dumps"页面;
-
DiskUsageConfiguration --- 请参阅"Disk Usage"页面;
-
SystraceProfilerConfiguration --- 请参阅"Systrace Profiler"页面;
-
SamplingProfilerConfiguration --- 请参阅"Sampling Profiler"页面。
CoreTracerConfiguration 描述
在罕见的情况下,当您想要在项目中配置追踪器核心时,需要从 HasTracerConfiguration 返回 CoreTracerConfiguration
class MyApplication : Application(), HasTracerConfiguration {
override val tracerConfiguration: List<TracerConfiguration>
get() = listOf(
CoreTracerConfiguration.build {
// 您的选项
},
)
}
CoreTracerConfiguration.Builder选项:
-
setEnabled --- 该选项不再使用,将在0.3.x版本中移除。追踪器核心始终启用,但在没有启用的插件时不处于活动状态;
-
setHost, provideHost --- 更改追踪器地址;
-
setStatHost, provideStatHost --- 更改crash free功能的追踪器地址;
-
setCustomAppKey, provideCustomAppKey --- 替换gradle插件配置中的sampleUploadToken。