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
Acessing KibanaImage Modified | 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. |
Image Added | If you click |
the |
log analyzer tile, the tool will open within the portal. |
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Kibana: Analyzing Data
You can also open the log analyzer in a separate browser tab. To do so, use the icon Image Added in the lower right corner of the tile. |
Analyzing Data
Image Added | The Scheer PAS Log Analyzer uses OpenSearch as data storage and OpenSearch Dashboards to analyze the logs of all services. OpenSearch Dashboards | Image Removed | Scheer PAS uses Kibana to view, filter and search the platform log s for all services. Kibana is an open source analytics and visualization tool designed to work with Elasticsearch. With Kibana you . You can search, view, and interact with data stored in Elasticsearch OpenSearch indices. You can perform advanced data analysis and visualize your data in a variety of charts, tables, and maps in customized dashboards. |
Image RemovedImage Added |
|
Index
PatternPatterns
Kibana The log analyzer needs to knows which Elasticsearch indices contain the data you want to analyze. So you have to create an need at least one index pattern in Kibana 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 If your Kibana is empty and does not contain an index pattern yet, Kibana 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.
Image Added | To create an index pattern, open the log analyzer. |
Image Added | Close the pop-up Select your tenant. Then open the menu Image Added, scroll down to section Management and select Stack Management. |
Image Added | In the Stack Management view, select menu option Index patterns. Click button Create index pattern: Image Added |
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. | |||
Image Added | In the next window, open the drop-down list of Time field and select @timestamp. Then click Create index pattern. | ||
Image Added | Open the menu Image Added and select option Discover. | ||
Image Added | You can now inspect the service logs. If no logs are displayed, extend the time range.
|
Discover: Searching Your Data
Image RemovedImage Added | To access the functionalities of Kibanathe log analyzer, open the menu Image Modified on the Kibana start page. The Discover option allows you:
The Official Kibana Documentation offers a tutorial on how to use the Discover option. | ||||||
Image Modified | Overview on the Discover page in Kibana:
| ||||||
Image RemovedImage Added | Expand a document to show the available settings. To add a setting to the table display, click on its menu item Image Modified Toggle column in table:
| ||||||
Image Added | 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
Image RemovedImage Added | Kibana 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. | |||||
Image Added | 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 | Image Removed | If no dashboards are available, you are asked to create your first dashboard. For example, use a query saved in Discover to insert it as block in your dashboard.
| |||
Image Removed | If you have already created some dashboards, the available dashboards are displayed. Use the list to open, edit or delete your dashboards. |
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
|
Otp | ||||
---|---|---|---|---|
|
Rp |
---|
Panel | ||
---|---|---|
| ||