Skip to content

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

Merged
EldadH89 merged 8 commits into
v1.0from
v1.0_docs-960-ztwa-session-id-mapping
Jul 8, 2026
Merged

DOCS-960: Document ZTWA session ID correlation for recordings#313
EldadH89 merged 8 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
Contributor

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 how Secure Remote Access session IDs are kept consistent across Session Overview and Audit Log entries, and how user identity is recorded for audit events.
  • Updated Session Overview Grid formatting and refined “Client Interface” option text for clearer guidance.
  • Added a new “Session Correlation” section and an end-to-end validation step to help correlate recordings with Session Overview and Audit Log events.
  • Expanded session visibility prerequisites for Web Access session recording, including ZTWA version, clusterName matching, authentication, gateway certificate trust, and gateway registration status.

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 26b39ecc-a3ea-4338-a1c6-77856a0083d9

📥 Commits

Reviewing files that changed from the base of the PR and between 5f44cc9 and 40a0dcc.

📒 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 shared session ID correlation notes, records end-user identity in sra_unique_identifier, and documents session-visibility prerequisites in both the web access session recording guide and the K8s setup guide.

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
Refines the Session Overview Grid field list and adds notes about shared session IDs and sra_unique_identifier for Secure Remote Access session events.
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 with the recording-to-log ID linkage and visibility prerequisites, plus a workflow step to verify the ID across recording, Session Overview, and Audit Log.
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 covering version, cluster name, Access ID, trust material, and gateway registration requirements.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

🚥 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.

@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
Contributor Author

All comments addressed.

@EldadH89
EldadH89 merged commit 83c88ae into v1.0 Jul 8, 2026
13 of 14 checks passed
@EldadH89
EldadH89 deleted the v1.0_docs-960-ztwa-session-id-mapping branch July 8, 2026 07:03
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