Teamcenter logging

Multiple Teamcenter components across the four-tier architecture can be involved in servicing an action request such as "expand the BOM". As a component processes the request, the component logs any related messages to its own log file. Administrators can review the logged messages to monitor and troubleshoot system performance. An action could be (but is not limited to): an SOA service request; an FMS file upload/download; a microservice call; or a spawned child process. The four-tier architecture comprises the following tiers: The client tier hosts client applications, provides user interface input and output processing, and hosts secure file caches. The web tier routes client requests to business logic servers, serves static content to clients, and processes login requests. The enterprise tier hosts business logic, makes queries and performs transactions for clients, applies security rules that control access to product data, and serves dynamic content to clients. The resource tier stores persistent data, such as the database where product data and managed files are stored. It also stores administrative data, including user data in LDAP-compliant repositories. Example transaction flow A client sends a request that is received first by the web tier. A message recording the request is written to the WebTier.log file. The same identifying information is recorded in the ServerManager.log file, where the server manager assigns the tcserver1 process for this user. The request path can be traced in the tcserver1.syslog file where messages have the same identifying information. Log message format To facilitate retrieval of messages from the logs of components involved in processing the request, most component messages follow a consistent format, and each message includes identifying information that is generated when the request is initiated: a Session ID, User Action, and Correlation ID. Messages use the following format: Copy ------ Format element Description Time Stamp The Coordinated Universal Time (UTC) when the message occurred. Log Level The message severity, one of FATAL, ERROR, WARN, INFO, DEBUG, or TRACE Class Name (Optional) A fully qualified class name identifying the message origin. For example Teamcenter.CoreModelGeneral.Preferences. The value may also contain the file path and line number. Session ID (Optional) A value identifying the client session or root application that initiated the request. This value applies to all initiated requests for the duration of the client session or root application. User Action (Optional) A meaningful label that identifies a group of requests initiated by a single user action or an application block of work. Correlation ID (Required) A unique value that identifies a particular request. This value appears in all related messages from all the components that work on processing that request. Message The actual message logged by the component. Example A message populated with all format elements: Copy 2022/09/23-22:06:54.574 UTC - INFO - Teamcenter.MetaModel - 5F0B0A62 - BOMExpand - 1388EFEER138 - Using existing MetadataCache A message populated with only required format elements: Copy 2022/09/23-22:06:54.574 UTC - INFO - - - - 945DE249R294 - Using existing MetadataCache Default base log file location Log files for business logic servers, the server manager, the web tier, and other components are written within a single base log file location on the host where the components are running. Expression of the default location depends on the host operating system: Host OS Default base log file location Windows %USERPROFILE%\Siemens\logs\ Linux $HOME/Siemens/logs/ Custom base log file location To specify a custom base log file location, create the environment variable SIEMENS_LOGGING_ROOT and set it to your preferred location. Managing FSC proxy log files FSC proxy logs containing identical messages can quickly accumulate in the logs folder. You can limit disable FSC proxy logging altogether by setting the logging.logger.Teamcenter.FMS.FSCProxy property to a value of OFF in the TC_DATA\logger.properties file: Copy logging.logger.Teamcenter.FMS.FSCProxy=OFF # Logger for the FSC Native Proxy that communicates from the TcServer to the FSC