[SERVER-48718] Document Server-Internal Contextual Singletons Created: 11/Jun/20  Updated: 29/Oct/23  Resolved: 16/Sep/21

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 5.1.0-rc0

Type: Task Priority: Major - P3
Reporter: Benjamin Caimano (Inactive) Assignee: Tyler Seip (Inactive)
Resolution: Fixed Votes: 0
Labels: sa-arch-guide-must-have
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-48752 Document Server-Internal Decoration L... Backlog
Backwards Compatibility: Fully Compatible
Sprint: Service Arch 2021-08-23, Service Arch 2021-09-06, Service Arch 2021-09-20
Participants:
Story Points: 4

 Description   

We have a set of contextual singletons that exist in a clear hierarchy. They all live in src/mongo/db.

Notable classes include:

  • ServiceContext
  • Client
  • OperationContext

It's probably worth mentioning the OperationKiller and Interruptible interface with reference to the OperationContext.

All of these pieces live in a single directory but they are used across the codebase, thus this documentation could live in a number of places:

  • docs/contexts.md would make this document immediately accessible.
  • src/mongo/db/readme.md as a large section.
  • src/mongo/db/contexts.md as a separate document.

This is intended to be abstract documentation, describe relationships and state transitions not code in common language.



 Comments   
Comment by Vivian Ge (Inactive) [ 06/Oct/21 ]

Updating the fixversion since branching activities occurred yesterday. This ticket will be in rc0 when it’s been triggered. For more active release information, please keep an eye on #server-release. Thank you!

Comment by Githook User [ 13/Sep/21 ]

Author:

{'name': 'Tyler Seip', 'email': 'Tyler.Seip@mongodb.com', 'username': 'tseip-mongo'}

Message: SERVER-48718: Document server contextual singletons
Branch: master
https://github.com/mongodb/mongo/commit/d7327f942a8431fdf595cde8dc0c149d4089b3e4

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