semantic-conventions/model/registry/log.yaml

73 lines
2.3 KiB
YAML

groups:
- id: registry.log
type: attribute_group
prefix: log
brief: >
This document defines log attributes
attributes:
- id: iostream
stability: experimental
brief: >
The stream associated with the log. See below for a list of well-known values.
type:
allow_custom_values: true
members:
- id: stdout
value: 'stdout'
brief: 'Logs from stdout stream'
stability: experimental
- id: stderr
value: 'stderr'
brief: 'Events from stderr stream'
stability: experimental
- id: registry.log.file # TODO: should we move it to the file model?
type: attribute_group
prefix: log.file
brief: >
Attributes for a file to which log was emitted.
attributes:
- id: name
type: string
stability: experimental
brief: >
The basename of the file.
examples: [ "audit.log" ]
- id: path
type: string
stability: experimental
brief: >
The full path to the file.
examples: [ "/var/log/mysql/audit.log" ]
- id: name_resolved
type: string
stability: experimental
brief: >
The basename of the file, with symlinks resolved.
examples: [ "uuid.log" ]
- id: path_resolved
type: string
stability: experimental
brief: >
The full path to the file, with symlinks resolved.
examples: [ "/var/lib/docker/uuid.log" ]
- id: registry.log.record
type: attribute_group
prefix: log.record
brief: >
This document defines the generic attributes that may be used in any Log Record.
attributes:
- id: uid
type: string
stability: experimental
brief: >
A unique identifier for the Log Record.
note: >
If an id is provided, other log records with the same id will be considered duplicates and can be removed safely.
This means, that two distinguishable log records MUST have different values.
The id MAY be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec),
but other identifiers (e.g. UUID) may be used as needed.
examples: ["01ARZ3NDEKTSV4RRFFQ69G5FAV"]