1. Observability User Guide
  2. Observability Improvements Logs using ELK Stack

2 Observability Improvements Logs using ELK Stack

This topic describes the troubleshooting procedures using the ELK Stack.

2.1 Setting up ELK Stack

This topic describes the systematic instruction to download, run and access the ELK Stack.

Download ELK Stack

  1. Download the Elastic search from https://www.elastic.co/downloads/elasticsearch.
  2. Download the Kibana from https://www.elastic.co/downloads/kibana.
  3. Download the Logstash from https://www.elastic.co/downloads/logstash.

    Figure 2-1 ELK Setup


    Description of Figure 2-1 follows
    Description of "Figure 2-1 ELK Setup"

    Note:

    Default port for Elastic search is 9200 and the default port for Kibana is 5601.

2.1.1 Run ELK Stack

This topic describes the systematic instruction to run the ELK Stack.

Perform the following steps:
  1. Run the elasticsearch.sh file present in the folder path /scratch/software/ELK/elasticsearch-6.5.1/bin.
  2. Configure the Kibana to point the running instance of elastic search in the kibana.yml file.
  3. Follow the below steps to configure the Logstash.
    1. Input: This configuration is used to provide the log file location for the Logstash to read from.
    2. Filter: This configuration is used to control or format the read operation (Line by line or Bulk read).
    3. Output: This configuration is used to provide the running elastic search instance to send the data for persisting.

    Figure 2-2 Logstash Configuration


    Description of Figure 2-2 follows
    Description of "Figure 2-2 Logstash Configuration"

2.1.2 Access Kibana

This topic describes the information to access the kibana.

Figure 2-3 Access Kibana


Description of Figure 2-3 follows
Description of "Figure 2-3 Access Kibana"

2.2 Kibana Logs

This topic describes the information to setup, search and export the logs in Kibana.

Setup Dynamic Log Levels in Oracle Banking Microservices Architecture Services without Restart

The plato-logging-service is dependent on two tables, which needs to be present in the PLATO schema (JNDI name: jdbc/PLATO). The two tables are as follows:
  • PLATO_DEBUG_USERS: This table contains the information about whether the dynamic logging is enabled to a user for a service. The table will have records, where DEBUG_ENABLED values for a user and a service have values Y or N, and depending on that plato-logger will enable dynamic logging.

    Figure 2-4 PLATO_DEBUG_USERS


    Description of Figure 2-4 follows
    Description of "Figure 2-4 PLATO_DEBUG_USERS"

  • PLATO_LOGGER_PARAM_CONFIG: This table contains the key-value entries of different parameters that can be changed at runtime for the dynamic logging.

    Figure 2-5 PLATO_LOGGER_PARAM_CONFIG


    Description of Figure 2-5 follows
    Description of "Figure 2-5 PLATO_LOGGER_PARAM_CONFIG"

    The values that can be passed are as follows:

    • LOG_PATH: This specifies a dynamic logging path for the logging files to be stored. Changing this in runtime, changes the location of the log files at runtime. If this value is not passed then by default, the LOG_PATH value is taken from the -D parameter of plato.service.logging.path.
    • LOG_LEVEL: The level of the logging can be specified on runtime as INFO or ERROR etc. The default value of this can be set in the logback.xml.
    • LOG_MSG_WITH_TIME: Making this Y appends the current date into the log file name. Setting the value of this as N cannot append the current date into the filename.

Search for Logs in Kibana

Search logs in Kibana using https://www.elastic.co/guide/en/kibana/current/search.html.

Export Logs for Tickets

Perform the following steps to export logs:

  1. Click Share from the top menu bar.
  2. Select the CSV Reports option.
  3. Click Generate CSV button.