-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Joao Grassi <[email protected]>
- Loading branch information
1 parent
c8a1337
commit 7f6876d
Showing
9 changed files
with
143 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,6 +48,7 @@ body: | |
| - area:http | ||
| - area:ios | ||
| - area:k8s | ||
| - area:log | ||
| - area:messaging | ||
| - area:network | ||
| - area:oci | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,6 +41,7 @@ body: | |
| - area:http | ||
| - area:ios | ||
| - area:k8s | ||
| - area:log | ||
| - area:messaging | ||
| - area:network | ||
| - area:oci | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,6 +50,7 @@ body: | |
| - area:http | ||
| - area:ios | ||
| - area:k8s | ||
| - area:log | ||
| - area:messaging | ||
| - area:network | ||
| - area:oci | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| # Log | ||
|
|
||
| <!-- toc --> | ||
|
|
||
| - [Log Attributes](#log-attributes) | ||
| - [Generic log attributes](#generic-log-attributes) | ||
| - [File log attributes](#file-log-attributes) | ||
| - [Record log attributes](#record-log-attributes) | ||
|
|
||
| <!-- tocstop --> | ||
|
|
||
| ## Log Attributes | ||
|
|
||
| ### Generic log attributes | ||
|
|
||
| <!-- semconv registry.log(omit_requirement_level) --> | ||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | `log.iostream` | string | The stream associated with the log. See below for a list of well-known values. | `stdout` |  | | ||
|
|
||
| `log.iostream` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | ||
|
|
||
| | Value | Description | Stability | | ||
| |---|---|---| | ||
| | `stdout` | Logs from stdout stream |  | | ||
| | `stderr` | Events from stderr stream |  | | ||
| <!-- endsemconv --> | ||
|
|
||
| ### File log attributes | ||
|
|
||
| <!-- semconv registry.log.file(omit_requirement_level) --> | ||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | `log.file.name` | string | The basename of the file. | `audit.log` |  | | ||
| | `log.file.name_resolved` | string | The basename of the file, with symlinks resolved. | `uuid.log` |  | | ||
| | `log.file.path` | string | The full path to the file. | `/var/log/mysql/audit.log` |  | | ||
| | `log.file.path_resolved` | string | The full path to the file, with symlinks resolved. | `/var/lib/docker/uuid.log` |  | | ||
| <!-- endsemconv --> | ||
|
|
||
| ### Record log attributes | ||
|
|
||
| <!-- semconv registry.log.record(omit_requirement_level) --> | ||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | `log.record.uid` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` |  | | ||
|
|
||
| **[1]:** 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. | ||
| <!-- endsemconv --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,8 @@ | ||
| groups: | ||
| - id: log.record | ||
| prefix: log.record | ||
| type: attribute_group | ||
| brief: > | ||
| The attributes described in this section are rather generic. They may be used in any Log Record they apply to. | ||
| attributes: | ||
| - id: uid | ||
| type: string | ||
| stability: experimental | ||
| - ref: log.record.uid | ||
| requirement_level: opt_in | ||
| 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"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,21 @@ | ||
| groups: | ||
| - id: attributes.log | ||
| prefix: log | ||
| type: attribute_group | ||
| brief: "Describes Log attributes" | ||
| attributes: | ||
| - id: iostream | ||
| - ref: log.iostream | ||
| requirement_level: opt_in | ||
| stability: experimental | ||
| brief: > | ||
| The stream associated with the log. See below for a list of well-known values. | ||
| type: | ||
| allow_custom_values: false | ||
| members: | ||
| - id: stdout | ||
| value: 'stdout' | ||
| brief: 'Logs from stdout stream' | ||
| stability: experimental | ||
| - id: stderr | ||
| value: 'stderr' | ||
| brief: 'Events from stderr stream' | ||
| stability: experimental | ||
|
|
||
| - id: attributes.log.file | ||
| prefix: log.file | ||
| type: attribute_group | ||
| brief: > | ||
| A file to which log was emitted. | ||
| attributes: | ||
| - id: name | ||
| type: string | ||
| stability: experimental | ||
| - ref: log.file.name | ||
| requirement_level: recommended | ||
| brief: > | ||
| The basename of the file. | ||
| examples: ["audit.log"] | ||
| - id: path | ||
| type: string | ||
| stability: experimental | ||
| - ref: log.file.path | ||
| requirement_level: opt_in | ||
| brief: > | ||
| The full path to the file. | ||
| examples: [ "/var/log/mysql/audit.log" ] | ||
| - id: name_resolved | ||
| type: string | ||
| stability: experimental | ||
| - ref: log.file.name_resolved | ||
| requirement_level: opt_in | ||
| brief: > | ||
| The basename of the file, with symlinks resolved. | ||
| examples: [ "uuid.log" ] | ||
| - id: path_resolved | ||
| type: string | ||
| stability: experimental | ||
| - ref: log.file.path_resolved | ||
| requirement_level: opt_in | ||
| brief: > | ||
| The full path to the file, with symlinks resolved. | ||
| examples: [ "/var/lib/docker/uuid.log" ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| 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"] |