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.

Audience

This guide is intended for the implementation teams.

Acronyms and Abbreviations

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

Table -1 Acronyms and Abbreviations

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

List of Topics

This guide is organized as follows:

Topics	Description
Observability Improvements using Zipkin Traces	This topic provides the information about observability improvements using Zipkin traces.
Observability Improvements Logs using ELK Stack	This topic provides the information about observability improvements logs using ELK stack.
Health Checks	This topic explains the possible approaches to monitor health of Oracle Banking Microservices Architecture services.
Troubleshooting Kafka Issues	This topic provides the information about troubleshooting Kafka issues.
Troubleshooting Flyway Issues	This topic provides the information about troubleshooting flyway issues.

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.