CLS JavaScript SDK

腾讯云CLS日志上传SDK

Install

npm i tencentcloud-cls-sdk-miniapp

Configuration

| Property | Type | Description | Default | |------------------|---------------------|-----------------------------------|---------| | host | string | - | - | | topicId | string | 日志主题 | - | | time | number (optional) | 发送时间阈值 | 10s | | count | number (optional) | 发送条数阈值 | 10 | | source | string (optional) | 日志来源 | - | | onPutlogsError | function (optional) | 上传异常回调 | - | | platform | string | 小程序平台: 抖音小程序: tt 快应用： quick-app | - | | platform_request | function | 小程序平台 request 方法 | |

CLS Host

endpoint填写请参考可用地域中 API上传日志 Tab中的域名

Example

抖音平台

import {Log, WebTracker, WebTrackerOptions} from 'tencentcloud-cls-sdk-miniapp'

 let clsTracker = new WebTracker({
      host: "[域名: http://ap-guangzhou-open.cls.tencentcs.com"],
      topicId: "【topicId】",
      time: 10,
      count: 20,
      source: "127.0.0.1",
      platform: "tt",
      platform_request: tt.request,
      onPutlogsError: function(res) {
           console.log(res)
      } 
  })
  let log = new Log(Date.now())
  log.addContent("hello", "hello world中文")
  log.addContent("world", "你好，我来自深圳|hello world2")
  clsTracker.send(log)   

快应用平台

import {Log, WebTracker, WebTrackerOptions} from 'tencentcloud-cls-sdk-miniapp'
import requesttask from '@system.requesttask'

 let clsTracker = new WebTracker({
      host: "[域名: http://ap-guangzhou-open.cls.tencentcs.com"],
      topicId: "【topicId】",
      time: 10,
      count: 20,
      source: "127.0.0.1",
      platform: "quick-app",
      platform_request:requesttask.request,
      onPutlogsError: function(res) {
           console.log(res)
      } 
  })
  let log = new Log(Date.now())
  log.addContent("hello", "hello world中文")
  log.addContent("world", "你好，我来自深圳|hello world2")
  clsTracker.send(log)   

支付宝小程序平台

import {Log, WebTracker, WebTrackerOptions} from 'tencentcloud-cls-sdk-miniapp'
import requesttask from '@system.requesttask'

 let clsTracker = new WebTracker({
      host: "[域名: http://ap-guangzhou-open.cls.tencentcs.com"],
      topicId: "【topicId】",
      time: 10,
      count: 20,
      source: "127.0.0.1",
      platform: "alipay",
      platform_request:my.request,
      onPutlogsError: function(res) {
           console.log(res)
      } 
  })
  let log = new Log(Date.now())
  log.addContent("hello", "hello world中文")
  log.addContent("world", "你好，我来自深圳|hello world2")
  clsTracker.send(log)   

钉钉小程序

import {Log, WebTracker, WebTrackerOptions} from 'tencentcloud-cls-sdk-miniapp'
import requesttask from '@system.requesttask'

 let clsTracker = new WebTracker({
      host: "[域名: http://ap-guangzhou-open.cls.tencentcs.com"],
      topicId: "【topicId】",
      time: 10,
      count: 20,
      source: "127.0.0.1",
      platform: "dd",
      platform_request:dd.httpRequest,
      onPutlogsError: function(res) {
           console.log(res)
      } 
  })
  let log = new Log(Date.now())
  log.addContent("hello", "hello world中文")
  log.addContent("world", "你好，我来自深圳|hello world2")
  clsTracker.send(log)   

Function

单条日志上传: send(log: Log): void;
单条日志立即上传（time和count参数不生效）:  sendImmediate(log: Log): void;
批量日志上传:  sendBatchLogs(logs: Log[]): void;
批量日志立即上传: sendBatchLogsImmediate(logs: Log[]): void;