semantic-conventions/docs/code

Semantic conventions for code

Status: Release Candidate

This document defines semantic conventions for source code.

Warning

Existing code instrumentations that are using v1.29.0 of code conventions (or prior):

• SHOULD NOT change the version of the code conventions that they emit by default until the code semantic conventions are marked stable.

Attributes

Attribute	Type	Description	Examples	Requirement Level	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	Recommended
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	Recommended
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	Recommended
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	Recommended
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)	Opt-In

[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