Troubleshooting Tools and Resources
The ability to quickly diagnose and resolve technical issues is vital. Familiarize yourself with the available tools and resources for troubleshooting problems in your Liferay Cloud projects:
- Application Metrics
- Real-Time Alerts
- Environment Activities
- Environment Logs
- Shell Access
- Disaster Recovery
- Liferay Cloud Platform Status
- Support Access
- Help Center
With these tools and resources, you can track project activities, configure services, resolve technical issues, and more.
Details are subject to your legal agreement with Liferay. For information about legal agreements and services, see the Liferay Legal page.
With Liferay Cloud’s built-in monitoring, users can track resources used by each environment service. These application metrics include memory and CPU usage, as well as network data transfer.
Metrics are available for the default Liferay Cloud stack services: Webserver, Liferay, Search, Database, and Backup. CI metrics are also available in the infra environment.
Users can also integrate Dynatrace’s advanced performance monitoring with production environments.
See Application Metrics for more information.
Liferay Cloud can alert system administrators of unexpected behaviors in a project. Examples of unexpected behaviors include auto-scaling events, higher than expected memory consumption, reaching the allotted CPU quota, and database connection issues.
View all environment alerts and set alert preferences via the Liferay Cloud console.
See Real-Time Alerts for more information.
Users can monitor environment activities via the Liferay Cloud console, where they are sorted into two sections: Builds and Deployments and General Activities.
View the status of builds, deployments, service activities, and more to help troubleshoot environment issues.
See Team Activities for more information.
Environment logs are crucial for diagnosing and resolving technical issues in a project. Users can access and download environment logs via the Liferay Cloud console or your OS terminal.
Application, status, and build logs are provided for each Liferay Cloud Service:
- Application Logs: These logs list runtime information generated after the application is running and accessed by users.
- Status Logs: These logs list orchestration layer information from the Kubernetes cluster.
- Build Logs: These logs list build information generated as the application boots up.
See Log Management for more information.
Command-line tools in the Liferay Cloud console contribute to the developer’s workflow by delivering speed, control, traceability, scripting, and automation capabilities.
When troubleshooting issues, use the shell access tool to look inside your applications and see details not easily spotted in logs.
The shell is accessible in most services, including the
webserver services. It can be used to access the server’s file system directly and run commands for troubleshooting purposes.
For example, you can run the following command from the
liferay service’s shell to test connection to an address or external server:
curl -v [address]
See Shell Access for more information.
The self-healing functionality of Liferay Cloud detects if a service or application has become unresponsive and automatically initiates procedures to recover the unresponsive service. The platform uses probes to monitor the services.
Liferay Cloud offers two probes used in conjunction to manage applications:
- Liveness Probe: This probe indicates whether the service is running.
- Readiness Probe: This probe indicates whether the service is ready to receive requests.
See Self-Healing for more information about configuring each probe.
In the event of a disaster, Liferay Cloud offers two strategies for project recovery: Automatic and Cross-Region.
Liferay Cloud’s automatic disaster recovery strategy replicates services between three availability zones within the same region. If an availability zone becomes unavailable, the load balancer will automatically route to the remaining availability zones without the need for user action.
However, in a cross-region disaster, user intervention is required. To learn more about cross-region disaster recovery tools and processes, see Configuring Cross Region Disaster Recovery.
See Disaster Recovery Overview to learn more about both disaster recovery strategies.
Liferay Cloud Platform Status
When troubleshooting technical issues, be sure to check that all Cloud Platform systems are operational.
Users can view the status of Liferay Cloud Platform systems, planned maintenance windows, and incident history from the Liferay Cloud Platform status page.
To receive notifications of changes in the Cloud Platform’s status, click on Subscribe to Updates, and select your preferred method of notification.
See Liferay Cloud Platform Status for more information.
Support Access is an optional environment setting that expedites troubleshooting by giving Liferay engineers direct access to a Liferay Cloud project environment.
By default, Support Access is enabled in each project environment, though administrators can disable it from the Settings page.
See Support Access for more information.
If you have questions not answered by Liferay Cloud Documentation or would like to report an issue, sign in to the Liferay Help Center to view subscription-only resources or submit a ticket.
From here, users can access the Liferay Cloud Knowledge Base, Product Support, and Announcements.
Users can also subscribe to receive email notifications of the latest Liferay Cloud Help Center Updates. These updates include new platform releases, service updates, and security alerts and patches.
Liferay Cloud notifications are only distributed to customers with an active Liferay Enterprise Subscription.
For additional support, users can contact one of Liferay’s global Support Centers by phone, or submit a ticket via the Help Center page.
When submitting a ticket, please provide information regarding the build images currently in use, behavior or question you are facing, steps to reproduce the issue, and a description of both the actual behavior and the expected behavior.