open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add session.previous_id (#348)

This commit is contained in:
jason plumb 2023-10-21 06:40:31 -07:00 committed by GitHub
parent b23075cd60
commit 889b0a4827
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -24,6 +24,8 @@ release.
### Features ### Features
- Adds `session.previous_id` to session.md
([#348](https://github.com/open-telemetry/semantic-conventions/pull/348))
- Metric namespaces SHOULD NOT be pluralized. - Metric namespaces SHOULD NOT be pluralized.
([#267](https://github.com/open-telemetry/opentelemetry-specification/pull/267)) ([#267](https://github.com/open-telemetry/opentelemetry-specification/pull/267))

5
docs/general/session.md
View File

@ -11,12 +11,17 @@ Consequently, a Session is represented as a collection of Logs, Events, and Span
throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in 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. the Logs, Events, and Spans generated during the Session's lifecycle.
When a session reaches end of life, typically due to user inactivity or session timeout, a new session identifier
will be assigned. The previous session identifier may be provided by the instrumentation so that telemetry
backends can link the two sessions.
## Attributes ## Attributes
<!-- semconv session-id --> <!-- semconv session-id -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `session.id` | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | Opt-In | | `session.id` | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | Opt-In |
| `session.previous_id` | string | The previous `session.id` for this user, when known. | `00112233-4455-6677-8899-aabbccddeeff` | Opt-In |
<!-- endsemconv --> <!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md

9
model/session.yaml
View File

@ -9,9 +9,18 @@ groups:
Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application 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 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. the Logs, Events, and Spans generated during the Session's lifecycle.
When a session reaches end of life, typically due to user inactivity or session timeout, a new session identifier
will be assigned. The previous session identifier may be provided by the instrumentation so that telemetry
backends can link the two sessions.
attributes: attributes:
- id: id - id: id
type: string type: string
brief: "A unique id to identify a session." brief: "A unique id to identify a session."
examples: "00112233-4455-6677-8899-aabbccddeeff" examples: "00112233-4455-6677-8899-aabbccddeeff"
requirement_level: opt_in requirement_level: opt_in
- id: previous_id
type: string
brief: "The previous `session.id` for this user, when known."
examples: "00112233-4455-6677-8899-aabbccddeeff"
requirement_level: opt_in