Analyzing Platform Logs

The Log Analyzer uses OpenSearch as data storage and OpenSearch Dashboards to analyze the service logs. OpenSearch Dashboards is an open source analytics and visualization tool. You can search, view, and interact with data stored in OpenSearch indices. You can perform advanced data analysis and visualize your data in a variety of charts, tables, and maps in customized dashboards.

For detailed information on OpenSearch, its features and how to use them, refer to the Official OpenSearch Documentation. Please note that the official documentation may vary according to different versions of the tool. Before consulting the documentation, check your OpenSearch version.
It is displayed if you open the help menu where you can also find a direct link to the official documentation:

What is the Log Analyzer used for?

Use the Log Analyzer in addition to the Resource Monitor and the PAS Administration to analyze faulty services and find solutions for problematic behavior. In the Log Analyzer, you can view, filter and search the logs for all services.

Retention period for logs in Log Analyzer is 30 days.

Examples:

• A service crashes periodically.

• A service shows error messages during execution.

Use the Log Analyzer to check whether certain error messages in the UI correlate with errors in the service logs.

Use the Resource Monitor to check if error messages in the log correlate with periods of high load or memory usage. It also shows you the load a service causes and the memory usage of the service. You can check whether defined limits are repeatedly exceeded - and react accordingly.
Refer to Monitoring Container Activities for details.

Use the service details in the PAS Administration to adapt the memory limit of a service.
Depending on your setup, refer to Docker: Adapting the Configuration of Containerized xUML Services or
Kubernetes: Adapting the Configuration of Containerized xUML Services.

Acessing the Log Analyzer

You can access the log analyzer via the corresponding tile in the Scheer PAS Portal:

Only users with profile kibana_user are able to see the tile in the portal. If you click the log analyzer tile, the tool will open within the portal:

You can also open the log analyzer in a separate browser tab. To do so, use option Open in new browser tab in the lower right corner of the tile.

For more details on log analyzer functionality refer to further pages in this chapter:

Expert Tipp

To inspect the logs of a specific service, open the Log Analyzer from within the service details in the PAS Administration.

Docker Setup:

In the service details, open section Logs and use option Open Log Analyzer to inspect logs.
The Log Analyzer will open, showing all logs of this specific service.
Refer to Showing Docker Container Logs and Docker: Showing Logs of a Containerized xUML Service for more details.

Kubernetes Setup:

On a Kubernetes system, section Logs in the service details is divided in two parts: Service Logs and Transaction Logs.
In both parts you can find a button to open the Log Analyzer:

• Open Service Logs: Shows the logs filtered by service name and log channel Error.

• Open Transaction Logs: Shows the logs filtered by service name and log channel Access.

Refer to Showing Workload Logs and Kubernetes: Showing Logs of a Containerized xUML Service for more details.