Package com.amazonaws.xray.plugins

Class EKSPlugin

java.lang.Object
com.amazonaws.xray.plugins.EKSPlugin
All Implemented Interfaces:
Plugin
public class EKSPlugin extends Object implements Plugin
A plugin, for use with the AWSXRayRecorderBuilder class, which will add Kubernetes metadata to segments. If the cluster uses ContainerInsights this plugin will extract log configuration information.
See Also:

  • Field Details

  • Constructor Details

    • EKSPlugin

      public EKSPlugin()
      Constructs an empty EKS plugin. The cluster name, along with other metadata, will be retrieved from the Container Insights endpoint automatically.

    • EKSPlugin

      public EKSPlugin(@Nullable String clusterName)
      Constructs an EKS plugin with a given cluster name.
      Parameters:
      clusterName - the EKS cluster name

  • Method Details

    • 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

    • getLogReferences

      public Set<AWSLogReference> getLogReferences()
      Specified by:
      getLogReferences in interface Plugin

    • getServiceName

      public String getServiceName()
      Specified by:
      getServiceName in interface Plugin

    • getRuntimeContext

      public Map<String,@Nullable Object> getRuntimeContext()
      Specified by:
      getRuntimeContext in interface Plugin

    • populateRuntimeContext

      public void populateRuntimeContext()
      Generate runtime context with pod metadata from K8s.

    • 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