org.ballerinalang.util.observability

Class ObservabilityUtils

java.lang.Object

org.ballerinalang.util.observability.ObservabilityUtils

public class ObservabilityUtils
extends Object

Utility methods to start server/client observation.

Constructor Summary

Constructors

Constructor and Description
ObservabilityUtils()

Method Summary

Modifier and Type	Method and Description
static void	addObserver(BallerinaObserver observer) Adds a BallerinaObserver to a collection of observers that will be notified on events.
static void	continueClientObservation(ObserverContext observerContext, WorkerExecutionContext parentCtx) Continue client observation if the startClientObservation(String, String, WorkerExecutionContext) was called without WorkerExecutionContext.
static void	continueServerObservation(ObserverContext observerContext, WorkerExecutionContext parentCtx) Continue server observation if the startServerObservation(String, String, String, WorkerExecutionContext) was called without WorkerExecutionContext.
static Map<String,String>	getContextProperties(ObserverContext observerContext)
static Optional<ObserverContext>	getParentContext(Context context)
static boolean	isObservabilityEnabled()
static void	removeObserver(BallerinaObserver observer) Removes a BallerinaObserver from the collection of observers.
static void	setObserverContextToWorkerExecutionContext(WorkerExecutionContext workerExecutionContext, ObserverContext observerContext)
static Optional<ObserverContext>	startClientObservation(String connectorName, String actionName, WorkerExecutionContext parentCtx) Start a client observation.
static Optional<ObserverContext>	startServerObservation(String connectorName, String serviceName, String resourceName, WorkerExecutionContext parentContext) Start a server observation.
static void	stopObservation(ObserverContext observerContext) Stop server or client observation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObservabilityUtils

public ObservabilityUtils()

Method Detail

isObservabilityEnabled

public static boolean isObservabilityEnabled()

Returns:

whether observability is enabled.

addObserver

public static void addObserver(BallerinaObserver observer)

Adds a BallerinaObserver to a collection of observers that will be notified on events.

Parameters:

observer - the observer that will be notified

removeObserver

public static void removeObserver(BallerinaObserver observer)

Removes a BallerinaObserver from the collection of observers.

Parameters:

observer - the observer that will be removed

startServerObservation

public static Optional<ObserverContext> startServerObservation(String connectorName,
                                                               String serviceName,
                                                               String resourceName,
                                                               WorkerExecutionContext parentContext)

Start a server observation.

Parameters:

connectorName - The server connector name.

serviceName - The service name.

resourceName - The resource name.

parentContext - The WorkerExecutionContext instance. If this is null when starting the observation, the continueServerObservation(ObserverContext, WorkerExecutionContext) method must be called later with relevant ObserverContext

Returns:

An Optional ObserverContext instance.

startClientObservation

public static Optional<ObserverContext> startClientObservation(String connectorName,
                                                               String actionName,
                                                               WorkerExecutionContext parentCtx)

Start a client observation.

Parameters:

connectorName - The connector name.

actionName - The action name.

parentCtx - The WorkerExecutionContext instance. If this is null when starting the observation, the continueClientObservation(ObserverContext, WorkerExecutionContext) method must be called later with relevant ObserverContext

Returns:

An Optional of ObserverContext instance.

continueServerObservation

public static void continueServerObservation(ObserverContext observerContext,
                                             WorkerExecutionContext parentCtx)

Continue server observation if the startServerObservation(String, String, String, WorkerExecutionContext) was called without WorkerExecutionContext.

Parameters:

observerContext - The ObserverContext instance.

parentCtx - The parent WorkerExecutionContext instance.

continueClientObservation

public static void continueClientObservation(ObserverContext observerContext,
                                             WorkerExecutionContext parentCtx)

Continue client observation if the startClientObservation(String, String, WorkerExecutionContext) was called without WorkerExecutionContext.

Parameters:

observerContext - The ObserverContext instance.

parentCtx - The WorkerExecutionContext instance.

stopObservation

public static void stopObservation(ObserverContext observerContext)

Stop server or client observation.

Parameters:

observerContext - The ObserverContext instance.

getParentContext

public static Optional<ObserverContext> getParentContext(Context context)

Parameters:

context - The Context instance.

Returns:

the parent ObserverContext or a new ObserverContext depending on whether observability is enabled or not.

getContextProperties

public static Map<String,String> getContextProperties(ObserverContext observerContext)

setObserverContextToWorkerExecutionContext

public static void setObserverContextToWorkerExecutionContext(WorkerExecutionContext workerExecutionContext,
                                                              ObserverContext observerContext)