[DOCS-10735] Docs for SERVER-29628: Add aggregation stages to list all active logical sessions on the cluster Created: 30/Aug/17  Updated: 29/Oct/23  Resolved: 08/Oct/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 3.5.13

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: docs-sessions
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-29628 Add aggregation stages to list all ac... Closed
Related
related to DOCS-10685 Docs for SERVER-28335: Implement the ... Closed
is related to DOCS-10552 Docs for SERVER-28334: Implement the ... Closed
Participants:
Days since reply: 6 years, 18 weeks, 3 days ago
Epic Link: DOCS: 3.6 Server

 Description   

Documentation Request Summary:

Document $listSessions and $listLocalSessions aggregation stages.

$listSessions must be run against the admin.system.sessions collection.
$listLocalSessions must not be run against a collection. e.g. db.aggregate([{$listLocalSessions, {}}]);

Both stages must appear first in an aggregation pipeline if used.

Engineering Ticket Description:

Two aggregation stages:
$listLocalSessions - Ennumerate sessions in the node's LogicalSessionsCache
$listSessions - Ennumerate sessions recorded in the admin.system.sessions collection

Each stage accepts the following spec:
{
allUsers: true|false,
users: [

{user:"name", db: "dbname"}

, ... ],
}

allUsers == true will ennumerate all users from the specified source and requires ActionType::listSessions. Specifying a list of users with allUsers==true is an error.

allUsers == false with no users explicitly specified will default to the currently authenticated user (or non-user if auth is not enabled). If any user is specified in the users array who is NOT the currently logged in user, then ActionType::listSessions is required.



 Comments   
Comment by Githook User [ 08/Oct/17 ]

Author:

{'email': 'kay.kim@10gen.com', 'name': 'kay', 'username': 'kay-kim'}

Message: DOCS-10735: listSessions, listLocalSessions
Branch: master
https://github.com/mongodb/docs/commit/cd801a38ff4671a0f457808d17d314f9292c2a61

Generated at Thu Feb 08 08:01:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.