Analyzing Platform Logs

Use the Log Analyzer to view, filter and search the platform log s for all services. The Scheer PAS Log Analyzer uses OpenSearch to analyze the platform logs.

Retention time for logs in Log Analyzer is 30 days.

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.

Analyzing Data

The Scheer PAS Log Analyzer uses OpenSearch as data storage and OpenSearch Dashboards to analyze the logs of all services:

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:

Index Patterns

The log analyzer needs to knows which indices contain the data you want to analyze. So you need at least one index pattern to make sure that data is available. Several index patterns are created automatically with your Scheer PAS installation:

Index Pattern	Description
apiman_metrics*	Required to visualize API Management metrics (see API Management Guide > Metrics).
fl*	Index for logs from the PAS integration component (Bridge), API Management and legacy pas-services. Required for Showing Docker Container Logs.
pas*	Index where PAS services store their log entries. Required for Showing Docker Container Logs.
xuml*	Index for logs from customized xUML services (deployed via Scheer PAS Designer or deployment wizard). The data of an xUML service is logged only after a service deployment.

If your log analyzer is empty and does not contain an index pattern, it asks you to create one. You need to do this only once after the first login, then all permitted users can view the logs.

To create an index pattern, open the log analyzer and close the pop-up Select your tenant. Then open the menu, scroll down to section Management and select Stack Management:

In the Stack Management view, select menu option Index patterns:

Click button Create index pattern:

Example: Creating the fluentd Index

PAS logs are stored by date in a rolling index called fluentd-<YYYY.MM.DD> e.g. fluentd-2022.01.25. To ensure that all indices are fetched, set index pattern name to fl* and click Next step:

In the next window, open the drop-down list of Time field and select @timestamp. Then click Create index pattern:

Open the menu and select option Discover:

You can now inspect the service logs. If no logs are displayed, extend the time range:

Discover: Searching Your Data

To access the functionalities of the log analyzer, open the menu on the start page.

Option Discover allows you:

• to select data for exploration.

• to set a time range for the data.

• to search your data with the Query DSL.

• to filter the results.

• to explore the details of your data.

• to view individual documents.

• to create tables that summarize the contents of the data.

Overview on the Discover page:

1. Search Query:
   Enter your search query here. Visit the official OpenSearch documentation to get detailed information about the Query DSL.

2. Time Range:
   Click here to set a time range for the data you want to inspect.

3. Sidebar:
   Use the sidebar to select your index pattern and to access the list of available fields.

4. Time Histogramm:
   Shows the time range of the displayed data.
   To view the count of documents for a given time, drag the mouse over the histogram.

5. Documents Table:
   All documents/data available for the set time range are displayed here. You can customize the display and adapt it to your needs.

Expand a document to show the available settings:

To add a setting to the table display, click on its menu item Toggle column in table:

To inspect logs of Scheer PAS Node.js services, you can for example select the following settings to display:

• time (displayed by default)

• service (= name of the service)

• level (= log level)

• message (= log message)

• context.request.uuid (= UUID of the request)

• context.user.loginId (= login name of the user)

Once you have created such a query, you are also able to save it for further use, for example in a dashboard (see below).

Creating Dashboards

The log analyzer also offers some default dashboards and the possibility to create your own dashboards. You can add a variety of different panels to inspect and visualize your data, for example area charts, bar and line charts, tree and heat maps, metrics, data tables and many more. Choose option Dashboard in the sidebar to start:

The Scheer PAS Log Analyzer offers several default dashboards. If you open the Dashboard menu, the list of available dashboards is displayed. Refer to the API Management Guide for further information about the API Management default dashboards. If you want to add your own dashboards, use the Create dashboard button: