Copyright 2017-2019 Schlumberger

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Introduction

This repository houses code that is used across the Microsoft Azure hosted OSDU and OpenDES platforms. The intention of this repository is to minimize code duplication for common scenarios such as dependency configuration for services in Azure (KeyVault, Cosmos, Storage and others).

Pre-requisites

You need

1. Maven 3.6.x
2. Java 1.8

Local Usage

# Compile the codebase
$ mvn compile
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
...

# Unit test the codebase
$ mvn test
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
...

Getting started guide

##Installation

You need to connect to our feed on Azure DevOps and add the artifact core-lib-azure as a dependency to your Maven or Gradle build.

Example

<project>
    <properties>
        <azure.corelib.version>0.0.1</azure.corelib.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.opengroup.osdu</groupId>
            <artifactId>core-lib-azure</artifactId>
            <version>${azure.corelib.version}</version>
        </dependency>
    </dependencies>
</project>

Changes to support newly Added transaction logger and slf4jlogger

The consumer service might run into multiple logger bindings error on start up which can be fixed by excluding some of the logger dependencies.

Note: Below are reference PRs for exclusion and might change from service to service

Refer this MR as reference on how to exclude dependencies along with how to enable the Enabled transaction logger and slf4jlogger

Environment variables to be added in application.properties to consume the TenantFactoryImpl

Settings to be added in application.properties to consume the BlobStore

Default retry and timeout values for service-to-service communication

CircuitBreaker configuration

To enable circuitbreaker, set azure.circuitbreaker.enable=true in application.properties

To read more about Circuitbreaker, please refer to https://resilience4j.readme.io/docs/circuitbreaker

CircuitBreaker Functioning

The basic idea behind the circuit breaker is very simple. You wrap a protected function call in a circuit breaker object, which monitors for failures. Once the failures reach a certain threshold, the circuit breaker trips, and all further calls to the circuit breaker return with an error, without the protected call being made at all.

All HTTP calls made by services will go through the circuitbreaker. If circuitbreaker detects failures and it crosses threshold, The APIs will start throwing Error 500 : Service Unavailable. The circuit will be open for a certain duration and then move to half open state. It will then assess whether to move to a closed state or open state. The diagram below depicts the state diagram for circuitbreaker.

[Credits : Martin Fowler(https://martinfowler.com/bliki/CircuitBreaker.html)]