[DOCS-7111] Remove "totals: true" from JS Benchmarking Harness examples Created: 06/Feb/16  Updated: 08/Feb/16  Resolved: 08/Feb/16

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: mongodb-3.0
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: Chung-yen Chang Assignee: Kay Kim (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 8 years, 1 week, 4 days ago

 Description   

Not sure the difference between the Documentation and Technical Writing project so I will start here. Please move the ticket if this is not the right project for it.

In reviewing the server code recently, it is realized that the option "totals" is not implemented properly for the benchRun command documented on this page: https://docs.mongodb.org/v3.2/contributors/reference/js-benchmarking-harness/

Because that option is not implemented properly, we should remove reference to that option in the examples showed on the page above. I found two instances of this option used on the page in the example in the Dynamic Value section. The proper way to do this would be remove the line that contains "totals: true" and also the comma at the end of the previous lines.

// benchmark updates using the $inc operator
res = benchRun( {
    ops : [ {
        ns : "test.foo" ,
        op : "update" ,
        query : { _id : { "#RAND_INT" : [ 0 , 100 ] } } ,
        update : { $inc : { x : 1 } }
    } ] ,
    parallel : 2 ,
    seconds : 1 ,
    totals : true
} );
print( "threads: 2\t update/sec: " + res.update );
// benchmark inserts with random strings
res = benchRun( {
    ops : [ {
        ns : "test.foo" ,
        op : "insert" ,
        doc : { y : { "#RAND_STRING" : [ 10 ] } }
    } ] ,
    parallel : 2 ,
    seconds : 1 ,
    totals : true
} );
print( "threads: 2\t insert/sec: " + res.insert );



 Comments   
Comment by Kay Kim (Inactive) [ 06/Feb/16 ]

Will remove the option.

Adding mark.benvenutoramon.fernandezpasette so that if they have a markdown version of the page for the github wiki, they're aware of the changes.

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