logbeacon/dist/types/slsClient.d.ts

浏览器端日志采集与上报工具，支持多种日志服务后端，包括阿里云日志服务(SLS)和Grafana Loki

/**
 * 阿里云日志服务客户端类型定义
 */

/**
 * 创建阿里云日志服务客户端
 * @param endpoint - 服务入口，例如 "ap-southeast-1.log.aliyuncs.com"
 * @param accessKeyId - 阿里云访问密钥ID
 * @param accessKeySecret - 阿里云访问密钥密码
 * @param projectName - 项目名称
 * @param logstoreName - 日志库名称
 * @returns 返回一个用于发送日志的函数
 */
export function createLogClient(
  endpoint: string,
  accessKeyId: string,
  accessKeySecret: string,
  projectName: string,
  logstoreName: string
): SendLogsFunction;

/**
 * 发送序列化后的日志数据的函数
 * @param payload - 已经序列化的日志数据
 * @returns HTTP 响应对象
 */
export type SendLogsFunction = (payload: Uint8Array) => Promise<Response>;

/**
 * 日志内容，键值对
 */
export interface SlsLogContent {
  Key: string;
  Value: string;
}

/**
 * 单条日志
 */
export interface SlsLog {
  Time: number; // uint32
  Contents: SlsLogContent[];
  TimeNs?: number; // optional fixed32
}

/**
 * 日志标签
 */
export interface SlsLogTag {
  Key: string;
  Value: string;
}

/**
 * 日志组，是发送到SLS的单位
 */
export interface SlsLogGroup {
  Logs: SlsLog[];
  Reserved?: string; // optional
  Topic?: string; // optional
  Source?: string; // optional
  LogTags?: SlsLogTag[]; // optional
}

/**
 * 解码通过 sendLogs 发送的 payload
 * @param payload - 经过 gzip 压缩和 Protobuf 序列化的日志数据
 * @returns 解码后的日志组对象
 */
export function decodeLogs(payload: Uint8Array): SlsLogGroup;