Page History
Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
Info |
---|
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 the icon 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. | |||
|
Index
PatternPatterns
The log analyzer needs to knows which indices contain the data you want to analyze. So you have to create an need at least one index pattern first 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).
|
If your log analyzer is empty and does not contain an index pattern yet, 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. | |
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. The Discover option allows you:
| |||||||
Overview on the Discover page:
| |||||||
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:
Once you have created such a query, you are also able to save it for further use, for example in a dashboard. |
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.
|
Panel |
---|
Otp | ||||
---|---|---|---|---|
|
| ||
|
Panel | ||
---|---|---|
| ||
Panel | ||
---|---|---|
| ||
...