From d0238a5d05307a125cec9ab5cbb49650023e487a Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 19 Dec 2022 18:23:55 +0100 Subject: [PATCH 01/15] Add semantic conventions for log record ID Signed-off-by: svrnm --- semantic_conventions/logs/log-general.yaml | 17 +++++++++++++ .../logs/semantic_conventions/README.md | 1 + .../logs/semantic_conventions/log-general.md | 24 +++++++++++++++++++ 3 files changed, 42 insertions(+) create mode 100644 semantic_conventions/logs/log-general.yaml create mode 100644 specification/logs/semantic_conventions/log-general.md diff --git a/semantic_conventions/logs/log-general.yaml b/semantic_conventions/logs/log-general.yaml new file mode 100644 index 00000000000..2b9b05eb8d9 --- /dev/null +++ b/semantic_conventions/logs/log-general.yaml @@ -0,0 +1,17 @@ +groups: + - id: log_record + prefix: log_record + brief: > + The attributes described in this section are rather generic. They may be used in any Log Record they apply to. + attributes: + - id: id + type: string + requirement_level: recommended + brief: > + A unique identifier for the Log Record. + note: > + MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). + If a value is provided other log records, with the same value, will be considered to be duplicates and can be removed safely. + This means, that two distinguishable log records MUST have different values. + However in the case of duplication it is not guaranteed that duplicated log records have the same value. + examples: ["click", "exception"] diff --git a/specification/logs/semantic_conventions/README.md b/specification/logs/semantic_conventions/README.md index 931e1a7af27..00c18ef2e94 100644 --- a/specification/logs/semantic_conventions/README.md +++ b/specification/logs/semantic_conventions/README.md @@ -4,6 +4,7 @@ The following semantic conventions for logs are defined: +* [General](log-general.md): General semantic attributes that may be used in describing Log Records. * [Log Media](media.md): Semantic attributes that may be used in describing the source of a log. The following semantic conventions for events are defined: diff --git a/specification/logs/semantic_conventions/log-general.md b/specification/logs/semantic_conventions/log-general.md new file mode 100644 index 00000000000..7ea0c27b339 --- /dev/null +++ b/specification/logs/semantic_conventions/log-general.md @@ -0,0 +1,24 @@ +# General attributes + +**Status**: [Experimental](../../document-status.md) + +The attributes described in this section are rather generic. +They may be used in any Log Record they apply to. + + + + + + + +## General log identification attributes + +These attributes may be used for identifying a Log Record. + + +| Attribute | Type | Description | Examples | Requirement Level | +|---|---|---|---|---| +| `log_record.id` | string | A unique identifier for the Log Record. [1] | `click`; `exception` | Recommended | + +**[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). If a value is provided other log records, with the same value, will be considered to be duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. However in the case of duplication it is not guaranteed that duplicated log records have the same value. + From ee97fbd76efdf2598de2dd759fc846b4d7b7b1e5 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 21 Dec 2022 12:23:35 +0100 Subject: [PATCH 02/15] Run make markdown-toc Signed-off-by: svrnm --- specification/logs/semantic_conventions/log-general.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/logs/semantic_conventions/log-general.md b/specification/logs/semantic_conventions/log-general.md index 7ea0c27b339..75ce183096d 100644 --- a/specification/logs/semantic_conventions/log-general.md +++ b/specification/logs/semantic_conventions/log-general.md @@ -9,6 +9,8 @@ They may be used in any Log Record they apply to. +- [General log identification attributes](#general-log-identification-attributes) + ## General log identification attributes From d0b2bd05fc171cf4b57a94f058f74b1dfc2c097f Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 9 Jan 2023 09:51:05 +0100 Subject: [PATCH 03/15] Rename to log.record.id Signed-off-by: svrnm --- semantic_conventions/logs/log-general.yaml | 4 ++-- specification/logs/semantic_conventions/log-general.md | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/semantic_conventions/logs/log-general.yaml b/semantic_conventions/logs/log-general.yaml index 2b9b05eb8d9..c89a39a621c 100644 --- a/semantic_conventions/logs/log-general.yaml +++ b/semantic_conventions/logs/log-general.yaml @@ -1,6 +1,6 @@ groups: - - id: log_record - prefix: log_record + - id: log.record + prefix: log.record brief: > The attributes described in this section are rather generic. They may be used in any Log Record they apply to. attributes: diff --git a/specification/logs/semantic_conventions/log-general.md b/specification/logs/semantic_conventions/log-general.md index 75ce183096d..7c8f7c7d890 100644 --- a/specification/logs/semantic_conventions/log-general.md +++ b/specification/logs/semantic_conventions/log-general.md @@ -9,7 +9,8 @@ They may be used in any Log Record they apply to. -- [General log identification attributes](#general-log-identification-attributes) +- [General attributes](#general-attributes) + - [General log identification attributes](#general-log-identification-attributes) @@ -17,10 +18,10 @@ They may be used in any Log Record they apply to. These attributes may be used for identifying a Log Record. - + | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `log_record.id` | string | A unique identifier for the Log Record. [1] | `click`; `exception` | Recommended | +| `log.record.id` | string | A unique identifier for the Log Record. [1] | `click`; `exception` | Recommended | **[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). If a value is provided other log records, with the same value, will be considered to be duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. However in the case of duplication it is not guaranteed that duplicated log records have the same value. From 976d177f5e082a2518542484871049ad9437c70a Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 9 Jan 2023 09:54:29 +0100 Subject: [PATCH 04/15] Fix markdown TOC Signed-off-by: svrnm --- specification/logs/semantic_conventions/log-general.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/logs/semantic_conventions/log-general.md b/specification/logs/semantic_conventions/log-general.md index 7c8f7c7d890..f786745812c 100644 --- a/specification/logs/semantic_conventions/log-general.md +++ b/specification/logs/semantic_conventions/log-general.md @@ -9,8 +9,7 @@ They may be used in any Log Record they apply to. -- [General attributes](#general-attributes) - - [General log identification attributes](#general-log-identification-attributes) +- [General log identification attributes](#general-log-identification-attributes) From 549eaaa4462e1b98e1e5f9a8e269fb6dd705caff Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Tue, 10 Jan 2023 12:22:21 +0100 Subject: [PATCH 05/15] Update semantic_conventions/logs/log-general.yaml Co-authored-by: Joao Grassi --- semantic_conventions/logs/log-general.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/semantic_conventions/logs/log-general.yaml b/semantic_conventions/logs/log-general.yaml index c89a39a621c..e2e671e727d 100644 --- a/semantic_conventions/logs/log-general.yaml +++ b/semantic_conventions/logs/log-general.yaml @@ -11,7 +11,7 @@ groups: A unique identifier for the Log Record. note: > MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). - If a value is provided other log records, with the same value, will be considered to be duplicates and can be removed safely. + 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. However in the case of duplication it is not guaranteed that duplicated log records have the same value. examples: ["click", "exception"] From cebbc916396258c02716faf73951e74c999553d9 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Tue, 10 Jan 2023 12:22:28 +0100 Subject: [PATCH 06/15] Update semantic_conventions/logs/log-general.yaml Co-authored-by: Joao Grassi --- semantic_conventions/logs/log-general.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/semantic_conventions/logs/log-general.yaml b/semantic_conventions/logs/log-general.yaml index e2e671e727d..7e00f568015 100644 --- a/semantic_conventions/logs/log-general.yaml +++ b/semantic_conventions/logs/log-general.yaml @@ -13,5 +13,5 @@ groups: MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). 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. - However in the case of duplication it is not guaranteed that duplicated log records have the same value. + However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. examples: ["click", "exception"] From e7345418700f3b0ef2f282670b065df07f31330c Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Tue, 10 Jan 2023 12:23:09 +0100 Subject: [PATCH 07/15] Update semantic_conventions/logs/log-general.yaml Co-authored-by: Joao Grassi --- semantic_conventions/logs/log-general.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/semantic_conventions/logs/log-general.yaml b/semantic_conventions/logs/log-general.yaml index 7e00f568015..d206d632f09 100644 --- a/semantic_conventions/logs/log-general.yaml +++ b/semantic_conventions/logs/log-general.yaml @@ -14,4 +14,4 @@ groups: 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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. - examples: ["click", "exception"] + examples: ["01ARZ3NDEKTSV4RRFFQ69G5FAV"] From 8ae7a604abeb8f39c85c9fe13ee12a6b3e52a512 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Tue, 10 Jan 2023 20:23:17 +0100 Subject: [PATCH 08/15] Update specification/logs/semantic_conventions/README.md Co-authored-by: Joao Grassi --- specification/logs/semantic_conventions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/logs/semantic_conventions/README.md b/specification/logs/semantic_conventions/README.md index 00c18ef2e94..4df36b93317 100644 --- a/specification/logs/semantic_conventions/README.md +++ b/specification/logs/semantic_conventions/README.md @@ -4,7 +4,7 @@ The following semantic conventions for logs are defined: -* [General](log-general.md): General semantic attributes that may be used in describing Log Records. +* [General](general.md): General semantic attributes that may be used in describing Log Records. * [Log Media](media.md): Semantic attributes that may be used in describing the source of a log. The following semantic conventions for events are defined: From 0466d778b0c7e81585c2655203fbce672da1a5f8 Mon Sep 17 00:00:00 2001 From: svrnm Date: Tue, 10 Jan 2023 20:25:59 +0100 Subject: [PATCH 09/15] rename files from log-general to general Signed-off-by: svrnm --- semantic_conventions/logs/{log-general.yaml => general.yaml} | 0 .../logs/semantic_conventions/{log-general.md => general.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename semantic_conventions/logs/{log-general.yaml => general.yaml} (100%) rename specification/logs/semantic_conventions/{log-general.md => general.md} (100%) diff --git a/semantic_conventions/logs/log-general.yaml b/semantic_conventions/logs/general.yaml similarity index 100% rename from semantic_conventions/logs/log-general.yaml rename to semantic_conventions/logs/general.yaml diff --git a/specification/logs/semantic_conventions/log-general.md b/specification/logs/semantic_conventions/general.md similarity index 100% rename from specification/logs/semantic_conventions/log-general.md rename to specification/logs/semantic_conventions/general.md From 4c9122bd29dd286959abf0c3db9246f1af2f2ef2 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Mon, 16 Jan 2023 10:59:03 +0100 Subject: [PATCH 10/15] Update specification/logs/semantic_conventions/general.md Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com> --- specification/logs/semantic_conventions/general.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/logs/semantic_conventions/general.md b/specification/logs/semantic_conventions/general.md index f786745812c..247d48d1095 100644 --- a/specification/logs/semantic_conventions/general.md +++ b/specification/logs/semantic_conventions/general.md @@ -22,5 +22,5 @@ These attributes may be used for identifying a Log Record. |---|---|---|---|---| | `log.record.id` | string | A unique identifier for the Log Record. [1] | `click`; `exception` | Recommended | -**[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). If a value is provided other log records, with the same value, will be considered to be duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. However in the case of duplication it is not guaranteed that duplicated log records have the same value. +**[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). If a value is provided, other log records with the same value will be considered to be duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. However in the case of duplication it is not guaranteed that duplicated log records have the same value. From f5946f16d1c077adb3f7b06e0449eea5fa3f464e Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 16 Jan 2023 11:02:36 +0100 Subject: [PATCH 11/15] run table generation Signed-off-by: svrnm --- specification/logs/semantic_conventions/general.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/logs/semantic_conventions/general.md b/specification/logs/semantic_conventions/general.md index 247d48d1095..01ba15af0c5 100644 --- a/specification/logs/semantic_conventions/general.md +++ b/specification/logs/semantic_conventions/general.md @@ -20,7 +20,7 @@ These attributes may be used for identifying a Log Record. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `log.record.id` | string | A unique identifier for the Log Record. [1] | `click`; `exception` | Recommended | +| `log.record.id` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Recommended | -**[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). If a value is provided, other log records with the same value will be considered to be duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. However in the case of duplication it is not guaranteed that duplicated log records have the same value. +**[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). 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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. From 4b499b82779ca43e31725e514e607c3a1ea250d3 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 1 Feb 2023 20:19:45 +0100 Subject: [PATCH 12/15] Update documents according SIG discussion Signed-off-by: svrnm --- semantic_conventions/logs/general.yaml | 6 ++++-- specification/logs/semantic_conventions/general.md | 5 +++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/semantic_conventions/logs/general.yaml b/semantic_conventions/logs/general.yaml index d206d632f09..9986e241948 100644 --- a/semantic_conventions/logs/general.yaml +++ b/semantic_conventions/logs/general.yaml @@ -6,12 +6,14 @@ groups: attributes: - id: id type: string - requirement_level: recommended + requirement_level: optional brief: > A unique identifier for the Log Record. note: > - MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). 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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. + + 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"] diff --git a/specification/logs/semantic_conventions/general.md b/specification/logs/semantic_conventions/general.md index 01ba15af0c5..b38ea2bbcaa 100644 --- a/specification/logs/semantic_conventions/general.md +++ b/specification/logs/semantic_conventions/general.md @@ -20,7 +20,8 @@ These attributes may be used for identifying a Log Record. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `log.record.id` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Recommended | +| `log.record.id` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Optional | -**[1]:** MUST be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec). 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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. +**[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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. +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. From e24253033928c1c4b424438281b989457f6458a2 Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 27 Feb 2023 15:46:02 +0100 Subject: [PATCH 13/15] Update to 'uid' Signed-off-by: svrnm --- semantic_conventions/logs/general.yaml | 2 +- specification/logs/semantic_conventions/general.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/semantic_conventions/logs/general.yaml b/semantic_conventions/logs/general.yaml index 9986e241948..8e5e34ba26a 100644 --- a/semantic_conventions/logs/general.yaml +++ b/semantic_conventions/logs/general.yaml @@ -4,7 +4,7 @@ groups: brief: > The attributes described in this section are rather generic. They may be used in any Log Record they apply to. attributes: - - id: id + - id: uid type: string requirement_level: optional brief: > diff --git a/specification/logs/semantic_conventions/general.md b/specification/logs/semantic_conventions/general.md index b38ea2bbcaa..68c7e5d7c0a 100644 --- a/specification/logs/semantic_conventions/general.md +++ b/specification/logs/semantic_conventions/general.md @@ -20,7 +20,7 @@ These attributes may be used for identifying a Log Record. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `log.record.id` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Optional | +| `log.record.uid` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Optional | **[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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. 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. From def24c77dd2dc35b9b7322d523078b73f77f0b7a Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Mon, 6 Mar 2023 15:27:00 +0100 Subject: [PATCH 14/15] Update semantic_conventions/logs/general.yaml Co-authored-by: Joao Grassi --- semantic_conventions/logs/general.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/semantic_conventions/logs/general.yaml b/semantic_conventions/logs/general.yaml index 8e5e34ba26a..19935b355bb 100644 --- a/semantic_conventions/logs/general.yaml +++ b/semantic_conventions/logs/general.yaml @@ -6,7 +6,7 @@ groups: attributes: - id: uid type: string - requirement_level: optional + requirement_level: opt_in brief: > A unique identifier for the Log Record. note: > From 186207c2675568051c15cf853531131fe93dda23 Mon Sep 17 00:00:00 2001 From: svrnm Date: Thu, 9 Mar 2023 07:45:38 +0100 Subject: [PATCH 15/15] Remove superfluous sentence Signed-off-by: svrnm --- semantic_conventions/logs/general.yaml | 1 - specification/logs/semantic_conventions/general.md | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/semantic_conventions/logs/general.yaml b/semantic_conventions/logs/general.yaml index 19935b355bb..fc4af35678a 100644 --- a/semantic_conventions/logs/general.yaml +++ b/semantic_conventions/logs/general.yaml @@ -12,7 +12,6 @@ groups: 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. - However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. 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. diff --git a/specification/logs/semantic_conventions/general.md b/specification/logs/semantic_conventions/general.md index 68c7e5d7c0a..80b679a0bc0 100644 --- a/specification/logs/semantic_conventions/general.md +++ b/specification/logs/semantic_conventions/general.md @@ -20,8 +20,8 @@ These attributes may be used for identifying a Log Record. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `log.record.uid` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Optional | +| `log.record.uid` | string | A unique identifier for the Log Record. [1] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | Opt-In | -**[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. However, in the case of duplication, it is not guaranteed that duplicated log records have the same id. +**[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.