refactor: reorganize docs into plan/ and add skills/
This commit is contained in:
48
docs/api/debug/debug-logentry.md
Normal file
48
docs/api/debug/debug-logentry.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# LogEntry
|
||||
|
||||
**命名空间**: `XCEngine::Debug`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**描述**: 日志条目结构体,包含单条日志的所有信息。
|
||||
|
||||
## 概述
|
||||
|
||||
`LogEntry` 是日志系统的核心数据结构,每次日志记录都生成一个 `LogEntry` 并分发给所有注册的 Sink。
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `level` | `LogLevel` | 日志级别 |
|
||||
| `category` | `LogCategory` | 日志分类 |
|
||||
| `message` | `Containers::String` | 日志消息内容 |
|
||||
| `file` | `Containers::String` | 源代码文件路径 |
|
||||
| `line` | `int32_t` | 源代码行号 |
|
||||
| `function` | `Containers::String` | 函数名称 |
|
||||
| `timestamp` | `uint64_t` | 时间戳(毫秒) |
|
||||
| `threadId` | `uint32_t` | 线程 ID |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
// 实现自定义 Sink 时访问 LogEntry
|
||||
class MySink : public ILogSink {
|
||||
public:
|
||||
void Log(const LogEntry& entry) override {
|
||||
printf("[%llu][%u] %s::%s: %s\n",
|
||||
(unsigned long long)entry.timestamp,
|
||||
(unsigned)entry.threadId,
|
||||
LogCategoryToString(entry.category),
|
||||
LogLevelToString(entry.level),
|
||||
entry.message.CStr());
|
||||
}
|
||||
|
||||
void Flush() override { }
|
||||
};
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ILogSink](./debug-ilogsink.md) - 日志输出接口
|
||||
- [Logger](./debug-logger.md) - 日志记录器
|
||||
Reference in New Issue
Block a user