Versions Compared

Old Version 4

changes.mady.by.user Annegret Bernhardt

Saved on

compared with

New Version 5

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WADMINPAS and version 22.1

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

Acessing the Log Analyzer

Acessing Kibana

You can access Keycloak 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 RemovedImage Added

If you click the Kibana log analyzer tile, the tool will open within the portal.

Kibana:

.

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 RemovedImage Added

The Scheer PAS uses Kibana to view, filter and search the platform logs for Log Analyzer uses OpenSearch as data storage and OpenSearch Dashboards to analyze the logs of all services.

Kibana OpenSearch Dashboards 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

Tip

For detailed information on KibanaOpenSearch, its features and how to use them, refer to the Please note that Scheer PAS does not use the regular Elasticsearch/Kibana installation but the OpenDistro version. Some Kibana features may not be available in the OpenDistro version.Official Kibana Documentation.OpenSearch Documentation.

Please note that the official documentation may vary according to different versions of the tool. Before consulting the documentation, check your Kibana OpenSearch version. It is displayed if you open the help menu menu Image Modified where you can also find a direct link to the official documentation.

Creating an Index Pattern

Kibana The log analyzer needs to knows which Elasticsearch indices contain the data you want to analyze. So you have to create an index pattern in Kibana first to make sure that data is available. If your Kibana log analyzer 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 with Kibana permission can view the logs.

Image Modified

To create an index pattern, open

Kibana and

the log

in

analyzer.

Image Removed

Click Explore on my own

Image Added

Close the pop-up Select your tenant.

Then open the menu Image Added, scroll down to section Management and select

Discover

Stack Management.

Image Removed

Image Added

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

Click button Create index pattern

.

:

Image Added

Image Modified

Set

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*

, then

and click Next

Step

step.

Image Modified

In the next window, open the drop-down list of Time field and select @timestamp

, then

.

Then click Create index pattern.

Image Removed

Go back to menu Discover: Now you can see

Image Added

Open the menu Image Addedand select option Discover.

Image Added

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

Tip
For further information refer to page Create an index pattern in the Official Kibana Documentation

Use the link Open Log Analyzer to inspect logs in the service details in Scheer PAS Administration to open the respective dataset within the Log Analyzer.


Discover: Searching Your Data

The Official Kibana Documentation offers a tutorial on how to use the Discover option
  • .

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:

  • to select data for exploration.
  • to set a time range for the data.
  • to search your data with the Kibana Query LanguageDSL.
  • 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.
Tip

Overview on the Discover page in Kibana:

  1. Search Query:
    Enter your search query here. Visit the official Kibana OpenSearch documentation to get detailed information about the Kibana Query Language (KQL)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.

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:

Anchor
discover_query
discover_query
Image Removed Image AddedImage Removed

Image Added

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

  • timestamp time (displayed by default)
  • service (= name of the service)
  • level (= log level)
  • message (= log message)
  • context.userrequest.loginIduuid (= login name UUID of the userrequest)
  • context.requestuser.uuidloginId (= UUID login name of the requestuser)

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.

Tip

Refer to

page Dashboard in the Official Kibana

chapter OpenSearch Dashboards in the Official OpenSearch Documentation for detailed information how to create a 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.

Otp
Floatingfalse
maxHLevel2

Rp
Rde