Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Reporter

日志上报工具

Hierarchy

  • Reporter

Index

Constructors

Events

Properties

Methods

Constructors

constructor

  • new Reporter(className: string, instanceName?: string): Reporter

  • 构造函数

    Parameters

    • className: string

      类名

    • Optional instanceName: string

      实例名

    Returns Reporter

Events

Static onlog

  • onlog(logStr: string, level: LoggerLevel, className: string, formatStr: string, ...args: any[]): void

  • Parameters

    • logStr: string

      该条日志的格式化后的字符串, 可直接打印到控制台

    • level: LoggerLevel

      日志等级

    • className: string

      该日志对应的类名

    • formatStr: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns void

Properties

className

className: string

类名

instanceName

instanceName: string

实例名

Static DEFAULT_LEVEL

DEFAULT_LEVEL: LoggerLevel = ...

默认日志控制台打印等级为LoggerLevel.DEBUG, 日志等级与日志打印关系见LoggerLevel

Static DEFAULT_LOG_INFO

DEFAULT_LOG_INFO: LogInfo

Static DEFAULT_REPORT_FUNC

DEFAULT_REPORT_FUNC: ReportFunc = ...

默认的日志上报方法

Static DEFAULT_REPORT_LEVELS

DEFAULT_REPORT_LEVELS: LoggerLevel[] = ...

默认需要进行上报的日志等级为LoggerLevel.INFO和LoggerLevel.ERROR

Static _report

_report: ReportFunc = ...

日志上报方法, 应返回一个 Promise

Static reporter

reporter: Reporter = ...

Methods

debug

  • debug(format: string, ...args: any[]): void

  • 记录LoggerLevel.DEBUG级别的日志

    Parameters

    • format: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns void

error

  • error(format: string, ...args: any[]): void

  • 记录LoggerLevel.ERROR级别的日志

    Parameters

    • format: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns void

errorToObject

  • errorToObject(format: string, ...args: any[]): Error

  • 功能同error, 但errorToObject将返回一个{@link Error}对象

    Parameters

    • format: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns Error

info

  • info(format: string, ...args: any[]): void

  • 记录LoggerLevel.INFO级别的日志

    Parameters

    • format: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns void

log

  • log(level: LoggerLevel, formatStr: string, ...args: any[]): string

  • 记录指定级别的日志

    Parameters

    • level: LoggerLevel

      日志级别

    • formatStr: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns string

objectToError

  • objectToError(error: Error): void

  • 功能同error, 但objectToError可传入一个{@link Error}对象

    Parameters

    • error: Error

    Returns void

warning

  • warning(format: string, ...args: any[]): void

  • 记录LoggerLevel.WARN级别的日志

    Parameters

    • format: string

      格式化字符串

    • Rest ...args: any[]

      格式化参数

    Returns void

Static _mergeLog

  • _mergeLog(logList: LogInfo[]): string[][]

  • 日志处理函数 日志截断, 限制上传大小, 根据 {@link Reporter._reportLevels} 过滤日志

    Parameters

    Returns string[][]

Static _reportSuccessCallback

  • _reportSuccessCallback(): void

  • 设置上报成功回调

    Returns void

Static addReferKey

  • addReferKey(key: string, tags?: string[], params?: {}): Promise<void>

  • 在 之后 上报的日志中添加一个引用infoId, 可根据infoId进行日志搜索. infoId集合是一个Map对象. key即为第一个传入参数key, value是服务端返回的infoId

    Parameters

    • key: string

      infoId对应的key

    • Optional tags: string[]

      日志可根据tags中的字段进行查询

    • Optional params: {}
      • [key: string]: any

    Returns Promise<void>

Static asArray

  • 以数组形式返回日志信息

    数组项格式说明:

    Index Type Description
    0 {@link number} 日志级别
    1 {@link string} 格式化字符串
    2... {@link ...*} 格式化参数

    Parameters

    • level: LoggerLevel = ...

      指定获取什么等级的日志

    Returns LogInfo[]

Static asText

  • 以文本格式返回日志信息

    Parameters

    • level: LoggerLevel = ...

      指定获取什么等级的日志

    Returns string

Static asTextFile

  • asTextFile(filename?: string, level?: LoggerLevel): void

  • 下载为文件

    Parameters

    • filename: string = ...

      下载的文件名

    • level: LoggerLevel = ...

      指定获取什么等级的日志

    Returns void

Static clearPlugin

  • clearPlugin(): void

  • 停止所有插件

    Returns void

Static flush

  • flush(): Promise<void>

  • 上报缓冲区的日志

    Returns Promise<void>

Static plugin

  • plugin(plugin: any): void

  • 添加插件并使用

    Parameters

    • plugin: any

      需要添加的插件

    Returns void

Static removeReferKey

  • removeReferKey(key: string): void

  • 移除一个引用的infoId

    Parameters

    Returns void

Static reportLog

  • reportLog(log: LogInfo): Promise<any>

  • Parameters

    Returns Promise<any>

Static setLogLevel

  • 设置日志等级

    Parameters

    Returns void

Static setReportLevel

  • 设置上报日志的等级, 如传入空数组将不会上报任何日志

    Parameters

    • levels: LoggerLevel[]

      需要上报的日志等级的数组

    Returns void

Static startReport

  • 开始日志上报 如传入socket, 将会通过socket将收集到的日志上报到服务器

    Parameters

    Returns Promise<void>

Static stopReport

  • stopReport(): Promise<void>

  • 结束日志上报，结束之前会将缓存的消息上报, 之后将会释放保存的日志

    Returns Promise<void>

Generated using TypeDoc