Package io.opentelemetry.semconv

Class CodeAttributes

java.lang.Object
io.opentelemetry.semconv.CodeAttributes
public final class CodeAttributes extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.opentelemetry.api.common.AttributeKey<Long>
    CODE_COLUMN_NUMBER
    The column number in code.file.path best representing the operation.
    static final io.opentelemetry.api.common.AttributeKey<String>
    CODE_FILE_PATH
    The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
    static final io.opentelemetry.api.common.AttributeKey<String>
    CODE_FUNCTION_NAME
    The method or function fully-qualified name without arguments.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    CODE_LINE_NUMBER
    The line number in code.file.path best representing the operation.
    static final io.opentelemetry.api.common.AttributeKey<String>
    CODE_STACKTRACE
    A stacktrace as a string in the natural representation for the language runtime.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • CODE_COLUMN_NUMBER

      public static final io.opentelemetry.api.common.AttributeKey<Long> CODE_COLUMN_NUMBER
      The column number in code.file.path best representing the operation. It SHOULD point within the code unit named in code.function.name. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity.

    • CODE_FILE_PATH

      public static final io.opentelemetry.api.common.AttributeKey<String> CODE_FILE_PATH
      The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.

    • CODE_FUNCTION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> CODE_FUNCTION_NAME
      The method or function fully-qualified name without arguments. The value should fit the natural representation of the language runtime, which is also likely the same used within code.stacktrace attribute value. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.

      Notes:

      Values and format depends on each language runtime, thus it is impossible to provide an exhaustive list of examples. The values are usually the same (or prefixes of) the ones found in native stack trace representation stored in code.stacktrace without information on arguments.

      Examples:

      • Java method: com.example.MyHttpService.serveRequest
      • Java anonymous class method: com.mycompany.Main$1.myMethod
      • Java lambda method: com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod
      • PHP function: GuzzleHttp\Client::transfer
      • Go function: github.com/my/repo/pkg.foo.func5
      • Elixir: OpenTelemetry.Ctx.new
      • Erlang: opentelemetry_ctx:new
      • Rust: playground::my_module::my_cool_func
      • C function: fopen

    • CODE_LINE_NUMBER

      public static final io.opentelemetry.api.common.AttributeKey<Long> CODE_LINE_NUMBER
      The line number in code.file.path best representing the operation. It SHOULD point within the code unit named in code.function.name. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity.

    • CODE_STACKTRACE

      public static final io.opentelemetry.api.common.AttributeKey<String> CODE_STACKTRACE
      A stacktrace as a string in the natural representation for the language runtime. The representation is identical to exception.stacktrace. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain data integrity.