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

Annotation Type ChildSpan

@Target(METHOD)
@Retention(RUNTIME)
public @interface ChildSpan

In a Beeline-instrumented application, this annotation will apply SpanAspect to a Spring bean.

It provides a declarative way for creating child spans when calling an annotated method from another class. In doing so it measures the duration of the method call, captures info about the call site (such as the method name), and reports on any exceptions that may have been thrown (but does not swallow it).

The child span created by the Aspect can be further customised by this annotation's parameters. Additionally, if you are interested in capturing any method arguments, you can use SpanField in conjunction with this annotation. By default, no arguments will be captured.

Since Spring AOP uses a proxy mechanism, this will not work when calling the method from within the same class. For reference, "Understanding AOP Proxies explains this mechanism.

Example 1

 @ChildSpan
  public void doStuff(@SpanField final String id,
                      @SpanField final String name) {
      // the following returns the Span created by using the @ChildSpan annotation
      Span childSpan = beeline.getActiveSpan();
      // add more contextual info in addition to the captured arguments (see @SpanField)
      childSpan.addField(...);
  }
  

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	addResult	If set to true, the Aspect will capture the return value and add it as a field () to the Span.
String	name	Overrides the default name given to the operation covered by the child Span created by the Aspect.
String	value	Overrides the default name given to the operation covered by the child Span created by the Aspect.

Element Detail

value

@AliasFor("name")
String value

Overrides the default name given to the operation covered by the child Span created by the Aspect.

If no value is provided, the Aspect will fallback to using the method name (capitalized) instead.

This is an alias for name().

Returns:

explicit name of span

Default:

""

name

@AliasFor("value")
String name

Overrides the default name given to the operation covered by the child Span created by the Aspect.

If no value is provided, the Aspect will fallback to using the method name (capitalized) instead.

This is an alias for value().

Returns:

explicit name of span

Default:

""

addResult

boolean addResult

If set to true, the Aspect will capture the return value and add it as a field () to the Span.

Returns:

whether to add the result value

Default:

false