Interface SegmentDecorator

All Known Implementing Classes:
AbstractHttpSegmentDecorator, AbstractInternalSegmentDecorator, AbstractMessagingSegmentDecorator, AbstractSegmentDecorator, AhcSegmentDecorator, AmqpSegmentDecorator, CometdSegmentDecorator, CometdsSegmentDecorator, CqlSegmentDecorator, DirectSegmentDecorator, DisruptorSegmentDecorator, DisruptorvmSegmentDecorator, ElasticsearchSegmentDecorator, HttpSegmentDecorator, IronmqSegmentDecorator, JdbcSegmentDecorator, JettySegmentDecorator, JmsSegmentDecorator, KafkaSegmentDecorator, LogSegmentDecorator, MongoDBSegmentDecorator, NettyHttpSegmentDecorator, PahoSegmentDecorator, RestSegmentDecorator, SedaSegmentDecorator, ServletSegmentDecorator, SjmsSegmentDecorator, SqlSegmentDecorator, StompSegmentDecorator, TimerSegmentDecorator, UndertowSegmentDecorator, VmSegmentDecorator

public interface SegmentDecorator
This interface represents a decorator specific to the component/endpoint being instrumented.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final SegmentDecorator
     
  • Method Summary

    Modifier and Type
    Method
    Description
    The camel component associated with the decorator.
    getOperationName(org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint)
    This method returns the operation name to use with the segment representing this exchange and endpoint.
    boolean
    This method indicates whether the component associated with the SegmentDecorator should result in a new segment being created.
    void
    post(com.amazonaws.xray.entities.Entity segment, org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint)
    This method adds appropriate details (tags/logs) to the supplied segment based on the post processing of the exchange.
    void
    pre(com.amazonaws.xray.entities.Entity segment, org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint)
    This method adds appropriate details (tags/logs) to the supplied segment based on the pre processing of the exchange.
  • Field Details

  • Method Details

    • newSegment

      boolean newSegment()
      This method indicates whether the component associated with the SegmentDecorator should result in a new segment being created.
      Returns:
      Whether a new segment should be created
    • getComponent

      String getComponent()
      The camel component associated with the decorator.
      Returns:
      The camel component name
    • getOperationName

      String getOperationName(org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint)
      This method returns the operation name to use with the segment representing this exchange and endpoint.
      Parameters:
      exchange - The exchange
      endpoint - The endpoint
      Returns:
      The operation name
    • pre

      void pre(com.amazonaws.xray.entities.Entity segment, org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint)
      This method adds appropriate details (tags/logs) to the supplied segment based on the pre processing of the exchange.
      Parameters:
      segment - The segment
      exchange - The exchange
      endpoint - The endpoint
    • post

      void post(com.amazonaws.xray.entities.Entity segment, org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint)
      This method adds appropriate details (tags/logs) to the supplied segment based on the post processing of the exchange.
      Parameters:
      segment - The segment
      exchange - The exchange
      endpoint - The endpoint