1. Observability User Guide
  2. Preface

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.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Oracle is fully committed to diversity and inclusion. Oracle respects and values having a diverse workforce that increases thought leadership and innovation. As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation. We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve. Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.

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 -1 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.