入门指南 • API 文档 • 联系我们 (GitHub Discussions)

<img alt="Beta" src="https://img.shields.io/badge/status-beta-informational?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAACQAAAAAQAAAJAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAA8A2UOAAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABK5JREFUSA2dVm1sFEUYfmd2b/f2Pkqghn5eEQWKrRgjpkYgpoRCLC0oxV5apAiGUDEpJvwxEQ2raWPU+Kf8INU/RtEedwTCR9tYPloxGNJYTTQUwYqJ1aNpaLH3sXu3t7vjvFevpSqt7eSyM+/czvM8877PzB3APBoLgoDLsNePF56LBwqa07EKlDGg84CcWsI4CEbhNnDpAd951lXE2NkiNknCCTLv4HtzZuvPm1C/IKv4oDNXqNDHragety2XVzjECZsJARuBMyRzJrh1O0gQwLXuxofxsPSj4hG8fMLQo7bl9JJD8XZfC1E5yWFOMtd07dvX5kDwg6+2++Chq8txHGtfPoAp0gOFmhYoNFkHjn2TNUmrwRdna7W1QSkU8hvbGk4uThLrapaiLA2E6QY4u/lS9ItHfvJkxYsTMVtnAJLipYIWtVrcdX+8+b8IVnPl/R81prbuPZ1jpYw+0aEUGSkdFsgyBIaFTXCm6nyaxMtJ4n+TeDhJzGqZtQZcuYDgqDwDbqb0JF9oRpIG1Oea3bC1Y6N3x/WV8Zh83emhCs++hlaghDw+8w5UlYKq2lU7Pl8IkvS9KDqXmKmEwdMppVPKwGSEilmyAwJhRwWcq7wYC6z4wZ1rrEo

MWxecdOjZWXeAQClBcYDN3NwVwD9pGwqUSyQgclcmxpNJqCuwLmDh3WtvPqXdlt+6Oz70HPGDNSNBee/EOen+rGbEFqDENBPDbtdCp0ukPANmzO0QQJYUpyS5IJJI3Hqt4maS+EB3199ozm8EDU/6fVNU2dQpdx3ZnKzeFXyaUTiasEV/gZMzJMjr3Z+WvAdQ+hs/zw9savimxUntDSaBdZ2f+Idbm1rlNY8esFffBit9HtK5/MejsrJVxikOXlb1Ukir2X+Rbdkd1KG2Ixfn2Ql4JRmELnYK9mEM8G36fAA3xEQ89fxXihC8q+sAKi9jhHxNqagY2hiaYgRCm0f0QP7H4Fp11LSXiuBY2aYFlh0DeDIVVFUJQn5rCnpiNI2gvLxHnASn9DIVHJJlm5rXvQAGEo4zvKq2w5G1NxENN7jrft1oxMdekETjxdH2Z3x+VTVYsPb+O0C/9/auN6v2hNZw5b2UOmSbG5/rkC3LBA+1PdxFxORjxpQ81GcxKc+ybVjEBvUJvaGJ7p7n5A5KSwe4AzkasA+crmzFtowoIVTiLjANm8GDsrWW35ScI3JY8Urv83tnkF8JR0yLvEt2hO/0qNyy3Jb3YKeHeHeLeOuVLRpNF+pkf85OW7/zJxWdXsbsKBUk2TC0BCPwMq5Q/CPvaJFkNS/1l1qUPe+uH3oD59erYGI/Y4sce6KaXYElAIOLt+0O3t2+/xJDF1XvOlWGC1W1B8VMszbGfOvT5qaRRAIFK3BCO164nZ0uYLH2YjNN8thXS2v2BK9gTfD7jHVxzHr4roOlEvYYz9QIz+Vl/sLDXInsctFsXjqIRnO2ZO387lxmIboLDZCJ59KLFliNIgh9ipt6tLg9SihpRPDO1ia5byw7de1aCQmF5geOQtK509rzfdwxaKOIq+73AvwCC5/5fcV4vo3+3LpMdtWHh0ywsJC/ZGoCb8/9D8F/ifgLLl8S8QWfU8cAAAAASUVORK5CYII=">

OpenTelemetry Python Contrib

OpenTelemetry 的 Python 自动插桩库（依据 OTEP 0001）

安装

本仓库包含针对每个被插桩库的可安装包。产生遥测数据的库应仅依赖 opentelemetry-api，并将 SDK 的选择权留给应用程序开发者。应用程序可以依赖 opentelemetry-sdk 或另一个实现了 API 的包。

请注意，这些库目前处于 beta 阶段，通常不应在生产环境中使用。

除非另有明确说明，此处针对特定库的任何插桩均非由该库的作者开发或维护。

instrumentation/ 目录包含 OpenTelemetry 插桩包，可以单独安装为：

pip install opentelemetry-instrumentation-{integration}

若要改为安装这些包的开发版本，请克隆或 fork 此仓库，并执行可编辑安装：

pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}

发布

维护者每月在 opentelemetry-python-contrib 中发布软件包的新版本。有关所有先前版本的发布信息，请参阅 releases。

欢迎将增强 Python 版 OTel 的贡献托管到上游，以利于团队协作。在决定发布带有 1.0 发布所隐含的稳定保证的软件包时，维护者会考虑诸如良好的文档、良好的单元测试以及他们自身的信心等因素。

为解决此问题，鼓励社区成员承诺成为 -contrib 中他们认为自己足够有经验以进行维护的软件包的 CODEOWNER。CODEOWNERS 随后可以按照以下清单将 -contrib 软件包发布为 1.0 稳定版：

将软件包发布为 `1.0` 稳定版

要将软件包发布为 1.0 稳定版，该软件包必须：

SHOULD 拥有一位 CODEOWNER。要成为 CODEOWNER，请提交一个 issue 并解释为何你符合 CODEOWNERS 中列出的职责要求。
MUST 拥有单元测试，以覆盖被插桩库的所有受支持版本。
- 例如，插桩包可能会使用不同的技术来插桩不同主版本的 python 包
MUST 为包的非显而易见的用法提供清晰的文档
- 例如，如果某个插桩包使用了标志、作为上下文的令牌，或 BaseInstrumentor 类中不典型的参数，这些都需要在文档中说明
在 1.0 发布之后，CODEOWNER 可能不再觉得自己有精力履行维护该包的职责。这完全没问题，生活总有意外！但如果是这种情况，我们请求 CODEOWNER 提交一个 issue，表明他们希望被移除 CODEOWNER 身份，以免在未来的 PR 中被 @ 提及。最终，我们希望利用该 issue 来寻找新的 CODEOWNER。

插桩的语义约定状态

为了保持最佳用户体验并防止在过渡到稳定的语义约定时出现破坏性变更，OpenTelemetry Python 正在为多个 instrumentation 采用语义约定迁移计划。目前，该计划仅适用于 HTTP 相关的 instrumentation，但最终将涵盖所有类型。请参阅 instrumentation README 中的 semconv status 列，以了解当前 instrumentation 语义约定的状态。可能的值为 development、stable 和 migration，分别对应该特定语义约定的状态。Migration 指代当前支持迁移计划的 instrumentation。