llm-log-system 0.1.0rc1__tar.gz

llm_log_system-0.1.0rc1/.gitignore

@@ -0,0 +1,22 @@
+.env
+.venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+
+node_modules/
+web/dist/
+playwright-report/
+test-results/
+
+.idea/
+.vscode/
+.DS_Store
+
+deploy/postgres-data/
+

llm_log_system-0.1.0rc1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

llm_log_system-0.1.0rc1/NOTICE

@@ -0,0 +1,4 @@
+LLM Log System
+Copyright 2026 moshangsang24
+
+This product includes software developed by the LLM Log System contributors.

llm_log_system-0.1.0rc1/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: llm-log-system
+Version: 0.1.0rc1
+Summary: Self-hosted LLM observability SDK for Python, LangChain, and LangGraph
+Project-URL: Homepage, https://github.com/moshangsang24/llm-log
+Project-URL: Documentation, https://github.com/moshangsang24/llm-log#readme
+Project-URL: Repository, https://github.com/moshangsang24/llm-log
+Project-URL: Issues, https://github.com/moshangsang24/llm-log/issues
+Project-URL: Changelog, https://github.com/moshangsang24/llm-log/blob/main/CHANGELOG.md
+Author: moshangsang24
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: langchain,langgraph,llm,observability,tracing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.10
+Provides-Extra: integrations
+Requires-Dist: langchain-core<2,>=0.3.27; extra == 'integrations'
+Requires-Dist: langgraph<2,>=0.2.60; extra == 'integrations'
+Provides-Extra: langchain
+Requires-Dist: langchain-core<2,>=0.3.27; extra == 'langchain'
+Provides-Extra: langgraph
+Requires-Dist: langchain-core<2,>=0.3.27; extra == 'langgraph'
+Requires-Dist: langgraph<2,>=0.2.60; extra == 'langgraph'
+Description-Content-Type: text/markdown
+
+# llm-log-system
+
+[![PyPI](https://img.shields.io/pypi/v/llm-log-system?include_prereleases)](https://pypi.org/project/llm-log-system/)
+[![Python](https://img.shields.io/pypi/pyversions/llm-log-system)](https://pypi.org/project/llm-log-system/)
+[![CI](https://github.com/moshangsang24/llm-log/actions/workflows/ci.yml/badge.svg)](https://github.com/moshangsang24/llm-log/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/llm-log-system)](https://github.com/moshangsang24/llm-log/blob/main/LICENSE)
+
+面向 Python、LangChain 与 LangGraph 的低侵入大语言模型调用日志与链路追踪 SDK，配合自托管的 [LLM Log System](https://github.com/moshangsang24/llm-log) 服务端使用。
+
+> 当前版本为 `0.1.0rc1` 候选版本，建议先用于评估、集成测试和预发布环境。
+
+## 功能
+
+- 手动创建 Trace、LLM Span 和自定义 Span；
+- 自动采集 LangChain chain、LLM、chat model、tool 与 retriever；
+- 关联 LangGraph 根图、节点、并行分支和子图；
+- 支持同步、异步、流式、异常和取消调用；
+- 客户端递归脱敏、正文开关和 UTF-8 字节截断；
+- 有界内存队列、后台批量、短超时、有限重试和 gzip；
+- 上报故障默认不影响模型调用和业务异常语义；
+- 提供无敏感信息的本地诊断计数。
+
+## 安装
+
+安装当前候选版本：
+
+```bash
+python -m pip install --pre llm-log-system
+```
+
+也可以固定版本：
+
+```bash
+python -m pip install "llm-log-system==0.1.0rc1"
+```
+
+按使用的框架安装可选依赖：
+
+```bash
+python -m pip install "llm-log-system[langchain]==0.1.0rc1"
+python -m pip install "llm-log-system[langgraph]==0.1.0rc1"
+python -m pip install "llm-log-system[integrations]==0.1.0rc1"
+```
+
+手动采集只依赖 `httpx` 和 `pydantic`，不需要安装 LangChain 或 LangGraph。
+
+## 快速开始
+
+先在 Web 控制台创建应用和 API Key，然后配置采集端：
+
+```bash
+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`。
+
+### 手动采集
+
+```python
+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()
+```
+
+上下文管理器会自动记录开始时间、结束时间、耗时、成功状态和业务异常。需要显式等待后台队列时使用：
+
+```python
+client.flush(timeout=5)
+```
+
+### LangChain
+
+```python
+from llm_log_system import LLMLogClient
+
+client = LLMLogClient()
+callback = client.langchain_callback()
+
+result = runnable.invoke(
+    {"question": "什么是链路追踪？"},
+    config={"callbacks": [callback]},
+)
+
+client.close()
+```
+
+### LangGraph
+
+```python
+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_MAX_FIELD_BYTES` | `65536`       | 单字段最大 UTF-8 字节数   |
+| `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 诊断信息只保留在本地，不会再次上传到采集服务：
+
+```python
+diagnostics = client.get_diagnostics()
+
+print(diagnostics.queued)
+print(diagnostics.sent)
+print(diagnostics.retried)
+print(diagnostics.failed)
+print(diagnostics.dropped)
+```
+
+## 兼容性
+
+- Python 3.10～3.13；
+- `langchain-core>=0.3.27,<2`；
+- `langgraph>=0.2.60,<2`；
+- 未安装框架可选依赖时，核心 SDK 仍可导入和使用。
+
+最低与最新已验证组合见[框架兼容矩阵](https://github.com/moshangsang24/llm-log/blob/main/docs/architecture/%E6%A1%86%E6%9E%B6%E5%85%BC%E5%AE%B9%E7%9F%A9%E9%98%B5.md)。
+
+## 文档与示例
+
+- [项目文档](https://github.com/moshangsang24/llm-log#readme)
+- [手动采集示例](https://github.com/moshangsang24/llm-log/tree/main/examples/requests_manual)
+- [LangChain 示例](https://github.com/moshangsang24/llm-log/tree/main/examples/langchain_basic)
+- [LangGraph 示例](https://github.com/moshangsang24/llm-log/tree/main/examples/langgraph_basic)
+- [Span 上报协议](https://github.com/moshangsang24/llm-log/blob/main/docs/api/%E5%8D%8F%E8%AE%AEv1.0.md)
+- [变更记录](https://github.com/moshangsang24/llm-log/blob/main/CHANGELOG.md)
+- [问题反馈](https://github.com/moshangsang24/llm-log/issues)
+
+## 开发
+
+从源码安装 SDK：
+
+```bash
+git clone https://github.com/moshangsang24/llm-log.git
+cd llm-log
+make setup
+make test-sdk
+```
+
+提交变更前请阅读[仓库协作指南](https://github.com/moshangsang24/llm-log/blob/main/AGENTS.md)。
+
+## 许可证
+
+本 SDK 基于 [Apache License 2.0](https://github.com/moshangsang24/llm-log/blob/main/LICENSE) 发布，并遵守项目的 [NOTICE](https://github.com/moshangsang24/llm-log/blob/main/NOTICE) 声明。

llm_log_system-0.1.0rc1/README.md

@@ -0,0 +1,199 @@
+# llm-log-system
+
+[![PyPI](https://img.shields.io/pypi/v/llm-log-system?include_prereleases)](https://pypi.org/project/llm-log-system/)
+[![Python](https://img.shields.io/pypi/pyversions/llm-log-system)](https://pypi.org/project/llm-log-system/)
+[![CI](https://github.com/moshangsang24/llm-log/actions/workflows/ci.yml/badge.svg)](https://github.com/moshangsang24/llm-log/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/llm-log-system)](https://github.com/moshangsang24/llm-log/blob/main/LICENSE)
+
+面向 Python、LangChain 与 LangGraph 的低侵入大语言模型调用日志与链路追踪 SDK，配合自托管的 [LLM Log System](https://github.com/moshangsang24/llm-log) 服务端使用。
+
+> 当前版本为 `0.1.0rc1` 候选版本，建议先用于评估、集成测试和预发布环境。
+
+## 功能
+
+- 手动创建 Trace、LLM Span 和自定义 Span；
+- 自动采集 LangChain chain、LLM、chat model、tool 与 retriever；
+- 关联 LangGraph 根图、节点、并行分支和子图；
+- 支持同步、异步、流式、异常和取消调用；
+- 客户端递归脱敏、正文开关和 UTF-8 字节截断；
+- 有界内存队列、后台批量、短超时、有限重试和 gzip；
+- 上报故障默认不影响模型调用和业务异常语义；
+- 提供无敏感信息的本地诊断计数。
+
+## 安装
+
+安装当前候选版本：
+
+```bash
+python -m pip install --pre llm-log-system
+```
+
+也可以固定版本：
+
+```bash
+python -m pip install "llm-log-system==0.1.0rc1"
+```
+
+按使用的框架安装可选依赖：
+
+```bash
+python -m pip install "llm-log-system[langchain]==0.1.0rc1"
+python -m pip install "llm-log-system[langgraph]==0.1.0rc1"
+python -m pip install "llm-log-system[integrations]==0.1.0rc1"
+```
+
+手动采集只依赖 `httpx` 和 `pydantic`，不需要安装 LangChain 或 LangGraph。
+
+## 快速开始
+
+先在 Web 控制台创建应用和 API Key，然后配置采集端：
+
+```bash
+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`。
+
+### 手动采集
+
+```python
+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()
+```
+
+上下文管理器会自动记录开始时间、结束时间、耗时、成功状态和业务异常。需要显式等待后台队列时使用：
+
+```python
+client.flush(timeout=5)
+```
+
+### LangChain
+
+```python
+from llm_log_system import LLMLogClient
+
+client = LLMLogClient()
+callback = client.langchain_callback()
+
+result = runnable.invoke(
+    {"question": "什么是链路追踪？"},
+    config={"callbacks": [callback]},
+)
+
+client.close()
+```
+
+### LangGraph
+
+```python
+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_MAX_FIELD_BYTES` | `65536`       | 单字段最大 UTF-8 字节数   |
+| `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 诊断信息只保留在本地，不会再次上传到采集服务：
+
+```python
+diagnostics = client.get_diagnostics()
+
+print(diagnostics.queued)
+print(diagnostics.sent)
+print(diagnostics.retried)
+print(diagnostics.failed)
+print(diagnostics.dropped)
+```
+
+## 兼容性
+
+- Python 3.10～3.13；
+- `langchain-core>=0.3.27,<2`；
+- `langgraph>=0.2.60,<2`；
+- 未安装框架可选依赖时，核心 SDK 仍可导入和使用。
+
+最低与最新已验证组合见[框架兼容矩阵](https://github.com/moshangsang24/llm-log/blob/main/docs/architecture/%E6%A1%86%E6%9E%B6%E5%85%BC%E5%AE%B9%E7%9F%A9%E9%98%B5.md)。
+
+## 文档与示例
+
+- [项目文档](https://github.com/moshangsang24/llm-log#readme)
+- [手动采集示例](https://github.com/moshangsang24/llm-log/tree/main/examples/requests_manual)
+- [LangChain 示例](https://github.com/moshangsang24/llm-log/tree/main/examples/langchain_basic)
+- [LangGraph 示例](https://github.com/moshangsang24/llm-log/tree/main/examples/langgraph_basic)
+- [Span 上报协议](https://github.com/moshangsang24/llm-log/blob/main/docs/api/%E5%8D%8F%E8%AE%AEv1.0.md)
+- [变更记录](https://github.com/moshangsang24/llm-log/blob/main/CHANGELOG.md)
+- [问题反馈](https://github.com/moshangsang24/llm-log/issues)
+
+## 开发
+
+从源码安装 SDK：
+
+```bash
+git clone https://github.com/moshangsang24/llm-log.git
+cd llm-log
+make setup
+make test-sdk
+```
+
+提交变更前请阅读[仓库协作指南](https://github.com/moshangsang24/llm-log/blob/main/AGENTS.md)。
+
+## 许可证
+
+本 SDK 基于 [Apache License 2.0](https://github.com/moshangsang24/llm-log/blob/main/LICENSE) 发布，并遵守项目的 [NOTICE](https://github.com/moshangsang24/llm-log/blob/main/NOTICE) 声明。