semantic-conventions/model/code/registry.yaml

49 lines
2.1 KiB
YAML

groups:
- id: registry.code
type: attribute_group
display_name: Code Attributes
brief: >
These attributes provide context about source code
attributes:
- id: code.function.name
type: string
stability: experimental
brief: >
The method or function name, or equivalent (usually rightmost part of the code unit's name).
examples: serveRequest
- id: code.namespace
type: string
stability: experimental
brief: >
The "namespace" within which `code.function.name` is defined. Usually the qualified class or module name,
such that `code.namespace` + some separator + `code.function.name` form a unique identifier for the code unit.
examples: com.example.MyHttpService
- id: code.file.path
type: string
stability: experimental
brief: >
The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
examples: /usr/local/MyApplication/content_root/app/index.php
- id: code.line.number
type: int
stability: experimental
brief: >
The line number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`.
examples: 42
- id: code.column.number
type: int
stability: experimental
brief: >
The column number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`.
examples: 16
- id: code.stacktrace
type: string
stability: experimental
brief: >
A stacktrace as a string in the natural representation for the language runtime.
The representation is to be determined and documented by each language SIG.
examples: >
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)