Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Commit

Permalink
Address PR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Tigran Najaryan committed Mar 25, 2020
1 parent b95bc8c commit 7db6fc6
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions text/0091-logs-vocabulary.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,30 +20,39 @@ A recording of an event. Typically the record includes a timestamp indicating
when the event happened as well as other data that describes what happened,
where it happened, etc.

### Embedded Log
Also known as Log Entry.

A log record embedded inside a [Span](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-tracing.md#span)
### Log

Sometimes used to refer to a collection of Log Records. May be ambiguous, since
people also sometimes use `Log` to refer to a single `Log Record`, thus this
term should be used carefully and in the context where ambiguity is possible
additional qualifiers should be used (e.g. `Log Record`).

### Embedded Log

`Log Records` embedded inside a [Span](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-tracing.md#span)
object, in the [Events](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-tracing.md#add-events) list.

### Standalone Log

A log record that is not embedded inside a Span and is recorded elsewhere.
`Log Records` that are not embedded inside a `Span` and are recorded elsewhere.

### Log Attributes

Key/value pairs contained in a Log Record.
Key/value pairs contained in a `Log Record`.

### Structured Logs

Logs that are recorded in a format that has a well-defined structure that allows
Logs that are recorded in a format which has a well-defined structure that allows
to differentiate between different elements of a Log Record (e.g. the Timestamp,
the Attributes, etc). For example [Syslog, RFC5425](https://tools.ietf.org/html/rfc5424)
protocol defines `structured-data` format.
the Attributes, etc). The _Syslog protocol_ ([RFC 5425](https://tools.ietf.org/html/rfc5424)),
for example, defines a `structured-data` format.

### Flat File Logs

Logs recorded in text files, often one line per log record (although multiline
records are possible too). There is no common industry agreement whether
logs written to text files in more structured formats (e.g. JSON files)
are considered Flat File Logs or no. Where such distinction is important it is
are considered Flat File Logs or not. Where such distinction is important it is
recommended to call it out specifically.

0 comments on commit 7db6fc6

Please sign in to comment.