Package com.amazonaws.xray.plugins

Class ECSPlugin

java.lang.Object

com.amazonaws.xray.plugins.ECSPlugin

All Implemented Interfaces:

Plugin

public class ECSPlugin
extends Object
implements Plugin

A plugin, for use with the AWSXRayRecorderBuilder class, which will add ECS container information to segments generated by the built AWSXRayRecorder instance.

See Also:

• AWSXRayRecorderBuilder.withPlugin(Plugin)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORIGIN

Constructor Summary

Constructors

Constructor	Description
ECSPlugin()

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)	Determine equality of plugins using origin to uniquely identify them
Set<AWSLogReference>	getLogReferences()
String	getOrigin()	Returns the name of the origin associated with this plugin.
Map<String,@Nullable Object>	getRuntimeContext()
String	getServiceName()
int	hashCode()	Hash plugin object using origin to uniquely identify them
boolean	isEnabled()	Returns true if the environment variable added by ECS is present and contains a valid URI
void	populateRuntimeContext()

Methods inherited from class java.lang.Object

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

Field Details

ORIGIN

public static final String ORIGIN

See Also:

• Constant Field Values

Constructor Details

ECSPlugin

public ECSPlugin()

Method Details

isEnabled

public boolean isEnabled()

Returns true if the environment variable added by ECS is present and contains a valid URI

Specified by:

isEnabled in interface Plugin

Returns:

true if an environment inspection determines X-Ray is operating in the correct environment for this plugin OR if X-Ray cannot accurately determine if it's in this plugin's environment

getServiceName

public String getServiceName()

Specified by:

getServiceName in interface Plugin

populateRuntimeContext

public void populateRuntimeContext()

getRuntimeContext

public Map<String,@Nullable Object> getRuntimeContext()

Specified by:

getRuntimeContext in interface Plugin

getLogReferences

public Set<AWSLogReference> getLogReferences()

Specified by:

getLogReferences in interface Plugin

getOrigin

public String getOrigin()

Description copied from interface: Plugin

Returns the name of the origin associated with this plugin. The AWSXRayRecorder contains a prioritized list of origins from least to most specific.

Specified by:

getOrigin in interface Plugin

Returns:

the name of the origin associated with this plugin.

equals

public boolean equals(@Nullable Object o)

Determine equality of plugins using origin to uniquely identify them

Overrides:

equals in class Object

hashCode

public int hashCode()

Hash plugin object using origin to uniquely identify them

Overrides:

hashCode in class Object