[DOCS-12740] Docs for SERVER-41192: Add a metric for the size of the SessionCatalog under `logicalSessionRecordCache` Created: 22/May/19  Updated: 13/Nov/23  Resolved: 09/Jul/19

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.1.12, 4.0.22, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

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

Issue Links:
Backports
backported by DOCS-13944 [BACKPORT] [v4.0] Add a metric for th... Closed
Documented
documents SERVER-41192 Add a metric for the size of the Sess... Closed
Participants:
Days since reply: 3 years, 4 weeks, 1 day ago
Epic Link: DOCS: 4.2 Server/Tools

 Description   

Description

Description:

Please add documentation for this new metric called sessionCatalogSize, which will start showing-up under the LogicalSessionCache stats.

Description is:
The session catalog is an in-memory cache of the config.transactions collection on MongoD and on routers (starting in 4.2) it represents the number of cross-shard transactions, which are rooted on that MongoS. This metric represents the number of entries in the in-memory cache and is a way to monitor that sessions are reaped and not kept alive indefinitely.

Engineering Ticket Description:

The logicalSessionRecordCache section of serverStatus contains details about the entries in the logical session cache. This cache serves as a source of 'truth' for which logical sessions are considered active or not and is used to reap the SessionCatalog.

However, since the SessionCatalog is linked to the internal state of transactions - it can not always be reaped when a session expires from the logical sessions cache. Because of this, for diagnostics purposes we should have FTDC data for what's the number of sessions in the SessionCatalog.

This ticket is to add a logicalSessionRecordCache.sessionCatalogSize metric, which tracks the number of the SessionCatalog entries.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 12/Jan/21 ]

Author:

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

Message: DOCS-13944 Backport DOCS-12740 to 4.0: logicalSessionRecordCache.sessionCatalogSize
Branch: v4.0
https://github.com/mongodb/docs/commit/20c2a3de4c535917c257275af4cd1facf45782e7

Comment by Githook User [ 09/Jul/19 ]

Author:

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

Message: DOCS-12740: 4.2 logicalSessionRecordCache.sessionCatalogSize
Branch: master
https://github.com/mongodb/docs/commit/bd747d31a75a5334d8612d057675a694e31501d2

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