Android 网络探测插件使用说明

implementation(group: 'com.tencentcloudapi.cls', name: 'tencentcloud-cls-sdk-android', version: '3.0.1')
implementation(group: 'com.tencentcloudapi.cls', name: 'cls-network-diagnosis-reporter-android', version: '3.0.1')

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

private void initCls(Context context) {
    // 1. 初始化核心 SDK
    ClsConfigOptions clsConfigOptions = new ClsConfigOptions(
            "https://ap-guangzhou-open.cls.tencentcs.com",
            "[日志主题 ID]",
            new Credential("[secret_id]", "[secret_key]"));
    clsConfigOptions.enableLog(true);
    clsConfigOptions.addTag("cls_android", "3.0.1");
    ClsDataAPI.startWithConfigOptions(context, clsConfigOptions);

    // 2. 创建并配置网络探测插件
    INetworkDiagnosisPlugin clsNetDiagnosisPlugin = new NetworkDiagnosisPlugin();
    clsNetDiagnosisPlugin.addCustomField("env", "production");  // 可选：添加自定义字段
    clsNetDiagnosisPlugin.setAppCredentialToken("[移动端接入 Token]"); // 从 CLS 控制台获取

    // 3. 注册并启动插件
    ClsDataAPI.sharedInstance(context)
            .addPlugin(clsNetDiagnosisPlugin)
            .startPlugin(context);
}

-keep class net.jpountz.lz4.** { *; }

public void clsHttpPing(Context context) throws NoSuchAlgorithmException {
    INetworkDiagnosis.HttpRequest request = new INetworkDiagnosis.HttpRequest();
    request.domain = "https://ap-guangzhou.cls.tencentcs.com"; // 必填：目标 URL
    request.ip = "1.2.3.4";                                    // 可选：指定目标 IP（绕过 DNS）
    request.headerOnly = true;                                  // 可选：仅获取响应头（默认 false）
    request.downloadBytesLimit = 1024;                          // 可选：限制下载字节数（默认 64KB）
    request.timeout = 30 * 1000;                                // 可选：超时时间，单位毫秒（默认 30000ms）
    request.maxTimes = 3;                                       // 可选：探测次数（默认 10）
    request.multiplePortsDetect = false;                        // 可选：是否多端口探测（默认 true）
    // 可选：SSL 证书校验配置
    request.credential = new INetworkDiagnosis.HttpCredential(getSSLContext(context), null);
    // 可选：自定义扩展字段
    request.extension = new HashMap<String, String>() {{
        put("custom_field", "httpPing");
    }};
    // 不带回调
    CLSNetworkDiagnosis.getInstance().http(request);
    // 带回调
    CLSNetworkDiagnosis.getInstance().http(request, new INetworkDiagnosis.Callback() {
        @Override
        public void onComplete(INetworkDiagnosis.Response response) {
            CLSLog.i("HTTP", response.content);
        }
    });
}

public void clsDNSPing() {
    INetworkDiagnosis.DnsRequest request = new INetworkDiagnosis.DnsRequest();
    request.domain = "ap-guangzhou-open.cls.tencentcs.com"; // 必填：目标域名
    request.type = INetworkDiagnosis.DNS_TYPE_IPv4;          // 可选：DNS 类型，"A"（IPv4）或 "AAAA"（IPv6），默认 "A"
    request.nameServer = "8.8.8.8";                          // 可选：指定 DNS 服务器地址
    request.timeout = 2000;                                  // 可选：超时时间，单位毫秒（默认 2000ms）
    request.extension = new HashMap<String, String>() {{
        put("custom_field", "dns");
    }};
    // 不带回调
    CLSNetworkDiagnosis.getInstance().dns(request);
    // 带回调
    CLSNetworkDiagnosis.getInstance().dns(request, new INetworkDiagnosis.Callback() {
        @Override
        public void onComplete(INetworkDiagnosis.Response response) {
            CLSLog.i("DNS", response.content);
        }
    });
}

public void clsPing() {
    INetworkDiagnosis.PingRequest request = new INetworkDiagnosis.PingRequest();
    request.domain = "ap-guangzhou-open.cls.tencentcs.com"; // 必填：目标域名
    request.size = 64;                                      // 可选：探测包大小，单位 byte（默认 64）
    request.maxTimes = 10;                                  // 可选：探测次数（默认 10）
    request.timeout = 2000;                                 // 可选：超时时间，单位毫秒（默认 2000ms）
    request.multiplePortsDetect = true;                     // 可选：是否多端口探测（默认 true）
    request.extension = new HashMap<String, String>() {{
        put("custom_field", "ping");
    }};
    // 不带回调
    CLSNetworkDiagnosis.getInstance().ping(request);
    // 带回调
    CLSNetworkDiagnosis.getInstance().ping(request, new INetworkDiagnosis.Callback() {
        @Override
        public void onComplete(INetworkDiagnosis.Response response) {
            CLSLog.i("Ping", response.content);
        }
    });
}

public void clsMTR() {
    INetworkDiagnosis.MtrRequest request = new INetworkDiagnosis.MtrRequest();
    request.domain = "ap-guangzhou-open.cls.tencentcs.com";        // 必填：目标域名
    request.protocol = INetworkDiagnosis.MtrRequest.Protocol.ICMP; // 可选：探测协议（默认 ALL）
    request.maxTTL = 30;                                           // 可选：最大跳数（默认 30）
    request.maxPaths = 1;                                          // 可选：最大路径数（默认 1）
    request.maxTimes = 10;                                         // 可选：每跳探测次数（默认 10）
    request.timeout = 2000;                                        // 可选：超时时间，单位毫秒（默认 2000ms）
    request.multiplePortsDetect = true;                            // 可选：是否多端口探测（默认 true）
    request.extension = new HashMap<String, String>() {{
        put("custom_field", "mtr");
    }};
    // 不带回调
    CLSNetworkDiagnosis.getInstance().mtr(request);
    // 带回调
    CLSNetworkDiagnosis.getInstance().mtr(request, new INetworkDiagnosis.Callback() {
        @Override
        public void onComplete(INetworkDiagnosis.Response response) {
            CLSLog.i("MTR", response.content);
        }
    });
}

public void clsTcpPing() {
    INetworkDiagnosis.TcpPingRequest request = new INetworkDiagnosis.TcpPingRequest();
    request.domain = "ap-guangzhou-open.cls.tencentcs.com"; // 必填：目标域名
    request.port = 80;                                      // 必填：目标端口
    request.payload = "hello";                              // 可选：发送的探测数据
    request.maxTimes = 10;                                  // 可选：探测次数（默认 10）
    request.timeout = 2000;                                 // 可选：超时时间，单位毫秒（默认 2000ms）
    request.size = 64;                                      // 可选：探测包大小，单位 byte（默认 64）
    request.multiplePortsDetect = true;                     // 可选：是否多端口探测（默认 true）
    request.extension = new HashMap<String, String>() {{
        put("custom_field", "tcpPing");
    }};
    // 不带回调
    CLSNetworkDiagnosis.getInstance().tcpPing(request);
    // 带回调
    CLSNetworkDiagnosis.getInstance().tcpPing(request, new INetworkDiagnosis.Callback() {
        @Override
        public void onComplete(INetworkDiagnosis.Response response) {
            CLSLog.i("TcpPing", response.content);
        }
    });
}