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
      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 or transaction, used to group similar spans together, for example: `db`.
      java.lang.String value
      The name of the Span or Transaction.
    • Element Detail

      • value

        java.lang.String value
        The name of the Span or Transaction. Defaults to the ClassName#methodName
        Default:
        ""
      • type

        java.lang.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

        java.lang.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

        java.lang.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:
        ""