Skip to content

DOCS-960: Document ZTWA session ID correlation for recordings#313

Open
harrison-akeyless wants to merge 7 commits into
v1.0from
v1.0_docs-960-ztwa-session-id-mapping
Open

DOCS-960: Document ZTWA session ID correlation for recordings#313
harrison-akeyless wants to merge 7 commits into
v1.0from
v1.0_docs-960-ztwa-session-id-mapping

Conversation

@harrison-akeyless

@harrison-akeyless harrison-akeyless commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Documented how to correlate ZTWA recordings, Session Overview entries, and Audit Log events by session ID.
  • Added deployment prerequisites to troubleshoot missing Session Overview and Audit Log entries for ZTWA sessions.
  • Added explicit note that ZTWA audit user identity is recorded in sra_unique_identifier.

Updated pages

  • Web Access Session Recording
  • Sessions Overview
  • Zero Trust Web Access on K8s

Validation

  • pre-commit run --files "docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-web-access-session-recording.md" "docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-sessions-overview.md" "docs/Secure Remote Access/sra-setup/sra-web-access-on-k8s/index.md"
  • lychee run for each edited file with repository options

Summary by CodeRabbit

Documentation

  • Clarified that session IDs remain consistent across Session Overview, Audit Logs, and recording artifacts
  • Added step-by-step guidance for correlating recordings with user sessions
  • Provided prerequisites checklist for session visibility, including version requirements and configuration validation

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@harrison-akeyless, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 42 minutes and 15 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c320f54a-8772-489a-9cef-140b518afb8b

📥 Commits

Reviewing files that changed from the base of the PR and between 5f44cc9 and 844d496.

📒 Files selected for processing (3)
  • docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-sessions-overview.md
  • docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-web-access-session-recording.md
  • docs/Secure Remote Access/sra-setup/sra-web-access-on-k8s/index.md

Walkthrough

Documentation-only update across three SRA Markdown files. Adds a shared 24-digit session ID correlation note to Session Overview Grid, an sra_unique_identifier identity note to Audit Logging, a new "Session Correlation" section and workflow step to the web access session recording page, and a "Session visibility prerequisites" subsection to the K8s web access setup page.

Changes

ZTWA Session Correlation and Visibility Prerequisites

Layer / File(s) Summary
Session Overview Grid and Audit Log identity note
docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-sessions-overview.md
Reformats the Session Overview Grid field list, adds a note that ZTWA sessions use the same session ID across Session Overview, Audit Log, and recording artifacts, and notes that ZTWA user identity is stored in sra_unique_identifier.
Session Correlation section and end-to-end workflow step
docs/Secure Remote Access/sra-admin-guides/sra-session-management/sra-web-access-session-recording.md
Adds a "Session Correlation" section explaining the 24-digit session ID linkage between recordings, Session Overview, and Audit Log, including a correlation workflow and a prerequisites checklist for missing entries; adds a final workflow step for correlation validation.
Session visibility prerequisites in K8s setup
docs/Secure Remote Access/sra-setup/sra-web-access-on-k8s/index.md
Adds a "Session visibility prerequisites" subsection listing ZTWA version, clusterName match, Access ID, Gateway trust material, and Gateway registration requirements for session entries to appear.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐇 A session ID hops across three docs with glee,
Linking recordings and logs for all to see.
The sra_unique_identifier marks who came by,
Prerequisites listed so no entry goes awry.
This bunny aligns the audit trail just right! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly references the main objective: documenting ZTWA session ID correlation for recordings, which is the primary focus of all changes across the three documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v1.0_docs-960-ztwa-session-id-mapping

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@harrison-akeyless harrison-akeyless marked this pull request as ready for review June 15, 2026 18:45

@EldadH89 EldadH89 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not addressing the main requirement, in order to get this to work (i.e. audit logs for ZTWA, with all benefits (session id correlation etc.)) the deployment MUST use the same cluser name and the same Access ID of the Gateway (which is running the SRA) , please make sure the relevant is highlighted in the deployment section of the ZTWA that for audit logs and session recording, this is the requirement

@harrison-akeyless

Copy link
Copy Markdown
Collaborator Author

All comments addressed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants