Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add semantic conventions for log record ID #3047

Merged
merged 38 commits into from
Apr 6, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
d0238a5
Add semantic conventions for log record ID
svrnm Dec 19, 2022
ee97fbd
Run make markdown-toc
svrnm Dec 21, 2022
b2a596b
Merge branch 'main' into add-log-record-id-semconv
svrnm Dec 21, 2022
6041e0e
Merge branch 'main' into add-log-record-id-semconv
svrnm Dec 27, 2022
d0b2bd0
Rename to log.record.id
svrnm Jan 9, 2023
976d177
Fix markdown TOC
svrnm Jan 9, 2023
71bae6e
Merge branch 'main' into add-log-record-id-semconv
svrnm Jan 9, 2023
549eaaa
Update semantic_conventions/logs/log-general.yaml
svrnm Jan 10, 2023
cebbc91
Update semantic_conventions/logs/log-general.yaml
svrnm Jan 10, 2023
e734541
Update semantic_conventions/logs/log-general.yaml
svrnm Jan 10, 2023
8ae7a60
Update specification/logs/semantic_conventions/README.md
svrnm Jan 10, 2023
0466d77
rename files from log-general to general
svrnm Jan 10, 2023
66da513
Merge branch 'main' into add-log-record-id-semconv
svrnm Jan 11, 2023
4c9122b
Update specification/logs/semantic_conventions/general.md
svrnm Jan 16, 2023
f5946f1
run table generation
svrnm Jan 16, 2023
d9140d3
Merge branch 'main' into add-log-record-id-semconv
svrnm Jan 16, 2023
c05520a
Merge branch 'main' into add-log-record-id-semconv
svrnm Jan 23, 2023
1749092
Merge branch 'main' into add-log-record-id-semconv
svrnm Jan 31, 2023
8fab22a
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 1, 2023
4b499b8
Update documents according SIG discussion
svrnm Feb 1, 2023
165cb20
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 7, 2023
e54bbb7
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 8, 2023
b10b963
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 13, 2023
a7f1250
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 15, 2023
ddc8e95
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 21, 2023
8d88b07
Merge branch 'main' into add-log-record-id-semconv
svrnm Feb 27, 2023
e242530
Update to 'uid'
svrnm Feb 27, 2023
aba09e9
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 1, 2023
a2be65b
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 6, 2023
def24c7
Update semantic_conventions/logs/general.yaml
svrnm Mar 6, 2023
4333bae
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 9, 2023
186207c
Remove superfluous sentence
svrnm Mar 9, 2023
09d3b47
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 13, 2023
1a44bf7
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 20, 2023
a0f4f08
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 28, 2023
48e1483
Merge branch 'main' into add-log-record-id-semconv
svrnm Mar 29, 2023
720905e
Merge branch 'main' into add-log-record-id-semconv
tigrannajaryan Apr 6, 2023
b40e726
Merge branch 'main' into add-log-record-id-semconv
tigrannajaryan Apr 6, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions semantic_conventions/logs/general.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
groups:
- id: log.record
prefix: log.record
svrnm marked this conversation as resolved.
Show resolved Hide resolved
brief: >
The attributes described in this section are rather generic. They may be used in any Log Record they apply to.
attributes:
- id: id
svrnm marked this conversation as resolved.
Show resolved Hide resolved
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 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: ["01ARZ3NDEKTSV4RRFFQ69G5FAV"]
1 change: 1 addition & 0 deletions specification/logs/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

The following semantic conventions for logs are defined:

* [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:
Expand Down
26 changes: 26 additions & 0 deletions specification/logs/semantic_conventions/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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.

<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->

<!-- toc -->

- [General log identification attributes](#general-log-identification-attributes)

<!-- tocstop -->

## General log identification attributes

These attributes may be used for identifying a Log Record.

<!-- semconv log.record -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `log.record.id` | string | A unique identifier for the Log Record. [1] | `click`; `exception` | Recommended |
svrnm marked this conversation as resolved.
Show resolved Hide resolved

**[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.
svrnm marked this conversation as resolved.
Show resolved Hide resolved
<!-- endsemconv -->