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, String connectorName, String actionName, WorkerExecutionContext executionContext) Continue client observation if the startClientObservation(String, String, WorkerExecutionContext) was called without WorkerExecutionContext.
static void	continueServerObservation(ObserverContext observerContext, String serviceName, String resourceName, WorkerExecutionContext executionContext) Continue server observation if the startServerObservation(String, String, String, WorkerExecutionContext) was called without WorkerExecutionContext.
static ObserverContext	getCurrentContext(WorkerExecutionContext executionContext) Get an ObserverContext for current WorkerExecutionContext.
static Map<String,String>	getTraceContext() Get the get the trace context of the parent span.
static void	removeObserver(BallerinaObserver observer) Removes a BallerinaObserver from the collection of observers.
static ObserverContext	startClientObservation(String connectorName, String actionName, WorkerExecutionContext executionContext) Start a client observation.
static ObserverContext	startServerObservation(String connectorName, String serviceName, String resourceName, WorkerExecutionContext executionContext) Start a server observation.
static void	stopObservation(WorkerExecutionContext executionContext) 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

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 ObserverContext startServerObservation(String connectorName,
                                                     String serviceName,
                                                     String resourceName,
                                                     WorkerExecutionContext executionContext)

Start a server observation.

Parameters:

connectorName - The server connector name.

serviceName - The service name.

resourceName - The resource name.

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

Returns:

An ObserverContext instance.

startClientObservation

public static ObserverContext startClientObservation(String connectorName,
                                                     String actionName,
                                                     WorkerExecutionContext executionContext)

Start a client observation.

Parameters:

connectorName - The connector name.

actionName - The action name.

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

Returns:

An ObserverContext instance.

continueServerObservation

public static void continueServerObservation(ObserverContext observerContext,
                                             String serviceName,
                                             String resourceName,
                                             WorkerExecutionContext executionContext)

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

Parameters:

observerContext - The ObserverContext instance.

serviceName - The service name.

resourceName - The resource name.

executionContext - The WorkerExecutionContext instance.

continueClientObservation

public static void continueClientObservation(ObserverContext observerContext,
                                             String connectorName,
                                             String actionName,
                                             WorkerExecutionContext executionContext)

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

Parameters:

observerContext - The ObserverContext instance.

connectorName - The connector name.

actionName - The resource name.

executionContext - The WorkerExecutionContext instance.

stopObservation

public static void stopObservation(WorkerExecutionContext executionContext)

Stop server or client observation.

Parameters:

executionContext - The WorkerExecutionContext instance.

getCurrentContext

public static ObserverContext getCurrentContext(WorkerExecutionContext executionContext)

Get an ObserverContext for current WorkerExecutionContext.

Parameters:

executionContext - The WorkerExecutionContext instance.

Returns:

An existing ObserverContext instance or a new one created for current WorkerExecutionContext.

getTraceContext

public static Map<String,String> getTraceContext()

Get the get the trace context of the parent span.

Returns:

Map of trace context.