StartSessionOptions

---

Interface: StartSessionOptions

Defined in: src/types/logging/logger.types.ts

Options for starting a new session.

Properties

externalId?

optional externalId: string;

Defined in: src/types/logging/logger.types.ts

(Optional) An external identifier for the session. If a session with this external ID already exists, it will be reused instead of creating a new session.

---

metadata?

optional metadata: Record<string, string>;

Defined in: src/types/logging/logger.types.ts

(Optional) User metadata for the session as key-value string pairs. Only applied when creating a new session.

---

name?

optional name: string;

Defined in: src/types/logging/logger.types.ts

(Optional) The name of the session. Only applied when creating a new session.

---

previousSessionId?

optional previousSessionId: string;

Defined in: src/types/logging/logger.types.ts

(Optional) The ID of a previous session to link to. Creates a reference only; does not inherit metadata. Only applied when creating a new session.