ThingWorx Model Definition in Composer > System > Logs > OpenTelemetry for ThingWorx Platform Logging > OpenTelemetry Configuration
OpenTelemetry Configuration
The following OpenTelemetry Configuration settings are added in BasicSettings of platform-settings.json file.
Setting
Type
Default Value
Description
EnableOpenTelemetryForLogging
BOOLEAN
false
Set the value to true to enable OpenTelemetry Collector.
This set value is effective when the ThingWorx server starts. OpenTelemetry Collector will start a connection with the ThingWorx server.
DisableFileLogging
BOOLEAN
false
Once the value is set to true
• Logs generated in the /ThingworxStorage/logs folder will stop.
• Logs will not be displayed in the Composer > Monitoring section.
• User will see the following message on the Composer > Monitoring page.
Logging is disabled. Please refer to ThingWorx Platform configuration file to enable it.
* 
• This setting will only stop ThingWorx internal logs. Logs configured through logback.xml, such as external logs, will work as configured.
• Console logs and HTTP.out logs are unaffected and continue to work.
* 
• If DisableFileLogging is set to true and EnableOpenTelemetryForLogging is set to false, then,
◦ The user should see a message on Composer > Monitoring page.
Logging is disabled. Please refer to platform configuration file to enable it.
◦ Log retrieval strategy is set to DefaultLogRetrievalStrategy.
• If DisableFileLogging is set to false and EnableOpenTelemetryForLogging is set to true, then logs will be available in files on Platform and third party software integrated with OpenTelemetry.
OpenTelemetry SDK Configuration
The following OpenTelemetry Configuration settings are added in OpenTelemetrySettings of platform-settings.json file.
Configuration Name
Default Value
Description
BatchLogProcessorMaxQueueSize
2048
Configuration for exported logs processing for each batch.
BatchLogProcessorScheduledDelay
10
BatchLogProcessorMaxExportBatchSize
512
BatchLogProcessorExportTimeout
1000
OtlpGRPCLogExporterEndpoint
OtlpGRPCEnableSSL
false
Security(SSL) configurations
OtlpGRPCTrustStorePath
OtlpGRPCTrustStorePassword
OtlpGRPCKeyStorePath
OtlpGRPCKeyStorePassword
RetryOtlpGRPCLogExporterMaxAttempts
5
Retry attempt configuration
RetryOtlpGRPCLogExporterBackOffMultiplier
1.5
RetryOtlpGRPCLogExporterInitialBackOff
1
RetryOtlpGRPCLogExporterMaxBackOff
5
OtlpGRPCMetricExporterEndpoint
Metrics exporting to Prometheus
EnableOpenTelemetryInternalMetrics
true
Was this helpful?