diff --git a/docs/plugins/api/logging-api.md b/docs/plugins/api/logging-api.md new file mode 100644 index 000000000..d656f1ef3 --- /dev/null +++ b/docs/plugins/api/logging-api.md @@ -0,0 +1,29 @@ +# Logging API + +Logging API模块提供了获取本体logger的功能,允许插件记录日志信息。 + +## 导入方式 + +```python +from src.plugin_system.apis import logging_api +# 或者 +from src.plugin_system import logging_api +``` + +## 主要功能 +### 1. 获取本体logger +```python +def get_logger(name: str) -> structlog.stdlib.BoundLogger: +``` +获取本体logger实例。 + +**Args:** +- `name` (str): 日志记录器的名称。 + +**Returns:** +- 一个logger实例,有以下方法: + - `debug` + - `info` + - `warning` + - `error` + - `critical` \ No newline at end of file