pd_log library

Core Dart API for pd_log: unified logging and log file queries.

  • Provides multi-level logging (v/d/i/w/e/out) with console output and file writing;
  • All logging operations (console output, file writing, buffering) are fully managed by the Dart layer;
  • Platform service provides log root path and file event listening;
  • Exposes log root path, file listing, and query methods by date/year/month;
  • Since 0.5.0, log path structure is unified as: /<year>/<month>/<day>.log.

Classes

FieldMaskRule
字段名掩码规则,通过字段名匹配敏感数据。
ListOptions
列表查询通用选项,为日志文件查询提供排序与分页能力。
LogEvent
日志变更事件(仅写入 NDJSON,不强制反序列化)。
LogExportResult
日志导出结果
LogLedger
事件溯源 + 快照 的轻量管理器。
LogMasker
敏感数据掩码处理器,负责对数据进行脱敏处理。
LogMaskingConfig
敏感数据掩码配置类。
LogRecord
快照条目:记录某日志文件的最新状态。
LogRotation
日志滚动工具,提供按配置删除过期日志的能力。
LogSearchOptions
LogSearchResult
日志搜索结果条目,代表一条匹配的日志记录。
LogSearchSummary
日志搜索汇总结果,包含所有匹配条目和统计信息。
LogStyleConfig
日志样式配置类,控制日志在控制台/终端中的显示效果。
MaskRule
掩码规则抽象类,定义掩码规则的统一接口。
PDLog
日志工具类,提供统一的日志输出能力。
PDLogConfig
日志配置类,用于全局控制日志的输出行为与文件写入策略。
PDLogFile
日志文件的元信息类,用于承载平台返回或 Dart 枚举得到的日志文件数据。
RegexMaskRule
正则表达式掩码规则,通过正则表达式匹配文本模式。
TimeRange

Enums

LogExportStrategy
日志导出策略枚举
LogLevel
日志级别枚举,定义了从详细到错误的五个日志等级。
LogRetentionStrategy
日志滚动策略枚举,定义日志文件的保留策略。
MaskStrategy
掩码策略枚举,定义不同的掩码处理方式。
SortBy
排序字段枚举,指定日志文件列表的排序依据。
SortDirection
排序方向枚举,指定升序或降序。
UploadState
上传状态枚举,用于跟踪日志文件的上传进度。

Extensions

LogExportStrategyExtension on LogExportStrategy
日志导出策略扩展
LogLevelExt on LogLevel
LogLevel 添加扩展能力,提供便捷的字符串转换。

Constants

kDefaultLogStyles → const Map<LogLevel, LogStyleConfig>
默认样式主题,按日志级别提供常用的颜色与样式。