semantic-conventions/model/trace/general.yaml

253 lines
8.6 KiB
YAML

groups:
- id: network-core
prefix: network
type: attribute_group
brief: >
These attributes may be used for any network related operation.
attributes:
- id: transport
type:
allow_custom_values: true
members:
- id: tcp
value: 'tcp'
brief: "TCP"
- id: udp
value: 'udp'
brief: "UDP"
- id: pipe
value: "pipe"
brief: 'Named or anonymous pipe. See note below.'
- id: unix
value: 'unix'
brief: "Unix domain socket"
brief: >
[OSI Transport Layer](https://osi-model.com/transport-layer/) or
[Inter-process Communication method](https://en.wikipedia.org/wiki/Inter-process_communication).
The value SHOULD be normalized to lowercase.
examples: ['tcp', 'udp']
- id: type
type:
allow_custom_values: true
members:
- id: ipv4
value: 'ipv4'
brief: "IPv4"
- id: ipv6
value: 'ipv6'
brief: "IPv6"
brief: >
[OSI Network Layer](https://osi-model.com/network-layer/) or non-OSI equivalent.
The value SHOULD be normalized to lowercase.
examples: ['ipv4', 'ipv6']
- id: protocol.name
type: string
brief: >
[OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent.
The value SHOULD be normalized to lowercase.
examples: ['amqp', 'http', 'mqtt']
- id: protocol.version
type: string
brief: 'Version of the application layer protocol used. See note below.'
examples: '3.1.1'
note: >
`network.protocol.version` refers to the version of the protocol used and might be
different from the protocol client's version. If the HTTP client used has a version
of `0.27.2`, but sends HTTP version `1.1`, this attribute should be set to `1.1`.
- id: network-connection-and-carrier
prefix: network
type: attribute_group
brief: >
These attributes may be used for any network related operation.
attributes:
- id: connection.type
type:
allow_custom_values: true
members:
- id: wifi
value: "wifi"
- id: wired
value: "wired"
- id: cell
value: "cell"
- id: unavailable
value: "unavailable"
- id: unknown
value: "unknown"
brief: 'The internet connection type.'
examples: 'wifi'
- id: connection.subtype
type:
allow_custom_values: true
members:
- id: gprs
brief: GPRS
value: "gprs"
- id: edge
brief: EDGE
value: "edge"
- id: umts
brief: UMTS
value: "umts"
- id: cdma
brief: CDMA
value: "cdma"
- id: evdo_0
brief: EVDO Rel. 0
value: "evdo_0"
- id: evdo_a
brief: "EVDO Rev. A"
value: "evdo_a"
- id: cdma2000_1xrtt
brief: CDMA2000 1XRTT
value: "cdma2000_1xrtt"
- id: hsdpa
brief: HSDPA
value: "hsdpa"
- id: hsupa
brief: HSUPA
value: "hsupa"
- id: hspa
brief: HSPA
value: "hspa"
- id: iden
brief: IDEN
value: "iden"
- id: evdo_b
brief: "EVDO Rev. B"
value: "evdo_b"
- id: lte
brief: LTE
value: "lte"
- id: ehrpd
brief: EHRPD
value: "ehrpd"
- id: hspap
brief: HSPAP
value: "hspap"
- id: gsm
brief: GSM
value: "gsm"
- id: td_scdma
brief: TD-SCDMA
value: "td_scdma"
- id: iwlan
brief: IWLAN
value: "iwlan"
- id: nr
brief: "5G NR (New Radio)"
value: "nr"
- id: nrnsa
brief: "5G NRNSA (New Radio Non-Standalone)"
value: "nrnsa"
- id: lte_ca
brief: LTE CA
value: "lte_ca"
brief: 'This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection.'
examples: 'LTE'
- id: carrier.name
type: string
brief: "The name of the mobile carrier."
examples: "sprint"
- id: carrier.mcc
type: string
brief: "The mobile carrier country code."
examples: "310"
- id: carrier.mnc
type: string
brief: "The mobile carrier network code."
examples: "001"
- id: carrier.icc
type: string
brief: "The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network."
examples: "DE"
- id: peer
prefix: peer
type: span
brief: "Operations that access some remote service."
attributes:
- id: service
type: string
brief: >
The [`service.name`](/docs/resource/README.md#service)
of the remote service. SHOULD be equal to the actual `service.name`
resource attribute of the remote service if any.
examples: "AuthTokenCache"
- id: identity
prefix: enduser
type: span
brief: >
These attributes may be used for any operation with an authenticated and/or authorized enduser.
attributes:
- id: id
type: string
brief: >
Username or client_id extracted from the access token or
[Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)
header in the inbound request from outside the system.
examples: 'username'
- id: role
type: string
brief: 'Actual/assumed role the client is making the request under extracted from token or application security context.'
examples: 'admin'
- id: scope
type: string
brief: >
Scopes or granted authorities the client currently possesses extracted from token
or application security context. The value would come from the scope associated
with an [OAuth 2.0 Access Token](https://tools.ietf.org/html/rfc6749#section-3.3)
or an attribute value in a [SAML 2.0 Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html).
examples: 'read:message, write:files'
- id: thread
prefix: thread
type: span
brief: >
These attributes may be used for any operation to store information about a thread that started a span.
attributes:
- id: id
type: int
brief: >
Current "managed" thread ID (as opposed to OS thread ID).
examples: 42
- id: name
type: string
brief: >
Current thread name.
examples: main
- id: daemon
brief: "Whether the thread is daemon or not."
type: boolean
- id: code
prefix: code
type: span
brief: >
These attributes allow to report this unit of code and therefore to provide more context about the span.
attributes:
- id: function
type: string
brief: >
The method or function name, or equivalent (usually rightmost part of the code unit's name).
examples: serveRequest
- id: namespace
type: string
brief: >
The "namespace" within which `code.function` is defined. Usually the qualified class or module name,
such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit.
examples: com.example.MyHttpService
- id: filepath
type: string
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: lineno
type: int
brief: >
The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
examples: 42
- id: column
type: int
brief: >
The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
examples: 16