-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Session.id semantic convention (#215)
Co-authored-by: jason plumb <75337021+breedx-splk@users.noreply.github.com> Co-authored-by: Chengzhong Wu <legendecas@gmail.com> Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
- Loading branch information
1 parent
6166960
commit a89f573
Showing
3 changed files
with
41 additions
and
0 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
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,22 @@ | ||
# Semantic conventions for session | ||
|
||
**Status**: [Experimental][DocumentStatus] | ||
|
||
This document defines semantic conventions to apply to client-side applications when tracking sessions. | ||
|
||
Session is defined as the period of time encompassing all activities performed by the application and the actions | ||
executed by the end user. | ||
|
||
Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application | ||
throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in | ||
the Logs, Events, and Spans generated during the Session's lifecycle. | ||
|
||
## Attributes | ||
|
||
<!-- semconv session-id --> | ||
| Attribute | Type | Description | Examples | Requirement Level | | ||
|---|---|---|---|---| | ||
| `session.id` | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | Opt-In | | ||
<!-- endsemconv --> | ||
|
||
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md |
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,17 @@ | ||
groups: | ||
- id: session-id | ||
prefix: session | ||
type: attribute_group | ||
brief: > | ||
Session is defined as the period of time encompassing all activities performed by the application and the actions | ||
executed by the end user. | ||
Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application | ||
throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in | ||
the Logs, Events, and Spans generated during the Session's lifecycle. | ||
attributes: | ||
- id: id | ||
type: string | ||
brief: "A unique id to identify a session." | ||
examples: "00112233-4455-6677-8899-aabbccddeeff" | ||
requirement_level: opt_in |