Access Application Log Files

If an application or a service encounter any errors, you can use the application log files that provide useful troubleshooting information.

Access Custom Configuration Properties File

You can access the custom-config-prod.properties file located at <buildpath>/PlantApplicationsDocker/plantapps-web-docker/mnt/configfiles/custom-config/prod/<version>/custom-config-prod.properties. The custom configuration file is used to add service custom property values and helps retain the modified settings during upgrade.

Note: Ensure that you maintain the syntax in the custom-config-prod.properties which is shown as key-value pair. For example, property name = value.

Access Standard (Windows) Edition Web Client Logs

You can access the service logs located at <Installation_directory>\GE Digital\PlantApplicationsWebClient\ServiceLogs.

Access Enterprise (Linux) Edition Web Client Logs

You can access the service logs located at <buildpath>\PlantApplicationsDocker/plantapps-web-docker/mnt/logs, where <buildpath> is the location that you specified in the silentinstaller.yml file during the Enterprise Edition Web Client installation.

Set the size limit for Log files

By default, the maximum limit for Work Queue and Unit Operations log file size is set to 10MB. That is, if the receptive log file reaches 10MB in size, a new log file will be created. These files are retained for 14 days and the old files are archived. However, you can change these settings by modifying maxSize and maxFiles parameters in the operator-app-prod.yml and workqueue-app-prod.yml files. Follow below instructions to change these parameters in respective files:

Unit Operations Log Settings:
  1. Based on your type of installation, perform one of the below:
    • Enterprise Edition Installation: In the directory <buildpath>/PlantApplicationsDocker/plantapps-web-docker/mnt/configfiles/operator-app/prod/<version>, access the operator-app-prod.yml file by using a text editor.
    • Standard Edition Installation: In the directory <Installation_directory>\config-repo\operator-app\prod\<version>, access the operator-app-prod.yml file by using a text editor.
  2. In the operator-app-prod.yml file, search and update the following loggerSettings with required values:
    "maxSize": "10000000"
"maxFiles": "14d"
    For example:
    "maxSize": "5000000"
"maxFiles": "7d"
    Note: It is recommended to use the file size range from 5MB (5000000) to 20MB (20000000).
  3. After making the modifications, save the file and then restart the operator- app.
Work Queue Log Settings:
  1. Based on your type of installation, perform one of the below:
    • Enterprise Edition Installation: In the directory <buildpath>/PlantApplicationsDocker/plantapps-web-docker/mnt/configfiles/workqueue-app/prod/<version>, access the workqueue-app-prod.yml file by using a text editor.
    • Standard Edition Installation: In the directory <Installation_directory>\config-repo\workqueue-app\prod\<version>, access the workqueue-app-prod.yml file by using a text editor.
  2. In the workqueue-app-prod.yml file, search and update the following loggerSettings with required values:
    "maxSize": "10000000"
"maxFiles": "14d"
    For example:
    "maxSize": "5000000"
"maxFiles": "7d"
    Note: It is recommended to use the file size range from 5MB (5000000) to 20MB (20000000).
  3. After making the modifications, save the file and then restart the work queue app service.

Log Levels

By default, the log files are populated with the warning messages only. However, to change what type of messages needs to be populated in the service log files, you can set the logging levels to debug more detail logs. The log levels helps you to identify and troubleshoot any errors that you may encounter. Below are the properties that you can set either in the portainer or in the common-service-prod.properties file.

Note: When there is a change in the logging level, services dynamically reflect these changes, and it is not required to restart the services.
  1. Based on your type of installation, perform one of the below:
    • Enterprise Edition Installation: In the directory <buildpath>/PlantApplicationsDocker/plantapps-web-docker/mnt/configfiles/common-service/prod/1.0.1/, access the common-service-prod.properties file by using a text editor. For example, $sudo nano common-service-prod.properties
    • Standard Edition Installation: In the directory <Installation_directory>\config-repo\common-service\prod\1.0.1, access the common-service-prod.properties file by using a text editor.
  2. In the common-service-prod.properties file, search and update the following properties as follows:
    • logging.level.root=DEBUG
    • logging.level.com.ge.bm=DEBUG
    • logging.level.com.ge.digital=DEBUG
  3. For work-order-service, search and update the following properties as follows:
    • Logging.LogLevel.Microsoft=Information
    • Logging.LogLevel.Default=Information
    • Logging.LogLevel.GE=Information
    • Logging.LogLevel.Microsoft.EntityFrameworkCore=Information
    Note: For work-order-service, you need to restart the service to debug after making modifications.
  4. After making the modifications, save the file.