View Source OpenTelemetry.SemConv.Incubating.LogAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Log attributes.

Summary

Types

The stream associated with the log. See below for a list of well-known values.

Functions

The basename of the file.

The basename of the file, with symlinks resolved.

The full path to the file.

The full path to the file, with symlinks resolved.

The stream associated with the log. See below for a list of well-known values.

The complete orignal Log Record.

A unique identifier for the Log Record.

Types

@type log_iostream_values() :: %{stdout: :stdout, stderr: :stderr}

The stream associated with the log. See below for a list of well-known values.

Enum Values

  • :stdout e - Logs from stdout stream
  • :stderr e - Events from stderr stream

Functions

@spec log_file_name() :: :"log.file.name"

The basename of the file.

Value type

Value must be of type atom() | String.t().

Examples

["audit.log"]
iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_file_name()
:"log.file.name"
Link to this function

log_file_name_resolved()

View Source
@spec log_file_name_resolved() :: :"log.file.name_resolved"

The basename of the file, with symlinks resolved.

Value type

Value must be of type atom() | String.t().

Examples

["uuid.log"]
iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_file_name_resolved()
:"log.file.name_resolved"
@spec log_file_path() :: :"log.file.path"

The full path to the file.

Value type

Value must be of type atom() | String.t().

Examples

["/var/log/mysql/audit.log"]
iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_file_path()
:"log.file.path"
Link to this function

log_file_path_resolved()

View Source
@spec log_file_path_resolved() :: :"log.file.path_resolved"

The full path to the file, with symlinks resolved.

Value type

Value must be of type atom() | String.t().

Examples

["/var/lib/docker/uuid.log"]
iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_file_path_resolved()
:"log.file.path_resolved"
@spec log_iostream() :: :"log.iostream"

The stream associated with the log. See below for a list of well-known values.

iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_iostream()
:"log.iostream"

iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_iostream_values().stdout
:stdout

iex> %{OpenTelemetry.SemConv.Incubating.LogAttributes.log_iostream() => OpenTelemetry.SemConv.Incubating.LogAttributes.log_iostream_values().stdout}
%{:"log.iostream" => :stdout}
@spec log_iostream_values() :: log_iostream_values()
@spec log_record_original() :: :"log.record.original"

The complete orignal Log Record.

Value type

Value must be of type atom() | String.t().

Notes

This value MAY be added when processing a Log Record which was originally transmitted as a string or equivalent data type AND the Body field of the Log Record does not contain the same value. (e.g. a syslog or a log record read from a file.)

Examples

["77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - - Something happened", "[INFO] 8/3/24 12:34:56 Something happened"]
iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_record_original()
:"log.record.original"
@spec log_record_uid() :: :"log.record.uid"

A unique identifier for the Log Record.

Value type

Value must be of type atom() | String.t().

Notes

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), but other identifiers (e.g. UUID) may be used as needed.

Examples

["01ARZ3NDEKTSV4RRFFQ69G5FAV"]
iex> OpenTelemetry.SemConv.Incubating.LogAttributes.log_record_uid()
:"log.record.uid"