This release is a pre-release and may not be stable for production use.
llm-log-system
面向 Python、LangChain 与 LangGraph 的低侵入大语言模型调用日志与链路追踪 SDK,配合自托管的 LLM Log System 服务端使用。
当前版本为
0.2.0rc1候选版本,建议先用于评估、集成测试和预发布环境。
功能
- 手动创建 Trace、LLM Span 和自定义 Span;
- 通过手动 API、轻量 Logger 或标准库
logging.Handler采集普通业务日志; - 自动采集 LangChain chain、LLM、chat model、tool 与 retriever;
- 关联 LangGraph 根图、节点、并行分支和子图;
- 支持同步、异步、流式、异常和取消调用;
- 客户端递归脱敏、正文开关和 UTF-8 字节截断;
- 有界内存队列、后台批量、短超时、有限重试和 gzip;
- 上报故障默认不影响模型调用和业务异常语义;
- 提供无敏感信息的本地诊断计数。
安装
安装当前候选版本:
python -m pip install --pre llm-log-system
也可以固定版本:
python -m pip install "llm-log-system==0.2.0rc1"
按使用的框架安装可选依赖:
python -m pip install "llm-log-system[langchain]==0.2.0rc1"
python -m pip install "llm-log-system[langgraph]==0.2.0rc1"
python -m pip install "llm-log-system[integrations]==0.2.0rc1"
手动采集只依赖 httpx 和 pydantic,不需要安装 LangChain 或 LangGraph。
快速开始
先在 Web 控制台创建应用和 API Key,然后配置采集端:
export LLM_LOG_ENDPOINT=https://logs.example.com
export LLM_LOG_API_KEY=llmlog_your_api_key
export LLM_LOG_ENVIRONMENT=production
LLM_LOG_ENDPOINT 应填写服务根地址,不要附加 /api/v1/ingest/spans:batch。
手动采集
from llm_log_system import LLMLogClient
client = LLMLogClient(global_tags={"service": "summary-api"})
try:
with client.trace("生成摘要"):
with client.llm_span("provider/model", name="摘要模型") as span:
prompt = "请总结这段文本"
span.set_input({"prompt": prompt})
result = {"content": "这里是模型返回结果"}
span.set_output(result)
span.set_usage(input_tokens=12, output_tokens=8, total_tokens=20)
finally:
client.close()
普通日志
普通日志与当前 Trace/Span 自动关联,并沿用异步队列、脱敏、截断和有限重试:
from llm_log_system import LLMLogClient
client = LLMLogClient()
logger = client.logger("checkout.order")
try:
with client.trace("创建订单"):
logger.info("订单 %s 创建成功", "order-123", extra={"amount": 99.9})
finally:
client.close()
也可以显式接入 Python 标准库 Logger。Handler 不会自动挂到 root Logger:
import logging
from llm_log_system import LLMLogClient
client = LLMLogClient()
application_logger = logging.getLogger("checkout")
application_logger.addHandler(client.logging_handler(level=logging.INFO))
application_logger.info("支付完成", extra={"order_id": "order-123"})
logger.info("订单 %s", order_id) 会在客户端先格式化消息;extra 会作为结构化 Attributes 采集。使用 logger.exception() 或标准库 exc_info 时,异常类型、消息和截断堆栈会一起进入脱敏管线。
上下文管理器会自动记录开始时间、结束时间、耗时、成功状态和业务异常。需要显式等待后台队列时使用:
client.flush(timeout=5)
LangChain
from llm_log_system import LLMLogClient
client = LLMLogClient()
callback = client.langchain_callback()
result = runnable.invoke(
{"question": "什么是链路追踪?"},
config={"callbacks": [callback]},
)
client.close()
LangGraph
from llm_log_system import LLMLogClient
client = LLMLogClient()
callback = client.langchain_callback()
result = graph.invoke(
{"question": "分析这次工作流"},
config={"callbacks": [callback]},
)
client.close()
异步调用使用框架原生 ainvoke,流式调用沿用 stream 或 astream。同一个回调实例可以关联图、节点、模型、工具、检索器和子图。
配置
显式传入 LLMLogClient 的参数优先于环境变量。
| 环境变量 | 默认值 | 说明 |
|---|---|---|
LLM_LOG_ENDPOINT |
无 | LLM Log System 服务根地址 |
LLM_LOG_API_KEY |
无 | 应用 API Key |
LLM_LOG_ENVIRONMENT |
development |
日志所属环境 |
LLM_LOG_ENABLED |
true |
是否启用采集 |
LLM_LOG_CAPTURE_INPUT |
true |
是否采集输入正文 |
LLM_LOG_CAPTURE_OUTPUT |
true |
是否采集输出正文 |
LLM_LOG_CAPTURE_LOGS |
true |
是否采集普通日志 |
LLM_LOG_MIN_LEVEL |
INFO |
普通日志最低采集级别 |
LLM_LOG_MAX_FIELD_BYTES |
65536 |
单字段最大 UTF-8 字节数 |
LLM_LOG_MAX_MESSAGE_BYTES |
同上 | 普通日志消息最大 UTF-8 字节数 |
LLM_LOG_ATTRIBUTES_MAX_KEYS |
100 |
普通日志 Attributes 最大键数 |
LLM_LOG_QUEUE_SIZE |
1000 |
本地有界队列容量 |
LLM_LOG_BATCH_SIZE |
50 |
单批最大 Span 数量 |
LLM_LOG_GZIP |
false |
是否压缩批量请求 |
未同时配置 Endpoint 和 API Key 时,SDK 不会启动后台发送线程,手动上下文和业务代码仍可正常执行。
隐私与可靠性
- 默认对常见密码、Token、密钥和认证字段进行递归脱敏;
- 使用
capture_input=False或capture_output=False关闭正文采集; - 使用
redaction_patterns或custom_redactor增加业务脱敏规则; - 队列满时优先保证业务线程,不对模型调用施加无限背压;
- 网络错误、限流和服务端错误仅进行有限次数重试;
- 默认模式下采集错误不会覆盖业务返回值或业务异常;
strict=True仅适合测试和调试环境。
Prompt、模型响应和 metadata 可能包含业务机密或个人信息。生产接入前应根据自己的数据分类要求关闭不必要的正文采集并配置脱敏规则。
诊断
SDK 诊断信息只保留在本地,不会再次上传到采集服务:
diagnostics = client.get_diagnostics()
print(diagnostics.queued)
print(diagnostics.sent)
print(diagnostics.retried)
print(diagnostics.failed)
print(diagnostics.dropped)
print(diagnostics.log_queued)
print(diagnostics.log_sent)
print(diagnostics.log_failed)
print(diagnostics.log_dropped)
兼容性
- Python 3.10~3.13;
langchain-core>=0.3.27,<2;langgraph>=0.2.60,<2;- 未安装框架可选依赖时,核心 SDK 仍可导入和使用。
最低与最新已验证组合见框架兼容矩阵。
文档与示例
开发
从源码安装 SDK:
git clone https://github.com/moshangsang24/llm-log.git
cd llm-log
make setup
make test-sdk
提交变更前请阅读仓库协作指南。
许可证
本 SDK 基于 Apache License 2.0 发布,并遵守项目的 NOTICE 声明。
Metadata
Release files for llm-log-system 0.2.0rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| llm_log_system-0.2.0rc1.tar.gz | 30.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| llm_log_system-0.2.0rc1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 70.9 kB
Release files / llm_log_system-0.2.0rc1.tar.gz
| Download URL | llm_log_system-0.2.0rc1.tar.gz |
|---|---|
| Size | 30.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e91fd2ba691e48eb234e3e8bedc354859de8942645f115876cc4c74c70821d47
|
|
BLAKE2b-256 checksum How to use checksums |
a1dc22b595bc222843a97c0105b25a1f042044f012bb29ded4d159c995f8a94e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 12, 2026.
Transparency logRelease files / llm_log_system-0.2.0rc1-py3-none-any.whl
| Download URL | llm_log_system-0.2.0rc1-py3-none-any.whl |
|---|---|
| Size | 40.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2fecd06bce59f37e016d8b399c427cbb3aff71955341bb5e1d82cf3fce4a8ce1
|
|
BLAKE2b-256 checksum How to use checksums |
506059e22cf7dfd6e2b5a9822eb9fa4b74ccdb5e27c887c2789719272164b801
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 12, 2026.
Transparency log