Package co.elastic.apm.api

Annotation Type CaptureSpan

public @interface CaptureSpan

Annotating a method with @CaptureSpan creates a Span as the child of the currently active span or transaction (ElasticApm.currentSpan()).

When there is no current span, no span will be created.

Note: it is required to configure the application_packages, otherwise this annotation will be ignored.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
java.lang.String	action	Sets the action of the captured span, used to group similar spans together, for example: `query`.
java.lang.String	subtype	Sets the subtype of the captured span, used to group similar spans together, for example: `mysql`.
java.lang.String	type	Sets the general type of the captured span, used to group similar spans together, for example: `db`.
java.lang.String	value	The name of the Span.

Element Detail

value

java.lang.String value

The name of the Span. Defaults to the ClassName#methodName

Default:

""

type

java.lang.String type

Sets the general type of the captured span, used to group similar spans together, for example: `db`. Though there are no naming restrictions for the general types, the following are standardized across all Elastic APM agents: `app`, `db`, `cache`, `template`, and `ext`.

Prior to version 1.4, the typing system was hierarchical. For instance, all spans of MySQL queries were given the type `db.mysql.query`. This is deprecated now and '.' (dot) character will not be allowed starting version 2.0. To get better span aggregation capabilities, use the subtype() and action() in combination with type.

Default:

"app"

subtype

java.lang.String subtype

Sets the subtype of the captured span, used to group similar spans together, for example: `mysql`. NOTE: current users of the hierarchical typing system are advised to use the second part of the type as subtype starting 1.4. For example, if used `external.http.okhttp` before 1.4, set `okhttp` as subtype.

Default:

""

action

java.lang.String action

Sets the action of the captured span, used to group similar spans together, for example: `query`. NOTE: current users of the hierarchical typing system are advised to use the third part of the type as action starting 1.4. For example, if used `template.jsf.render` before 1.4, set `render` as action.

Default:

""