You need to enable JavaScript to run this app.
导航
使用新H5监控
最近更新时间:2024.06.17 15:28:23首次发布时间:2024.01.17 17:58:57

本文以Android应用为例,介绍如何接入SDK和使用新H5监控的详细步骤。

注意

  • 后续只在新H5监控的功能基础上进行更新,已接入H5监控的业务可以删除旧版接入新H5监控。
  • 新H5监控能力和WebPro端监控主要能力对齐。更全面的能力需要接入WebPro端监控。

步骤一:删除H5监控

后续平台只在新H5监控的功能基础上进行更新,H5监控和文件管理中Sourcemap管理会下线,已接入H5监控的业务建议执行以下步骤删除旧版H5监控,然后接入新H5监控。

  1. 删除初始化SDK中开启webview监控的内容。

    //控制是否打开WebView监控
    builder.enableWebViewMonitor(true);
    
  2. 删除配置webview的内容。

    //设置webView的WebChromeClient如下或者继承WebViewMonitorWebChromeClient
    webView.setWebChromeClient( new WebViewMonitorWebChromeClient());
    //设置webView的WebViewClient如下或者继承WebViewMonitorWebViewClient
    webView.setWebViewClient(new WebViewMonitorWebViewClient());
    //WebView加载url时候需要调用如下函数
    WebViewMonitorHelper.getInstance().onLoadUrl(webView, url);
    

步骤二:接入SDK

  1. 在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/"
            }
        }
    }
    
  2. 接入应用性能监控全链路版。

    1. 在project级别的build.gradle文件的dependencies中,添加以下代码,接入插件组件。

      classpath "com.volcengine:apm_insight_plugin:1.4.2"
      
    2. 在app module的build.gradle文件的dependencies中,添加以下代码,完成插桩。
      插桩是为了辅助收集启动耗时、页面加载、网络监控的数据,这部分只适用于接入App进行监控的用户,不适用接入SDK进行监控的用户。

      //在文件头添加
      apply plugin: 'apm-plugin'
      // 在dependencies中添加
      implementation 'com.volcengine:apm_insight:1.5.4.cn-rc.1'
      implementation 'com.volcengine:apm_insight_crash:1.5.1'
      

步骤三:初始化SDK并开启新H5监控

  1. 在Application中onCreate中,添加以下代码,初始化性能相关功能。

    注意

    请在主线程中添加初始化性能相关功能的代码。

    //必须放到Application的onCreate里面,会注册监听生命周期,不涉及数据采集和隐私合规问题
    ApmInsight.getInstance().init(application);
    //初始化自定日志,配置自定义日志最大占用磁盘,内部一般配置20,代表最大20M磁盘占用。1.4.1版本开始存在这个api
    VLog.init(this,20);
    
  2. 启动新H5监控,开始收集数据。

    注意

    请在用户同意隐私政策后,再调用方法收集数据。

    //在同意隐私合规后调用,启动性能组件监控
    ApmInsightInitConfig.Builder builder = ApmInsightInitConfig.builder();
    //控制是否打开新H5监控
    builder.enableHybridMonitor(true);
    ApmInsight.getInstance().start(builder.build());
    
  3. 配置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上报配置

SDK上报配置页面,修改新H5监控模块下配置项新H5监控采样率。默认采样率为20%。具体操作,请参见SDK上报配置
图片

步骤五:使用新H5监控

  • 新H5监控报警页面,新建一个报警任务,报警策略中配置新H5监控的报警类型和报警指标。详情请参见新建报警任务
    当收到报警通知时,在新H5监控功能页面查看页面的监控数据。
  • 自定义看板页面,配置关注的图表类型和新H5监控的指标。详情请参见创建看板
    定期查看看板数据,关注看板里新H5监控指标数据的变化。