To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Configuration and state for one tenant's debug session, a short-lived capture of matching web requests and/or async tasks. A session is created through DebugSessionBuilder, matches operations using its host name, path prefix and task name filters, and expires automatically once its configured expiry time passes. Matching operations are captured by DebugService and their logs and details persisted against the session's id. Sessions are stored as XML, as a "debug-session" element.
Group: Debugging
Properties
| Property | Returns | Description |
|---|---|---|
| asyncTasks | boolean | Whether this session captures asynchronous jobs and other background tasks. |
| createdAt | Date | Time this session was created. |
| createdByProfileId | long | Id of the profile that created this session. |
| expiry | Date | Time at which this session stops matching operations and is treated as expired. |
| hostName | String | Host name filter for web request capture: when set, only requests to this host are matched. |
| loggingClasses | Set<String> | Simple class names for which enhanced logging should be activated while this session is active. Checked by isEnhancedLogging, though nothing in the platform currently calls that method, so setting it has no observable effect. |
| loggingLevel | Integer | Minimum severity level, as a log4j Level.intLevel() value, that this session's operations are logged at. |
| notes | String | Free text notes attached to this session, as set on the builder. |
| pathPrefix | String | Path prefix filter for web request capture: when set, only requests whose path starts with this value are matched. |
| performanceData | Boolean | |
| performanceDataEnabled | boolean | True only if performance (stopwatch) data collection was explicitly enabled for this session. Sessions recorded before this option existed will report false. |
| sessionId | String | Unique identifier for this debug session, generated as a random seven-character string when the session is created. |
| stopped | boolean | Whether this session was automatically stopped by one of its protective limits, such as exceeding the maximum operation count or captured file size for the session. |
| stopReason | String | Explanation of why this session was automatically stopped, when isStopped is true. |
| taskName | String | Task name filter for async task capture: when set, only tasks whose source matches this value are captured. |
| tenantId | long | Id of the tenant this debug session belongs to. |
| thisSession | Boolean | Whether this session should only capture web requests carrying this session's id in a debugSessionId cookie. |
| title | String | Display title for this session, as set on the builder. |
| webRequests | boolean | Whether this session captures web requests. |
Methods
getSessionId() · getTitle() · getThisSession() · getHostName() · getPathPrefix() · getExpiry() · getTenantId() · isWebRequests() · isAsyncTasks() · getTaskName() · isStopped() · getStopReason() · getCreatedAt() · getCreatedByProfileId() · getLoggingClasses() · getLoggingLevel() · getNotes()
getSessionId()
Returns: String
Unique identifier for this debug session, generated as a random seven-character string when the session is created.
getTitle()
Returns: String
Display title for this session, as set on the builder.
getThisSession()
Returns: Boolean
Whether this session should only capture web requests carrying this session's id in a debugSessionId cookie.
getHostName()
Returns: String
Host name filter for web request capture: when set, only requests to this host are matched.
getPathPrefix()
Returns: String
Path prefix filter for web request capture: when set, only requests whose path starts with this value are matched.
getExpiry()
Returns: Date
Time at which this session stops matching operations and is treated as expired.
getTenantId()
Returns: long
Id of the tenant this debug session belongs to.
isWebRequests()
Returns: boolean
Whether this session captures web requests.
isAsyncTasks()
Returns: boolean
Whether this session captures asynchronous jobs and other background tasks.
getTaskName()
Returns: String
Task name filter for async task capture: when set, only tasks whose source matches this value are captured.
isStopped()
Returns: boolean
Whether this session was automatically stopped by one of its protective limits, such as exceeding the maximum operation count or captured file size for the session.
getStopReason()
Returns: String
Explanation of why this session was automatically stopped, when isStopped is true.
getCreatedAt()
Returns: Date
Time this session was created.
getCreatedByProfileId()
Returns: long
Id of the profile that created this session.
getLoggingClasses()
Returns: Set<String>
Simple class names for which enhanced logging should be activated while this session is active. Checked by isEnhancedLogging, though nothing in the platform currently calls that method, so setting it has no observable effect.
getLoggingLevel()
Returns: Integer
Minimum severity level, as a log4j Level.intLevel() value, that this session's operations are logged at.
getNotes()
Returns: String
Free text notes attached to this session, as set on the builder.
© 2025 Kademi Ltd