Package com.amazonaws.xray.plugins

Class ElasticBeanstalkPlugin

java.lang.Object

com.amazonaws.xray.plugins.ElasticBeanstalkPlugin

All Implemented Interfaces:

Plugin

public class ElasticBeanstalkPlugin
extends Object
implements Plugin

A plugin, for use with the AWSXRayRecorderBuilder class, which will add Elastic Beanstalk environment 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
ElasticBeanstalkPlugin()

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)	Determine equality of plugins using origin to uniquely identify them
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()
void	populateRuntimeContext()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.xray.plugins.Plugin

getLogReferences

Field Details

ORIGIN

public static final String ORIGIN

See Also:

• Constant Field Values

Constructor Details

ElasticBeanstalkPlugin

public ElasticBeanstalkPlugin()

Method Details

getServiceName

public String getServiceName()

Specified by:

getServiceName in interface Plugin

isEnabled

public boolean isEnabled()

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

populateRuntimeContext

public void populateRuntimeContext()

getRuntimeContext

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

Specified by:

getRuntimeContext 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