Package co.elastic.apm.api

Annotation Type Traced

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

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

When there is no current span, a Transaction will be created instead.

Use this annotation over CaptureSpan or CaptureTransaction if a method can both be an entry point (a Transaction) or a unit of work within a transaction (a Span).

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
String	action	Sets the action of the captured span, used to group similar spans together, for example: `query`.
boolean	asExit	Makes the captured span captured as an "exit span".
boolean	discardable	By default, spans are discardable.
String	subtype	Sets the subtype of the captured span, used to group similar spans together, for example: `mysql`.
String	type	Sets the general type of the captured span or transaction, used to group similar spans together, for example: `db`.
String	value	The name of the Span or Transaction.

Element Details

value

String value

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

Default:

""

type

String type

Sets the general type of the captured span or transaction, 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`.

Defaults to request for transactions and app for spans

Default:

""

subtype

String subtype

Sets the subtype of the captured span, used to group similar spans together, for example: `mysql`.

NOTE: has no effect when a transaction is created

Default:

""

action

String action

Sets the action of the captured span, used to group similar spans together, for example: `query`.

NOTE: has no effect when a transaction is created

Default:

""

discardable

boolean discardable

By default, spans are discardable. This attribute is only relevant if the annotated method results with a span. In some cases, spans may be discarded, for example if span_min_duration config option is set and the span does not exceed the configured threshold. Set this attribute to false to make the current span non-discardable.

NOTE: making a span non-discardable implicitly makes the entire stack of active spans non-discardable as well. Child spans can still be discarded.

Default:

true

asExit

boolean asExit

Makes the captured span captured as an "exit span".

NOTE: has no effect when a transaction is created

Default:

false