完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

OpenTelemetry 设置

OpenTelemetry 设置相关操作

获取 OpenTelemetry 配置

获取当前 OpenTelemetry 配置，包括界面中提供的所有字段。需要 `otel:manage` 作用域。

GET/settings/otel

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
enabled	boolean	是	是否启用 OpenTelemetry 跟踪。
exporterProtocol	string	是	用于导出跟踪片段（span）的传输协议。收集器通常在端口 4318 提供 OTLP/HTTP，在端口 4317 提供 OTLP/gRPC。两种协议都由端点的 URL 协议（http:// 或 https://）控制 TLS。此字段可选：写入时省略会选择 http/protobuf，但实例通过环境变量将此字段设为其他值时，会以 409 拒绝该写入。 可选值：http/protobuf, grpc 默认值："http/protobuf"
exporterEndpoint	string	是	用于接收跟踪数据的 OTLP 收集器基础 URL。必须使用 http:// 或 https:// URL，由 URL 协议决定是否使用 TLS：对于 gRPC，https:// 使用 SSL，http:// 使用明文。
exporterTracingPath	string	是	追加到端点上的 OTLP 跟踪信号路径。exporterProtocol 为 grpc 时忽略，因为 gRPC 不使用 URL 路径。
exporterServiceName	string	是	每个 span 上报告的 service.name 资源属性。
exporterHeaders	string	是	发送到 OTLP 收集器的附加请求头，使用单个字符串表示，以逗号分隔各个 key=value，例如 authorization=Bearer my-token,x-tenant-id=acme。每个键和值两端的空白会被移除；值可以包含空格，但不能包含逗号。未使用时填写空字符串。
tracesSampleRate	number	是	跟踪采样比例，范围为 0（不采样）到 1（全部采样）。
startupConnectivityTimeoutMs	integer	是	检查收集器是否可访问时的等待时间，单位为毫秒；也用作发送测试跟踪端点的超时时长。
includeNodeSpans	boolean	是	除工作流 span 外，是否还为每次节点执行生成 span。
emitWorkflowStartSpan	boolean	是	每次执行或恢复运行的片段开始时，是否生成持续时间为 0 ms 的 workflow.execute.started span。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。
emitNodeStartSpan	boolean	是	每个节点 span 开始时，是否生成持续时间为 0 ms 的 node.execute.started span。这会使节点 span 数量加倍。includeNodeSpans 为 false 时无效。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。
injectOutbound	boolean	是	是否向节点发出的 HTTP 请求注入跟踪上下文请求头。
productionExecutionsOnly	boolean	是	为 true 时，仅跟踪已发布（激活）工作流的生产执行，不跟踪手动或测试运行。

下载完整 OpenAPI 定义（JSON）

设置 OpenTelemetry 配置

设置 OpenTelemetry 配置。此操作为完整替换，必须提供所有字段；只包含部分字段的请求体会被拒绝。例外包括：`exporterProtocol` 省略时默认为 `http/protobuf`，`emitWorkflowStartSpan` 和 `emitNodeStartSpan` 省略时默认为 `false`。更新使用与界面相同的校验，并以相同方式立即应用到运行中的实例。通过环境变量以声明方式管理的字段为只读：尝试更改会以 409 拒绝，重新提交 GET 返回的当前值则会被接受。需要 `otel:manage` 作用域。

PUT/settings/otel

请求体

application/json

