本文以Android应用为例,介绍如何接入SDK和使用新H5监控的详细步骤。
注意
后续平台只在新H5监控的功能基础上进行更新,H5监控和文件管理中Sourcemap管理会下线,已接入H5监控的业务建议执行以下步骤删除旧版H5监控,然后接入新H5监控。
删除初始化SDK中开启webview监控的内容。
//控制是否打开WebView监控 builder.enableWebViewMonitor(true);
删除配置webview的内容。
//设置webView的WebChromeClient如下或者继承WebViewMonitorWebChromeClient webView.setWebChromeClient( new WebViewMonitorWebChromeClient()); //设置webView的WebViewClient如下或者继承WebViewMonitorWebViewClient webView.setWebViewClient(new WebViewMonitorWebViewClient()); //WebView加载url时候需要调用如下函数 WebViewMonitorHelper.getInstance().onLoadUrl(webView, url);
在project级别的build.gradle
文件中,添加maven地址。
buildscript { repositories { maven { url "https://artifact.bytedance.com/repository/Volcengine/" } maven { url "https://artifact.bytedance.com/repository/byteX/" } } } allprojects { repositories { maven { url "https://artifact.bytedance.com/repository/Volcengine/" } } }
接入应用性能监控全链路版。
在project级别的build.gradle
文件的dependencies中,添加以下代码,接入插件组件辅助插桩。apm_insight_plugin
国内海外使用同一个版本。
classpath "com.volcengine:apm_insight_plugin:1.4.2"
在app module的build.gradle
文件的dependencies中,添加以下代码,根据国内应用还是海外应用选择下面两个版本的一个。
国内应用接入cn版本,上报到中国,使用如下依赖:
// 国内应用在dependencies中添加 implementation 'com.volcengine:apm_insight:1.5.6.cn' implementation 'com.volcengine:apm_insight_crash:1.5.9'
海外应用接入oversea版本,上报到马来西亚柔佛,使用如下依赖:
// 海外应用在dependencies中添加 implementation 'com.volcengine:apm_insight:1.5.7.oversea' implementation 'com.volcengine:apm_insight_crash:1.5.8.oversea'
在Application中onCreate中,添加以下代码,初始化性能相关功能。
注意
请在主线程中添加初始化性能相关功能的代码。
//必须放到Application的onCreate里面,会注册监听生命周期,不涉及数据采集和隐私合规问题 ApmInsight.getInstance().init(application); //初始化自定日志,配置自定义日志最大占用磁盘,内部一般配置20,代表最大20M磁盘占用。1.4.1版本开始存在这个api VLog.init(this,20);
启动新H5监控,开始收集数据。
注意
请在用户同意隐私政策后,再调用方法收集数据。
//在同意隐私合规后调用,启动性能组件监控 ApmInsightInitConfig.Builder builder = ApmInsightInitConfig.builder(); //控制是否打开新H5监控 builder.enableHybridMonitor(true); ApmInsight.getInstance().start(builder.build());
配置WebView监控。
webView.setWebChromeClient(new WebChromeClient(){ @Override public void onProgressChanged(WebView view, int newProgress) { super.onProgressChanged(view, newProgress); //调用如下函数控制新H5监控js加载 HybridMonitorManager.getInstance().onProgressChanged(view,newProgress); } }); //WebView加载url前需要调用如下函数 HybridMonitorManager.getInstance().onLoadUrl(webView,url); webView.loadUrl(url);
在SDK上报配置页面,修改新H5监控模块下配置项新H5监控采样率。默认采样率为20%。具体操作,请参见SDK上报配置。