Salt 分布式追踪:用 OpenTelemetry 跟随一项作业

Salt 可以为每次跨进程传递产生 OpenTelemetry span(跨度)。因此,salt '*' test.ping 这样的一项作业能形成一条分布式 trace,贯穿 CLI、master、minion、返回路径,以及中途可能出现的 reactor 或 syndic 转发。

实现使用标准 W3C TraceContext(traceparent / tracestate)传播上下文,通过 OTLP exporter 导出跨度。Jaeger 原生接收 OTLP;Tempo、Honeycomb、Datadog OTLP 等现代追踪后端也支持这种方式。

追踪上下文在 Salt 的 AES 加密消息封装内传播。线路上的攻击者无法看到追踪头;经过身份验证的 master、minion 和 syndic 在 AES 解密后读取它们。追踪默认关闭,未配置时完全不执行追踪工作:不创建跨度,不初始化 exporter,也不启动后台线程。

配置

在 master 和 minion 配置中添加 tracing 块。两个守护进程使用相同的配置块;它也适用于 salt-cli、salt-call、salt-api 和 salt-ssh。

tracing:
  enabled: true
  exporter: otlp-http            # otlp-http | otlp-grpc | console
  endpoint: ""                   # OTel SDK default endpoint when empty
  service_name: ""               # auto-derived when empty
  sampler: parent_based          # parent_based | always_on | always_off | trace_id_ratio
  sampler_arg: 1.0
  resource_attributes: {}
  insecure: true                 # gRPC TLS disabled (ignored for HTTP)
  headers: {}                    # OTLP authentication headers
enabled
总开关。为 false(默认值)时,模块中的所有追踪操作都是空操作。
exporter
otlp-http 是默认方式,以 HTTP/protobuf 将跨度发送到 endpoint。它是纯 Python 实现,包含在 Salt 基础依赖中;原文称其可用于所有解释器。otlp-grpc 使用 gRPC,需要另外安装 opentelemetry-exporter-otlp-proto-grpc。该包引入 grpcio,某些平台与解释器组合没有其预编译 wheel。console 将跨度打印到标准输出,用于调试。
endpoint
OTLP 收集器 URL。为空时使用 OTel SDK 默认端点:HTTP 为 http://localhost:4318/v1/traces,gRPC 为 http://localhost:4317。
service_name
资源属性 service.name。为空时 Salt 自动填入 salt-master、salt-minion-<id>、salt-cli、salt-call 或 salt-api。
sampler
选择安装在 TracerProvider 上的采样器:

  • parent_based(默认)遵循父跨度的采样决定,并对根跨度采样;将 sampler_arg 设为小于 1.0 的值,可以对根跨度按比例采样。
  • always_on 对每个跨度采样。
  • always_off 丢弃所有跨度,仅用于测试。
  • trace_id_ratio 对 sampler_arg 比例的 trace ID 采样。
resource_attributes
合并到 OTel Resource 的额外属性,例如 deployment.environment: prod。
insecure
关闭到收集器的 gRPC TLS。HTTP exporter 忽略这一设置。
headers
附加到每个 OTLP 请求的头,例如托管收集器使用的 Authorization: Bearer <token>。这是占位示例,不包含真实认证值。

覆盖的传递环节

一项 salt '*' test.ping 作业至少产生以下跨度:

  1. salt.cli.test.ping:CLI 上的根跨度。
  2. salt.req.send.publish:CLI → master 请求。
  3. salt.req.recv.publish:master 收到请求。
  4. salt.pub.send:master 发布作业。
  5. salt.minion.recv.test.ping:minion 收到已发布的命令。
  6. salt.minion.exec.test.ping:minion 执行函数。
  7. salt.req.send._return:minion 向 master 返回。
  8. salt.req.recv._return:master 收到返回。

此外,以下环节也设有追踪:

  • 事件总线(fire_event / get_event):每个 IPC 和 TCP-IPC 事件的数据字典携带追踪上下文。
  • Reactor:从传入事件提取上下文,正确设置反应跨度的父跨度。
  • Syndic 转发:既包括来自上游 master 的入站转发,也包括到下游 minion 的出站转发。
  • Salt-SSH:在远程 shim 上通过 TRACEPARENT 环境变量传递上下文。
  • Salt-API:从传入请求提取 traceparent HTTP 头;webhook 将上下文注入它触发的事件。

快速演示

启动一个 all-in-one Jaeger:

docker run -d --name jaeger \
  -p 16686:16686 -p 4318:4318 \
  jaegertracing/all-in-one:latest

给 master 与 minion 配置:

tracing:
  enabled: true
  exporter: otlp-http
  endpoint: http://localhost:4318/v1/traces
  sampler: always_on

启动二者,运行 salt '*' test.ping,访问 http://localhost:16686,搜索 salt-cli 服务。按照原文的演示预期,会看到一条追踪,其跨度分属 salt-cli、salt-master 和 salt-minion-<id> 三类服务。

fork 处理

OTel 的 BatchSpanProcessor 使用一个后台线程,该线程无法在 fork() 后继续工作。Salt 会在每个派生子进程第一次调用追踪 API 时重建 provider,因此 master 或 minion 启动的工作进程拥有可工作的 exporter,调用方不必额外处理。

fork 瞬间仍在父进程队列中且未刷出的跨度可能丢失。对于短生命周期跨度,这通常不明显;如果观察到缺口,可考虑使用 OTel 环境变量缩短 BatchSpanProcessor 队列相关时间间隔。

载荷开销

追踪启用且有正在记录的跨度时,每个 Salt 请求和事件大约增加 60 字节,即 W3C traceparent 字符串。没有正在记录的跨度时,例如请求处理器之外触发的内部周期事件,不附加追踪头。

演示边界

以上容器端口、明文 HTTP 端点与 always_on 是原文演示配置;应在获准的隔离环境中使用。远程 minion 的 localhost 指向该 minion 自身,需要按实际拓扑配置可达的收集器地址。本文没有运行 Salt、Docker 或收集器,也没有将原文的约 60 字节说明当作实测结果。

来源:Salt Project 贡献者,Distributed Tracing (OpenTelemetry)。本页中文化并补充演示边界;原配置与命令保持原样。原项目文件许可:Apache License 2.0。Copyright (c) 2011-2022 VMware, Inc. All rights reserved;Copyright 2014 SaltStack Team;页面 © 2026。以下保留 Apache 2.0 许可全文。

Apache License 2.0
                                 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.
© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容