feat: add _experimental_longtaskNoStartSession flag
#899
Conversation
Joozty
force-pushed
the
fix/longtasks
branch
from
49c99ef to
34e0f4c
Compare
Joozty
changed the title
Joozty
changed the title
_experimental_longtaskNoStartSession flag
| @@ -52,6 +58,16 @@ export class SplunkLongTaskInstrumentation extends InstrumentationBase { | |||
| init(): void {} | |||
|
|
|||
| private _createSpanFromEntry(entry: PerformanceEntry) { | |||
| if ( | |||
| !!this.initOptions._experimental_longtaskNoStartSession && | |||
There was a problem hiding this comment.
This is the core of the PR... if there is no session we do not spawn new one when this flag is set to true
| otlp?: boolean | ||
| } | ||
|
|
||
| export interface SplunkOtelWebConfig { |
There was a problem hiding this comment.
moved to separate file to avoid circular dependency
| @@ -633,6 +515,14 @@ export const SplunkRum: SplunkOtelWebType = { | |||
| _experimental_getSessionId() { | |||
| return this.getSessionId() | |||
| }, | |||
|
|
|||
| _internalOnExternalSpanCreated() { | |||
There was a problem hiding this comment.
this gets called from session recorder - when span is created we extend expiration (inactivity) time of session
| export const SESSION_DURATION_SECONDS = 4 * 60 * 60 // 4 hours | ||
| export const SESSION_DURATION_MS = SESSION_DURATION_SECONDS * 1000 | ||
| export const SESSION_INACTIVITY_TIMEOUT_MS = 15 * 60 * 1000 // 15 minutes | ||
| export const SESSION_STORAGE_KEY = '_splunk_rum_sid' |
There was a problem hiding this comment.
same key is used for cookies and localstorage
| cookieStore._set(value) | ||
| }, | ||
|
|
||
| _set: throttle((value: string) => { |
There was a problem hiding this comment.
Writing to cookies/localstorage is throttled. We write directly on load, when session is created and when page gets hidden.
| * limitations under the License. | ||
| * | ||
| */ | ||
| export function throttle<T extends (...args: unknown[]) => any>(func: T, limit: number) { |
There was a problem hiding this comment.
throttle function with visibilitychange flush feature
| // safety valve | ||
| return | ||
| } | ||
|
|
||
| const cookieValue = encodeURIComponent(JSON.stringify(sessionState)) | ||
| const domain = cookieDomain ? `domain=${cookieDomain};` : '' | ||
| let cookie = COOKIE_NAME + '=' + cookieValue + '; path=/;' + domain + 'max-age=' + InactivityTimeoutSeconds | ||
| let cookie = SESSION_STORAGE_KEY + '=' + cookieValue + '; path=/;' + domain + 'max-age=' + SESSION_DURATION_SECONDS |
There was a problem hiding this comment.
max-age is set to session duration and expiresAt is in cookie state
Description
Added
_experimental_longtaskNoStartSession. When set totrue, no new session will be spawned after the previous one expires when long task occurs. If both_experimental_longtaskNoStartSessionand_experimental_allSpansExtendSessionare set to true,_experimental_longtaskNoStartSessiontakes precedence.List Github issue(s) which this PR fixes.
Type of change
Delete options that are not relevant.
How has this been tested?
Delete options that are not relevant.