Troubleshooting Smart IT availability or stability issues
The Smart IT application depends on multiple components for its service to be available. In case of a sudden disruption of the Smart IT service, you must isolate the Smart IT component that is causing the disruption, and then take appropriate action.
Use the information in this topic to identify the problem and restore service as quickly as possible, or to gather relevant information and logs to create a case with BMC Customer Support.
Issue symptoms
The following table lists the error messages or issues that you might encounter:
For this error message or issue... | Perform this task... | |
---|---|---|
Smart IT Universal Client does not load. You might observe the following error messages or issues in the browser: | ||
| ||
| ||
| ||
| ||
The Smart IT login screen is displayed but after entering credentials, one of the following issues occurs: | ||
| ||
The application freezes on the Remedy Single Sign-On login page. | ||
Smart IT Universal Client performance is severely affected, making the application unusable. Sections of the Smart IT interface display spinning wheels as shown in the following Smart IT dashboard screen: | ||
Smart IT screens display partial or random error messages. |
Issue scope
- Environments that were running are suddenly affected.
- All or most users are affected.
- Problem may be intermittent in case of environments using Smart IT Clusters or AR Server groups with load balancing.
For environments where the Smart IT service is unavailable following a scheduled change (for example, upgraded or cloned environments, change of Remedy Action Request System password, etc.), see Troubleshooting-cloned-Smart-IT-environment-issues.
Diagnosing and reporting an issue
Perform the following tasks to troubleshoot the issues:
Task | Action | Steps | Reference |
---|---|---|---|
1 | Make sure that the Smart IT Tomcat service is running and listening on the expected port. Confirm that there are no network issues or firewalls that could cause connection failure between the client (browser) and Smart IT Server. Important: In case of a Smart IT environment that is integrated with Remedy Single Sign-On, confirm if the URL that fails to load in the browser is the Smart IT URL. In case the failing URL relates to Remedy Single Sign-On, see Troubleshooting-Remedy-Single-Sign-On-integration-with-Smart-IT. |
If Tomcat is not running: Start the Tomcat service and check if Smart IT becomes available. If Tomcat fails to start, confirm if there has been any recent changes for Java, OS patches, or antivirus software on the server. Back up and clear the following logs:
Enable Smart IT debug logging (if not enabled yet) and then restart the service. Check all newly created logs for any errors. Also, see this task.
| See the Resolution for common issues section in this topic for possible errors and corrective actions. |
2 | These errors are triggered by the RSSO Agent on the Smart IT Server and are therefore displayed only on environments that have the Remedy SSO integration enabled for Smart IT. Check the RSSO Agent log file on the Smart IT Server for details on what triggered the error and the next steps to take. |
Important: During the start-up of Smart IT Server, it will sync these .properties files between these two folders. The file with the most recent modified date is present in both folders.
|
See the Resolution for common issues section in this topic for possible errors and corrective actions. |
3 | If you see only a generic error in the browser window, review the browser network logs (F12). Review the response data for the REST calls to see if a detailed error message is captured, which might help isolate the cause of the problem. |
/smartit/rest/serverstates /smartit/rest/users/sessions (for Remedy SSO integrated environments) /smartit/rest/users/sessions/<loginID> (for non-Remedy SSOintegrated environments)
If a more detailed error is present in the response data:
| See the Resolution for common issues section in this topic for possible errors and corrective actions. |
4 | On a Remedy SSO integrated Smart IT environment, if you see a spinning wheel and ERROR (623) in the browser network logs, the user was successfully authenticated against the identity provider (IdP) configured in Remedy SSO and has received an SSO token. However, authorization fails when Smart IT attempts to connect to AR Server (configured as the Persistent Data Store for Smart IT) with the Login ID and SSO token. |
<date time> INFO Thread_471 com.bmc.rsso.agent.RSSOAgent.process(): User 'LoginId' is authenticated, token '_xxxxxxxx-*****-xxxxxxxxxxxx'
<API > .... <USER: LoginId > .... */ +VER ARVerifyUser -- user LoginId from Palm Pilot (protocol 26) at IP address ....
/* LOGIN LoginId (guest)(session Id xxxx)
*/ An error has occurred while loading a plug-in. Plugin: ARSYS.AREA.RSSO Or if instances of the RSSO plug-in are successfully created, e.g.: */ Thread xx successfully created an instance of ARSYS.AREA.RSSOIf the RSSO Plug-in is loading successfully, try logging in to Smart IT again. If the problem persists, checkarjavaplugin.log for any detailed error messages when the RSSO Plug-in handled the login.
| Use the following steps to review in case the User ID presented to AR Server by Smart IT does not match the Login Name stored in AR System's User form:
See the Resolution for common issues section in this topic for possible errors and corrective actions. For more information, see the following resources: |
5 | When all sections of the Smart IT interface show spinning wheels, start by checking the health of the AR Servers configured as Smart IT's persistent data store as well as its related AR System database. Next, check for any excessive CPU or memory usage on the Smart IT Servers and the Smart IT database. If no apparent issues are found in these major components, continue with a log review to determine the root cause of the performance issue. |
If you observe performance issues on AR Server side, seeTroubleshooting process for performance issues for more information. If the AR Server performance is affected by API calls originating from the Smart IT server, see Resolution for common issues section in this topic for possible errors and corrective actions, or review the information that you can submit to BMC Support for further review.
|
See the Resolution for common issues section in this topic for possible errors and corrective actions. |
6 | Review the main Tomcat and Smart IT logs for errors or exceptions that might be causing service disruption. If an error is identified, confirm if it is clear from the error message what action to take. If not, see the Resolution for common issues section in this topic for possible errors and corrective actions or create a case with BMC Support for further assistance. |
<tomcat>\logs
catalina.<current_date>.log Regular expression to help with the initial review of Tomcat logs: SEVERE|jdbc.*Exception|Exception.*jdbc|OutOfMemoryError|Startup failed|ERROR \([0-9]{0,4}\)
bootstrap.log Regular expression to help with the initial review of Smart IT logs: \| ERROR \||errorCode|ERROR \([0-9]{0,4}\)|jdbc.*Exception|Exception.*jdbc|heap space|connection problem
If you see an error for a specific RID, and DEBUG logging is enabled, the last entries for that RID includes information about the REST call for which the error was reported (and the HTTP status code) to match this with what is seen in the F12 .har logs: <date_time> | <threadId> | RID: 26 | DEBUG | c.b.b.myit.filter.ExpiresFilter | Request '/smartit/rest/users/sessions' with response status '500' content-type ...
| Possible options to perform searches that use regular expressions:
Remember to switch the search option back to the Normal mode for plain text searches.
Select-String filename.log -Pattern 'regular_expression'
grep -E 'regular_expression' filename.log See the Resolution for common issues section in this topic for possible errors and corrective actions. |
7 | Collect data that can help BMC Support analyze the root cause of Smart IT service disruption. | Collect and provide the following information (as applicable) from the environment to help BMC Support analyze the root cause of Smart IT service disruption
'<tomcat>\logs' folder Important: Due to rollover of the smartit.log, back-ups of that log that are relevant to the issue might have been moved to a subfolder with name format YYYY-MM-weekX
<tomcat>\external-conf\rsso-agent.properties
|
Resolutions for common issues
Symptom | Action | Reference |
---|---|---|
List of common errors that can be ignored while troubleshooting Smart IT outage situations: File: <tomcat>\logs\catalina.<date>.log .. SEVERE [localhost-startStop-2] org.apache.catalina.loader.WebappClassLoaderBase.checkThreadLocalMapForLeaks The web application [smartit] created a ThreadLocal with key of type [java.lang.ThreadLocal] (value [java.lang.ThreadLocal@683d467e]) and a value of type [com.bmc.arsys.apitransport.session.ApiThreadLocalStorageBlock] (value [com.bmc.arsys.apitransport.session.ApiThreadLocalStorageBlock@4cb33167]) but failed to remove it when the web application was stopped. Threads are going to be renewed over time to try and avoid a probable memory leak. .. SEVERE [http-nio-9000-exec-5] org.glassfish.jersey.server.ServerRuntime$Responder.writeResponse An I/O error has occurred while writing a response message entity to the container output stream. File: <tomcat>\logs\localhost.<DATE>.log .. SEVERE [localhost-startStop-1] org.apache.tomcat.util.descriptor.web.SecurityConstraint.findUncoveredHttpMethods For security constraints with URL pattern [/*] only the HTTP methods [TRACE OPTIONS] are covered. All other methods are uncovered. File: ..\Smart_IT\Logs\smartit.log .. | ERROR | c.b.b.m.s.r.SmartReportingService | Error generating URL for cross launch .. | ERROR | c.b.b.m.s.p.a.APNSServiceConfig | Failed iOS certificate verification .. | ERROR | c.b.b.m.s.n.NotificationService | Notification service could not be initialized for tenant 000000000000001 File: ..\Smart_IT\Logs\smartit-metadata.log .. | WARN | c.b.b.m.s.ARMetaDataService | Fail to load fields from data store <arServer>. Cause - ERROR (303): Form does not exist on server; SHR:UnionOverview_MasterConsole .. | WARN | c.b.b.m.s.ARMetaDataService | Fail to load views which are available for schema SHR:UnionOverview_MasterConsole. Cause - ERROR (303): Form does not exist on server; SHR:UnionOverview_MasterConsole .. | WARN | c.b.b.m.s.ARMetaDataService | Fail to load fields from data store <arServer>. Cause - ERROR (303): Form does not exist on server; SB:ServiceRequestStub .. | WARN | c.b.b.m.s.ARMetaDataService | Fail to load views which are available for schema SB:ServiceRequestStub. Cause - ERROR (303): Form does not exist on server; SB:ServiceRequestStub .. | WARN | c.b.b.m.s.ARMetaDataService | Fail to load fields from data store <arServer>. Cause - ERROR (303): Form does not exist on server; CTM:Support Group Assoc LookUp People Join .. | WARN | c.b.b.m.s.ARMetaDataService | Fail to load views which are available for schema CTM:Support Group Assoc LookUp People Join. Cause - ERROR (303): Form does not exist on server; CTM:Support Group Assoc LookUp People Join F12 Network log (.har) HTTP 404 error for the URL: http(s)://<smartITServer:Port>/tenant-custom-res/000000000000001/style-smart-it.css | No action required. The errors listed in this row can be ignored while troubleshooting Smart IT outage situations. | |
File: <tomcat>\logs\commons-daemon.<date>.log [date_time] [error] [ 8024] Failed creating Java 'C:\Program Files\Java\jdk-12.0.2\bin\server\jvm.dll'. | Specify the correct JVM path for Tomcat. | |
File: <tomcat>\logs\catalina.<date>.log .. SEVERE [localhost-startStop-1] org.apache.tomcat.jdbc.pool.ConnectionPool.init Unable to create initial connections of pool. [Detailed_SQL_Exception_>>_Examples] .. SEVERE [localhost-startStop-1] org.apache.catalina.core.StandardContext.startInternal One or more listeners failed to start. Full details will be found in the appropriate container log file Examples of detailed SQL Exceptions: com.microsoft.sqlserver.jdbc.SQLServerException: The TCP/IP connection to the host <smartITDBHost>, port <smartITDBPort> has failed. com.microsoft.sqlserver.jdbc.SQLServerException: Cannot open database "<smartITDBName>" requested by the login. The login failed. com.microsoft.sqlserver.jdbc.SQLServerException: Login failed for user '<smartITSystemUserName|smartITBusinessUserName>' java.sql.SQLException: ORA-01017: invalid username/password; logon denied Files: <tomcat>\logs\localhost.<DATE>.log and ..\Smart_IT\Logs\bootstrap.log org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'persistenceUnitManager' defined in class path resource [app-context-jpa.xml] | This error indicates that the connection to the Smart IT Database for the SmartIT_System and SmartIT_Business resource is failing. The database connection details are stored in the following XML file on the Smart IT Server: ..<tomcat>\conf\Catalina\localhost\smartit.xml Take corrective steps based on the detailed SQL error message captured in the catalina log. Parameters of interest in the smartit.xml file (Each parameter is present twice, once for the SmartIT_System resource and once for the SmartIT_Business resource):
Confirm that the Smart IT database can be reached from the Smart IT Server and (have a DBA) check the configured credentials directly against the database. | |
File: <tomcat>\logs\localhost.<DATE>.log .. SEVERE [localhost-startStop-1] org.apache.catalina.core.StandardContext.listenerStart Exception sending context initialized event to listener instance of class [org.springframework.web.context.ContextLoaderListener] OR File: ..\Smart_IT\Logs\smartit.log .. | ERROR | c.b.b.m.s.s.i.<className> | DB could not be indexed | These errors suggests Smart IT was able to connect to the database, but an expected table is not found. Check in the Smart IT Database if a table with the indicated object name exists. The diagram below shows the table names and their schema for a default installation. If the table exists, check the connection details in this file on the Smart IT Server: ..<tomcat>\conf\Catalina\localhost\smartit.xml
| For information about pre-creating the Smart IT database for the expected user setup, see Creating-the-database. |
File: <tomcat>\logs\rsso-agent.0.log javax.net.ssl.SSLHandshakeException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target | Correct the certificate setup. | |
File: ..\Smart_IT\Logs\bootstrap.log .. | ERROR | c.b.a.c.c.n.i.NotificationControllerImpl | GSI call failed for message broker or ..| ERROR | c.b.b.m.s.c.CCSPropertiesService | Error while checking application upgrade status. or .. | DEBUG | c.b.b.m.s.ZDTAppsUpgradeService | Error while fetching the Version from SHARE:Application_Properties | The Remedy Application Service password defined in CONFIGURATION_PARAMETER table (Smart IT System schema) is incorrect. Update the password. Important: The password must be stored in the table in an encrypted format (plain text will not work). In versions 18.0x and 19.0x, use the Smart IT Maintenance Tool to encrypt the password. For Smart IT 20.02 and higher, use the Password Encryption utility. | |
File: ..\Smart_IT\Logs\bootstrap.log .. | ERROR | c.b.b.m.s.c.CCSPropertiesService | Error while initializing CCSPropertiesService | The Remedy Application Service password defined in the CONFIGURATION_PARAMETER table in the Smart IT System schema is not properly encrypted. Encrypt the password. | |
File: ..\Smart_IT\Logs\bootstrap.log .. | DEBUG | c.b.b.m.s.ZDTAppsUpgradeService | Error while fetching the Version from SHARE:Application_Properties | The Remedy Application Service password defined in the CONFIGURATION_PARAMETER table in the Smart IT System schema is not properly encrypted. Encrypt the password. This error can be seen on Smart IT 20.02 when the password is encrypted with the Maintenance Tool of a lower version, while the new 20.02 password encryption utility should be used. | |
File: ..\Smart_IT\Logs\smartit-metadata.log .. | ERROR | c.b.b.m.c.ConfigurationManager | Error loading ITSM Version: com.bmc.arsys.api.ARException: ERROR (623): Authentication failed; Remedy Application Service | The Remedy Application Service password defined in the CONFIGURATION_PARAMETER table in the Smart IT System schema might be entered in plain text. Encrypt the password and update it in the table. | |
File: ..\Smart_IT\Logs\bootstrap.log .. | ERROR | c.b.a.c.c.n.i.NotificationControllerImpl | GSI call failed for message broker or | ERROR | c.b.b.m.s.c.CCSPropertiesService | Error while checking application upgrade status. or | DEBUG | c.b.b.m.s.ZDTAppsUpgradeService | Error while fetching the Version from SHARE:Application_Properties | Smart IT is unable to connect to the AR Server with the connection information stored in the CONFIGURATION_PARAMETER table in the Smart IT System schema. Verify if the AR port defined in this table is correct and that Smart IT can connect to AR Server on the specified port. | |
File: ..\Smart_IT\Logs\bootstrap.log org.xml.sax.SAXParseException: schema_reference.4: Failed to read schema document 'http://www.springframework.org/schema/context/spring-context-3.0.xsd', because 1) could not find the document; 2) the document could not be read; 3) the root element of the document is not <xsd:schema>. | ||
File: <tomcat>\logs\localhost.<current_date>.log .. SEVERE [localhost-startStop-1] org.apache.catalina.core.StandardContext.filterStart Exception starting filter [Agent] File: ..\Smart_IT\Logs\bootstrap.log .. | ERROR | c.b.bsm.myit.util.FilesCopyUtil | File sso-sdk.properties from /apps/ars/Smart_IT/Smart_IT/smartit/WEB-INF/classes/sso-sdk.properties not copied to /apps/apache/tomcat8.5/external-conf properly, try to restart application server and verify properties files | Add the correct file system permission on the Smart IT Server. | |
File: <tomcat>\logs\localhost.<current_date>.log .. SEVERE [main] org.apache.catalina.core.StandardContext.filterStart Exception starting filter [Agent] Important: The example error is related to a class from jjwt-api-<version>.jar. The actual class name referenced in the error might be different depending on the .jar file that is affected. General format of the error is: .. SEVERE [main] org.apache.catalina.core.StandardContext.filterStart Exception starting filter [Agent] | Check the presence (and size) of the required .jar files for the RSSO Agent in the <tomcat>\external-conf\lib folder on the Smart IT Server. | |
F12 Network log (.har) {"error":"MOBILITY_ERROR_LOGIN","errorCode":1006,"defaultMessage":"Unable to check user status","additionalMessage":"ServiceException: Unable to check user status","detailedMessage":"Unable to check user status","arconnectionProblem":false} File: ..\Smart_IT\Logs\smartit.log .. | ERROR | c.b.b.m.service.UsersServiceImpl | Unable to check user status | Confirm if the User Details Pluggable provider is enabled and the .jar file for this provider (name: itsm-user-details-<version>-BUILD-SNAPSHOT.jar) is present in the ..\Smart_IT\smartit\WEB-INF\classes\provider\itsm-user-details folder. | |
F12 Network log (.har) {"error":"MOBILITY_ERROR_LOGIN","errorCode":1006,"defaultMessage":"Login Failed: An authentication error occurred in the data server.","additionalMessage":"Your password has expired. Please, login to AR server and change it","detailMessage":"ERROR (623): Authentication failed; Password has expired","ARConnectionProblem":false} | Open the record of the affected user in AR System User form, and check if the Force Password Change On Login field is set. Have the user change their password to clear this field. | |
F12 Network log (.har): {"error":"MOBILITY_ERROR_INTERNAL_SERVER_ERROR","errorCode":1013,"defaultMessage":"Missing People Info.","additionalMessage":"UnauthorizedException: Missing People Info.","detailedMessage":"HTTP 403 Forbidden","arconnectionProblem":false} File: ..\Smart_IT\Logs\smartit.log ..| ERROR | c.b.b.m.assembler.EntryAssembler | Failed to fill(queryParameters=[{name=loginId, value=<LoginID>}], user:<LoginID>, host: <arServer>) com.bmc.arsys.api.ARException: ERROR (623): Authentication failed; Remedy Application Service | Validate the connection settings for the MyIT-ITSM Persistent Data Store of Smart IT. Make sure that they are correct and that there are no connectivity issues between Smart IT and AR System. The specific error here suggests that the Remedy Application Service password stored in the Persistent Data Store of Smart IT is incorrect. Important: This error can also be seen in the network logs when attempting to log in to Smart IT with a user that has no people record (for instance, if you attempt to log in with Remedy's classic 'Demo' administrator user). Make sure the user ID used to log in has been set up with the correct Smart IT Roles and Permissions. | |
Long running queries against the SMT:Social_WorklogView form together with high CPU usage on the AR System database. | Check the resources in the Reference column for resolution. |