Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 5.3 KB

code.md

File metadata and controls

47 lines (36 loc) · 5.3 KB

Code

Code Attributes

These attributes provide context about source code

Attribute Type Description Examples Stability
code.column.number int 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. 16 Stable
code.file.path string 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. /usr/local/MyApplication/content_root/app/index.php Stable
code.function.name string 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. [1] com.example.MyHttpService.serveRequest; GuzzleHttp\Client::transfer; fopen Stable
code.line.number int 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. 42 Stable
code.stacktrace string 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. at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5) Stable

[1] code.function.name: 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

Deprecated Code Attributes

These deprecated attributes provide context about source code

Attribute Type Description Examples Stability
code.column int Deprecated, use code.column.number 16 Deprecated
Replaced by code.column.number
code.filepath string Deprecated, use code.file.path instead /usr/local/MyApplication/content_root/app/index.php Deprecated
Replaced by code.file.path
code.function string Deprecated, use code.function.name instead serveRequest Deprecated
Replaced by code.function.name
code.lineno int Deprecated, use code.line.number instead 42 Deprecated
Replaced by code.line.number
code.namespace string Deprecated, namespace is now included into code.function.name com.example.MyHttpService Deprecated
Value should be included in code.function.name which is expected to be a fully-qualified name.