OpenTelemetry 日志记录配置

ThingWorx 可观测性 > ThingWorx Platform 中的 OpenTelemetry 日志记录支持 > OpenTelemetry 日志记录配置

platform-settings.json 文件的 BasicSettings 部分提供了以下 OpenTelemetry 配置设置。

设置	类型	默认值	说明
EnableOpenTelemetryForLogging	BOOLEAN	false	将该值设置为 true 可启用 OpenTelemetry Collector。启动 ThingWorx Platform 服务器时，OpenTelemetry Collector 会与 ThingWorx Platform 服务器建立连接。
DisableFileLogging	BOOLEAN	false	将此值设置为 true 时： • 日志不会写入 /ThingworxStorage/logs 文件夹。 • 日志不会显示在 Composer > “监控”页面上。 • 用户将在 Composer > “监控”页面看到以下消息： Logging is disabled. Please refer to ThingWorx Platform configuration file to enable it. 此设置仅停止 ThingWorx 内部日志。通过 logback.xml 配置的日志 (例如外部日志) 将继续运行。 Console logs 和 HTTP.out 日志不受任何影响，可继续运行。

如果 EnableOpenTelemetryForLogging 设置为 true，且 DisableFileLogging 设置为 false：

• 用户可在 Composer > “监控”页面看到以下消息：

Logging is disabled. Please refer to platform configuration file to enable it.

• 日志检索策略将设置为 DefaultLogRetrievalStrategy。

如果将 DisableFileLogging 设置为 false，而将 EnableOpenTelemetryForLogging 设置为 true，则可以在平台以及与 OpenTelemetry 集成的第三方软件的 ThingWorx 日志文件中获取日志。

OpenTelemetry SDK 配置

platform-settings.json 文件的 OpenTelemetrySettings 部分提供了以下 OpenTelemetry 配置设置。

设置	默认值	说明
BatchLogProcessorMaxQueueSize	2048	在处理和导出之前最多可加入队列的日志记录数。值越大，吞吐量越高，但需要更多内存。
BatchLogProcessorScheduledDelay	10 毫秒	在导出新批次的日志之前 (即使批次未满)，处理器等待的毫秒数。
BatchLogProcessorMaxExportBatchSize	512	每个导出批次中最多可发送的日志条目数。此设置有助于控制有效负载大小和网络效用。
BatchLogProcessorExportTimeout	1000 毫秒	系统等待日志导出请求完成的毫秒数，超过该时间系统将超时。
OtlpGRPCLogExporterEndpoint		ThingWorx Platform 用来导出日志的 OTLP gRPC 端点 URL (例如，http://localhost:4317)。通过 OpenTelemetry Collector 或任何与 OTLP gRPC 兼容的后端进行远程日志提取时需要此 URL。
OtlpGRPCEnableSSL	false	用于对 OTLP gRPC 日志导出操作启用或禁用 SSL/TLS。 • true - 使用安全传输 • false - 使用纯文本
OtlpGRPCTrustStorePath	不适用	Truststore 文件的路径，该文件包含用于在 SSL 通信期间验证 OpenTelemetry Collector 或目标后端的受信任证书。
OtlpGRPCTrustStorePassword	不适用	用于访问在 OtlpGRPCTrustStorePath 中配置的 truststore 的密码。
OtlpGRPCKeyStorePath	不适用	Keystore 文件的路径，该文件包含双向 TLS (mTLS) 的客户端证书和私钥。
OtlpGRPCKeyStorePassword	不适用	用于访问在 OtlpGRPCKeyStorePath 中配置的 keystore 的密码。
RetryOtlpGRPCLogExporterMaxAttempts	5	当日志导出因暂时性错误而失败时，最多可重试的次数。
RetryOtlpGRPCLogExporterBackOffMultiplier	1.5	用于计算指数退避的乘数。每次数据导出尝试失败后，重试的等待时间将按此系数递增。
RetryOtlpGRPCLogExporterInitialBackOff	1 秒	第一次重试前的时长 (以秒为单位)。
RetryOtlpGRPCLogExporterMaxBackOff	5 秒	指数退避期间的重试间隔秒数。
OtlpGRPCMetricExporterEndpoint	不适用	ThingWorx Platform 用来导出指标的 OTLP gRPC 端点 URL (例如，http://localhost:4317)。通过 OpenTelemetry Collector 或任何与 OTLP gRPC 兼容的后端进行指标提取时，需要此 URL。
EnableOpenTelemetryInternalMetrics	true	允许通过 OpenTelemetry Collector 将指标发送到可观测性平台。