Preface

Purpose

This guide helps to use the tools that enable users to observe the Oracle Banking Microservices Architecture suite of products better.

The sections provide tools that can enable a user to:
  • Observe the spans associated with various API calls and the response of each API.
  • Troubleshoot Kafka better.
  • Aggregate logs and interpret out of log searches.

This guide also describes recommended tools to enhance monitoring and observability aspects of the Oracle Banking Microservices Architecture products.

Before You Begin

Kindly refer to the Getting Started User Guide for information on common functionalities like login, navigation, and general settings before proceeding with this guide.

Module Definitions

Table -1 Terms & Definitions

Terms Definitions
ELK/Elasticsearch open-source suite of tools used for log management, analysis, and visualization, and it can be integrated with FLEXCUBE to enhance its observability and troubleshooting capabilities.
Flyway A powerful database migration tool that simplifies managing and applying changes to your database schema.
Grafana A data visualization and monitoring tool.
Kibana A data visualization and exploration tool used for analyzing large datasets, often used with Elasticsearch.
Traces This functionality is used to track and analyze the flow of transactions and data within the system, providing insights into how specific operations are processed and where they originate.
Zipkin A distributed tracing system that helps analyze latency and errors in microservices architectures, and it can be used with Oracle FLEXCUBE for troubleshooting and performance monitoring.
schema The database schema that holds the application's data and metadata.

Module Pre-requisite

Specify User Id and Password, and login to the Home screen.

Audience

This guide is intended for the implementation teams.

Related Resources

The related documents are as follows:

  • Oracle Banking Getting Started User Guide
  • Troubleshooting Guide

Conventions

The following text conventions are used in this document:

Convention Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Acronyms and Abbreviations

The list of the acronyms and abbreviations that you are likely to find in the guide are as follows:

Table -2 Acronyms and Abbreviations

Abbreviation Description
API Application Programming Interface
ELK Elasticsearch Logstash Kibana
UI User Interface
URL Uniform Resource Locator

Prerequisites

The prerequisites are as follows:

  • Basic understanding of Eventing platform.
  • Basic understanding application log analysis using tools.
  • Basic understanding DB changes.

General Prevention

Do not make any changes to Flyway scripts manually.

Best Practices

The best practices are as follows:

  • It is ideal to have ELK stack installed on a separate VM outside the product VMs to ensure flow of logs in case of app crash.
  • Log levels can be adjusted to INFO and above to enable relevant logs to flow in.
  • Verify all Kafka settings as per User Troubleshooting Guide before the health check.

Module Post-requisite

After finishing all the requirements, log out from the Home screen.