PyCharm 2025.3 Help

OpenTelemetry 跟踪与指标

OpenTelemetry 是一组 API、SDK 与工具,旨在帮助您创建能够轻松导出跟踪、指标与日志的应用程序。 OpenTelemetry API 提供了一套统一的 API,用于分布式跟踪与指标埋点,能够自动收集数据并将其发送到您选择的后端。

在 PyCharm 中实现的 OpenTelemetry 统计信息包括跟踪与指标。 Tracer 会创建表示活动的 Span。 指标包括计数器与仪表。 有关更多信息,请参阅 OpenTelemetry 文档

您可以使用 idea.properties 文件启用 OpenTelemetry。

  1. 在 IDE 中,从主菜单选择 帮助 | 编辑自定义属性

  2. 在打开的文件中,添加以下代码:

    idea.diagnostic.opentelemetry.otlp=true

Span

一个 Span 表示一次跟踪中的单个操作。 Span 可以发送到端点,并在 Jaeger UI 中可视化。 可以在 Docker 中启动 Jaeger。 您可以按照链接中的说明了解如何 设置 Jaeger UI

设置 Span

  1. 启动包含 Jaeger 的 Docker 容器。

    使用以下 二进制文件 下载 Jaeger。

    要启动 Jaeger 容器,请在终端中运行以下代码:

    docker run -d --name jaeger \ -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \ -e COLLECTOR_OTLP_ENABLED=true \ -p 6831:6831/udp \ -p 6832:6832/udp \ -p 5778:5778 \ -p 16686:16686 \ -p 4317:4317 \ -p 4318:4318 \ -p 14250:14250 \ -p 14268:14268 \ -p 14269:14269 \ -p 9411:9411 \ jaegertracing/all-in-one:1.38
  2. 转到 localhost:16686 以在 Jaeger UI 中查看 Span。

    可以通过以下属性定义跟踪端点:

    idea.diagnostic.opentelemetry.otlp

    如果该标志为 true,其值将设置为默认值:http://127.0.0.1:4318/

OpenTelemetry 指标

OpenTelemetry 指标存储在日志目录中。 有关其准确位置,请参阅 文档

open-telemetry-metrics.csv

可以使用 idea.diagnostic.opentelemetry.metrics.file 定义指标上报路径。

open-telemetry-connection-metrics.gz

此文件自 PyCharm 版本 2023.2 起可用。

open-telemetry-lux-metrics.gz

远程开发 OpenTelemetry Span 与指标的标志

rdct.diagnostic.otlp

这仅在后端启用。

后端 Span 在后端累积,然后发送到前端。 所有 Span(包括后端和前端的)均由前端发送到定义的端点。

rdct.connection.metrics.enabled

这需要在前端与后端同时启用。

此功能自 PyCharm 版本 2023.2 起可用。

lux.metrics.enabled

远程开发指标

这些指标以每秒一次的频率记录。

包括以下内容:

  • rdct.FramedByteChannel.sentFrames.projectName :通过 TLS 发送的帧数(在后端与前端)

  • rdct.CountingByteChannel.readBytesRate.projectName :通过 TLS 接收的字节数(在后端与前端)

  • rdct.CountingByteChannel.writeBytesRate.projectName :通过 TLS 发送的字节数(在后端与前端)

  • rdct.FramedByteChannel.receivedFrames.projectName :通过 TLS 接收的帧数(在后端与前端)

  • rdct.ThinClientRdPortServerSocketWrapper.sentBytes.projectName :在瘦前端进程中,来自用户应用程序(例如浏览器)通过端口转发通道发送的字节数

  • rdct.ThinClientRdPortServerSocketWrapper.receivedBytes.projectName :在瘦前端进程中,通过端口转发通道从用户应用程序(例如浏览器)接收的字节数

FramedByteChannel 是前端与后端之间基于 TLS 的字节消息通道。 字节会累积到帧中,并通过该通道发送或接收。

  • rdct.FramedByteChannel.receivedFramesLenRate.projectName :通过 TLS 接收的帧长度(在后端与前端)

  • rdct.FramedByteChannel.sentFramesLenRate.projectName :通过 TLS 发送的帧长度(在后端与前端)

  • rdct.TransportWrapperImpl.connectionState.projectName :连接状态的序数:0 -> "NOT_CONNECTED",1 -> "CONNECTED",2 -> "CLOSED",3 -> "DECLINED",4 -> "FAULTED"(在后端与前端)

  • rdct.ThinClientDiagnosticsService.pingDirect :瘦客户端 ping 值(在前端)

  • rdct.ThinClientDiagnosticsService.pingUI :前端 UI 线程 ping 值(在前端)

ThinClientDiagnosticsService 是一个按项目的前端侧诊断服务,用于收集前端与后端的连接信息。 Ping 指标是由后端进程处理的协议请求。 pingDirect 在后台线程中处理,pingUI - 在 EDT 中。 如果没有任何一次 Ping,我们认为要么网络存在问题(通道可能被某些数据堵塞),要么我们的进程已冻结。 如果存在 pingDirect ,但不存在 pingUI ,则我们认为后端的 UI 发生挂起。 在未能快速收到来自后端的响应时,会为 ping 属性设置 -1 值。 rdct.ThinClientDiagnosticsService.connectionState :前端连接状态的序数:0 -> WireNotConnected,1 -> NoPings,2 -> NoUiThreadPing,3 -> Connected(在前端)

报告连接问题

如果遇到连接问题,请使用以下工作流程收集数据,以便进一步调查问题:

收集数据

  1. 在 IDE 中,从主菜单选择 帮助 | 编辑自定义属性

  2. 将以下属性添加到 idea.properties 文件中:

    rdct.connection.metrics.enabled

    您需要在后端与前端同时启用此属性。

    连接指标将以每秒一次的频率上报。

  3. 复现连接问题后,收集在前端与后端写入的 日志目录 中生成的指标文件。 这些文件将具有 *.gz 粒度,文件名如下所示:

    open-telemetry-connection-metrics.2023-03-29-15-48-40.gz
  4. 将日志目录中的所有指标文件打包成归档,并将其附加到相应 YouTrack 项目中创建的问题中。

最后修改日期: 2025年 12月 2日