字段	类型	必填	说明
enabled	boolean	是	是否启用 OpenTelemetry 跟踪。
exporterProtocol	string	否	用于导出跟踪片段（span）的传输协议。收集器通常在端口 4318 提供 OTLP/HTTP，在端口 4317 提供 OTLP/gRPC。两种协议都由端点的 URL 协议（http:// 或 https://）控制 TLS。此字段可选：写入时省略会选择 http/protobuf，但实例通过环境变量将此字段设为其他值时，会以 409 拒绝该写入。 可选值：http/protobuf, grpc 默认值："http/protobuf"
exporterEndpoint	string	是	用于接收跟踪数据的 OTLP 收集器基础 URL。必须使用 http:// 或 https:// URL，由 URL 协议决定是否使用 TLS：对于 gRPC，https:// 使用 SSL，http:// 使用明文。
exporterTracingPath	string	是	追加到端点上的 OTLP 跟踪信号路径。exporterProtocol 为 grpc 时忽略，因为 gRPC 不使用 URL 路径。
exporterServiceName	string	是	每个 span 上报告的 service.name 资源属性。
exporterHeaders	string	是	发送到 OTLP 收集器的附加请求头，使用单个字符串表示，以逗号分隔各个 key=value，例如 authorization=Bearer my-token,x-tenant-id=acme。每个键和值两端的空白会被移除；值可以包含空格，但不能包含逗号。未使用时填写空字符串。
tracesSampleRate	number	是	跟踪采样比例，范围为 0（不采样）到 1（全部采样）。
startupConnectivityTimeoutMs	integer	是	检查收集器是否可访问时的等待时间，单位为毫秒；也用作发送测试跟踪端点的超时时长。
includeNodeSpans	boolean	是	除工作流 span 外，是否还为每次节点执行生成 span。
emitWorkflowStartSpan	boolean	否	每次执行或恢复运行的片段开始时，是否生成持续时间为 0 ms 的 workflow.execute.started span。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。 默认值：false
emitNodeStartSpan	boolean	否	每个节点 span 开始时，是否生成持续时间为 0 ms 的 node.execute.started span。这会使节点 span 数量加倍。includeNodeSpans 为 false 时无效。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。 默认值：false
injectOutbound	boolean	是	是否向节点发出的 HTTP 请求注入跟踪上下文请求头。
productionExecutionsOnly	boolean	是	为 true 时，仅跟踪已发布（激活）工作流的生产执行，不跟踪手动或测试运行。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	冲突
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
enabled	boolean	是	是否启用 OpenTelemetry 跟踪。
exporterProtocol	string	是	用于导出跟踪片段（span）的传输协议。收集器通常在端口 4318 提供 OTLP/HTTP，在端口 4317 提供 OTLP/gRPC。两种协议都由端点的 URL 协议（http:// 或 https://）控制 TLS。此字段可选：写入时省略会选择 http/protobuf，但实例通过环境变量将此字段设为其他值时，会以 409 拒绝该写入。 可选值：http/protobuf, grpc 默认值："http/protobuf"
exporterEndpoint	string	是	用于接收跟踪数据的 OTLP 收集器基础 URL。必须使用 http:// 或 https:// URL，由 URL 协议决定是否使用 TLS：对于 gRPC，https:// 使用 SSL，http:// 使用明文。
exporterTracingPath	string	是	追加到端点上的 OTLP 跟踪信号路径。exporterProtocol 为 grpc 时忽略，因为 gRPC 不使用 URL 路径。
exporterServiceName	string	是	每个 span 上报告的 service.name 资源属性。
exporterHeaders	string	是	发送到 OTLP 收集器的附加请求头，使用单个字符串表示，以逗号分隔各个 key=value，例如 authorization=Bearer my-token,x-tenant-id=acme。每个键和值两端的空白会被移除；值可以包含空格，但不能包含逗号。未使用时填写空字符串。
tracesSampleRate	number	是	跟踪采样比例，范围为 0（不采样）到 1（全部采样）。
startupConnectivityTimeoutMs	integer	是	检查收集器是否可访问时的等待时间，单位为毫秒；也用作发送测试跟踪端点的超时时长。
includeNodeSpans	boolean	是	除工作流 span 外，是否还为每次节点执行生成 span。
emitWorkflowStartSpan	boolean	是	每次执行或恢复运行的片段开始时，是否生成持续时间为 0 ms 的 workflow.execute.started span。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。
emitNodeStartSpan	boolean	是	每个节点 span 开始时，是否生成持续时间为 0 ms 的 node.execute.started span。这会使节点 span 数量加倍。includeNodeSpans 为 false 时无效。此字段可选：写入时省略会选择 false，但实例通过环境变量将此字段设为 true 时，会以 409 拒绝该写入。
injectOutbound	boolean	是	是否向节点发出的 HTTP 请求注入跟踪上下文请求头。
productionExecutionsOnly	boolean	是	为 true 时，仅跟踪已发布（激活）工作流的生产执行，不跟踪手动或测试运行。

下载完整 OpenAPI 定义（JSON）

测试与 OTLP 收集器的连接

向指定的 OTLP 收集器发送单个测试 span，并报告其是否被接受。此操作仅测试提供的连接详情，不更改已存储配置。发送测试之前，通过环境变量以声明方式管理的字段，会被其实际生效值覆盖。需要 `otel:manage` 作用域。

POST/settings/otel/test-trace

请求体

application/json

字段	类型	必填	说明
exporterProtocol	string	否	发送测试 span 所用的传输协议。收集器通常在端口 4318 提供 OTLP/HTTP，在端口 4317 提供 OTLP/gRPC。两种协议都由端点的 URL 协议（http:// 或 https://）控制 TLS。此字段可选：省略时选择 http/protobuf，但若由环境变量管理，则使用环境变量提供的值。 可选值：http/protobuf, grpc 默认值："http/protobuf"
exporterEndpoint	string	是	用于接收跟踪数据的 OTLP 收集器基础 URL。必须使用 http:// 或 https:// URL，由 URL 协议决定是否使用 TLS：对于 gRPC，https:// 使用 SSL，http:// 使用明文。
exporterTracingPath	string	是	追加到端点上的 OTLP 跟踪信号路径。exporterProtocol 为 grpc 时忽略，因为 gRPC 不使用 URL 路径。
exporterServiceName	string	是	测试 span 上报告的 service.name 资源属性。
exporterHeaders	string	是	发送到 OTLP 收集器的附加请求头，使用单个字符串表示，以逗号分隔各个 key=value，例如 authorization=Bearer my-token,x-tenant-id=acme。每个键和值两端的空白会被移除；值可以包含空格，但不能包含逗号。未使用时填写空字符串。
startupConnectivityTimeoutMs	integer	是	等待收集器响应的时间，单位为毫秒。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
success	boolean	是	收集器是否接受了测试 span。
error	string	否	收集器或导出器报告的错误，仅当 success 为 false 时返回。

下载完整 OpenAPI 定义（JSON）