[DOCS-12633] Bad docs for --setParameter logComponentVerbosity Created: 14/Apr/19  Updated: 30/Oct/23  Resolved: 09/Oct/19

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

Type: Bug Priority: Major - P3
Reporter: A. Jesse Jiryu Davis Assignee: Andrew Feierabend (Inactive)
Resolution: Fixed Votes: 0
Labels: docs-onboarding-candidate
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 4 years, 18 weeks ago
Epic Link: DOCSP-1769
Story Points: 0.5

 Description   

Description

On this page:

https://docs.mongodb.com/manual/reference/configuration-file-settings-command-line-options-mapping/

The docs for setting log component verbosity via the command line aren't helpful:
{{mongod --setParameter"logComponentVerbosity=

{heartbeats:... }

}}

https://docs.mongodb.com/manual/reference/program/mongod/#cmdoption-mongod-setparameter

mongos --setParameter"logComponentVerbosity={heartbeats:... }

https://docs.mongodb.com/manual/reference/program/mongos/#cmdoption-mongos-setparameter

 
The "..." ellipsis doesn't tell me what type of argument to pass, it's not obvious it should be an integer. And the syntax is wrong, it should be:

mongod --setParameter "logComponentVerbosity={replication:{heartbeats:2"}}

The "heartbeat" component is part of the "replication" component, so it must be passed as a JSON sub object.

Scope of changes

  • Update logComponentVerbosity example to the correct syntax
  • Update the other replication.n.verbosity options to have correct syntax
  • Update the storage.n.verbosity options to have correct syntax
  • Test all syntax updates


 Comments   
Comment by Githook User [ 09/Oct/19 ]

Author:

{'username': 'andf-mongodb', 'email': 'andrew.feierabend@mongodb.com', 'name': 'Andrew Feierabend'}

Message: DOCS-12633 correct replication and storage verbosity parameters
Branch: v4.0
https://github.com/mongodb/docs/commit/7585dbbc26d4a13f3901e5b5b39691a577c7184a

Comment by Githook User [ 09/Oct/19 ]

Author:

{'username': 'andf-mongodb', 'email': 'andrew.feierabend@mongodb.com', 'name': 'Andrew Feierabend'}

Message: DOCS-12633 correct replication and storage verbosity parameters
Branch: master
https://github.com/mongodb/docs/commit/f75c151653c16cb034856851abf999b407d0ddd0

Comment by Andrew Feierabend (Inactive) [ 09/Oct/19 ]

Updated replication and storage verbosity commands to reflect correct subobject command syntax.

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