[DOCS-13884] Investigate changes in SERVER-48742: Log whenever profiler settings are changed via setProfilingLevel Created: 18/Sep/20  Updated: 13/Nov/23  Resolved: 01/Mar/21

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

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Jason Price
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
backported by DOCS-14056 [BACKPORT] [v4.2] Log whenever profil... Closed
backported by DOCS-14057 [BACKPORT] [v4.0] Log whenever profil... Closed
Documented
documents SERVER-48742 Log whenever profiler settings are ch... Closed
Participants:
Days since reply: 2 years, 49 weeks, 2 days ago
Epic Link: DOCSP-9747
Story Points: 3

 Description   

Description

Downstream Change Summary

We now log whenever the profile settings (level, slowms, sampleRate, filter) change at runtime (which happens via the profile command).

Description of Linked Ticket

We should add a log message, at log level 0, whenever the server's profiling settings are changed at run-time. The typical way you change these settings is via the setProfilingLevel shell helper: https://docs.mongodb.com/manual/reference/method/db.setProfilingLevel/index.html

This will make it easier to understand log files. The server logs slow queries to the log file, using the profiling setting to decide what 'slow' means. For someone digging through a log file, and seeing the number of slow queries suddenly go up or down, it might be helpful to know whether that's because the workload changed or the profiling settings changed.

Scope of changes

Suggest updating https://docs.mongodb.com/manual/reference/command/profile/#behavior and https://docs.mongodb.com/manual/reference/method/db.setProfilingLevel/index.html to reflect this new behavior, along with the usual release notes update. There may be other places to doc this behavior, but those are the first pages which come to mind.

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Githook User [ 01/Mar/21 ]

Author:

{'name': 'Jason Price', 'email': 'jason.price@mongodb.com', 'username': 'jason-price-mongodb'}

Message: DOCS-13884 Log profiler changes
Branch: v4.0
https://github.com/mongodb/docs/commit/baedd7967304a5a14dab94dd003fe5b14e257b86

Comment by Githook User [ 26/Feb/21 ]

Author:

{'name': 'Jason Price', 'email': 'jason.price@mongodb.com', 'username': 'jason-price-mongodb'}

Message: DOCS-13884 Log profiler changes
Branch: v4.2
https://github.com/mongodb/docs/commit/58bf04d91c4a616b28f7c369d98bda1570c92347

Comment by Githook User [ 26/Feb/21 ]

Author:

{'name': 'Jason Price', 'email': 'jason.price@mongodb.com', 'username': 'jason-price-mongodb'}

Message: DOCS-13884 Log profiler changes
Branch: master
https://github.com/mongodb/docs/commit/e4145d788675efcfd7d84a43eb73bd243418f391

Comment by Githook User [ 25/Feb/21 ]

Author:

{'name': 'Jason Price', 'email': 'jason.price@mongodb.com', 'username': 'jason-price-mongodb'}

Message: DOCS-13884 Log profiler changes
Branch: v5.0
https://github.com/mongodb/docs/commit/17c0fd354c4d0d829838a9c2e4660308eb20bc45

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