Package io.honeycomb.beeline.spring.beans.aspects

Class SpanAspect

java.lang.Object

io.honeycomb.beeline.spring.beans.aspects.SpanAspect

All Implemented Interfaces:

BeelineInstrumentation

public class SpanAspect
extends Object
implements BeelineInstrumentation

An aspect that allows declarative creation of child Spans in a Beeline-instrumented Spring application.

This Aspect will apply to any method of a Spring Bean that is annotated with ChildSpan and optionally has SpanField annotations on parameters.

More details on the javadoc of each annotation.

Constructor Summary

Constructors

Constructor	Description
SpanAspect(Tracer tracer)

Method Summary

Modifier and Type	Method	Description
Object	around(org.aspectj.lang.ProceedingJoinPoint joinPoint, ChildSpan span)
protected String	determineParameterFieldName(Parameter parameter, int parameterIndex, SpanField fieldAnnotation)	A parameter is captured and added as a Span field if annotated with SpanField.
protected String	determineSpanName(org.aspectj.lang.ProceedingJoinPoint joinPoint, ChildSpan span)
String	getName()	A simple human-readable name to identify a particular instrumentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanAspect

public SpanAspect(Tracer tracer)

Method Detail

getName

public String getName()

Description copied from interface: BeelineInstrumentation

A simple human-readable name to identify a particular instrumentation.

Specified by:

getName in interface BeelineInstrumentation

Returns:

the name.

around

public Object around(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                     ChildSpan span)
              throws Throwable

Throws:

Throwable

determineSpanName

protected String determineSpanName(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                                   ChildSpan span)

determineParameterFieldName

protected String determineParameterFieldName(Parameter parameter,
                                             int parameterIndex,
                                             SpanField fieldAnnotation)

A parameter is captured and added as a Span field if annotated with SpanField. The field name is derived based on on the following order:

1. A user-supplied parameter name (via SpanField.name() or SpanField.value()).
2. With the prefix, use the parameter name as determined via reflection, which depends on the code having been compiled with the -parameters option.
3. With the prefix, use the parameter's index within the parameters list.

Parameters:

parameter - to inspect.

parameterIndex - showing position of the parameter in the list of parameters.

fieldAnnotation - to inspect.

Returns:

the resolved field name.