io.sphere.sdk.client.metrics

Class SimpleMetricsSphereClient

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.SphereClientDecorator

io.sphere.sdk.client.metrics.SimpleMetricsSphereClient

All Implemented Interfaces:

SphereClient, AutoCloseable

public final class SimpleMetricsSphereClient
extends SphereClientDecorator
implements SphereClient

A decorator for SphereClients which collects the time of serialization from and to JSON as well as the time waiting for the response from the Composable Commerce API.

import io.sphere.sdk.client.SphereClient;

import java.util.Observable;

import java.util.Observer;

public class SimpleMetricsSphereClientDemo {
    public static SphereClient demo(final SphereClient asyncClient) {
        final SimpleMetricsSphereClient simpleMetricsSphereClient = SimpleMetricsSphereClient.of(asyncClient);
        final Observable observable = simpleMetricsSphereClient.getMetricObservable();
        observable.addObserver(new LoggerObserver());//register once observer
        return simpleMetricsSphereClient;//use metric client wrapper instead of async client directly
/*
    logs something like:
    observed: ObservedSerializationDuration[requestId=1,durationInMilliseconds=0,request=ProjectGet[]]
    observed: ObservedDeserializationDuration[requestId=1,durationInMilliseconds=0,request=ProjectGet[]]
    observed: ObservedTotalDuration[requestId=1,durationInMilliseconds=19,request=ProjectGet[]]
*/
    }

    public static class LoggerObserver implements Observer {
        @Override
        public void update(final Observable o, final Object arg) {
            Logger.trace("observed: " + arg);
        }
    }
}
See the test code.

Method Summary

Modifier and Type	Method and Description
<T> CompletionStage<T>	execute(SphereRequest<T> sphereRequest) Executes asynchronously a request to Composable Commerce.
Observable	getMetricObservable() The observable where observers can be registered.
static SimpleMetricsSphereClient	of(SphereClient delegate)

Methods inherited from class io.sphere.sdk.client.SphereClientDecorator

close, getConfig

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.client.SphereClient

close, getConfig, of, of

Method Detail

of

public static SimpleMetricsSphereClient of(SphereClient delegate)

execute

public <T> CompletionStage<T> execute(SphereRequest<T> sphereRequest)

Description copied from interface: SphereClient

Executes asynchronously a request to Composable Commerce. By default it does not have a timeout.

Specified by:

execute in interface SphereClient

Overrides:

execute in class SphereClientDecorator

Type Parameters:

T - type of the result for the request

Parameters:

sphereRequest - request to Composable Commerce to perform

Returns:

future monad which can contain the result or an exception

getMetricObservable

public Observable getMetricObservable()

The observable where observers can be registered.

Returns:

observable