[DOCS-15431] Investigate changes in SERVER-65796: convert serverStatus metrics for index builds from gauges to counters. Created: 21/Jun/22  Updated: 13/Nov/23  Resolved: 20/Jul/23

Status: Closed
Project: Documentation
Component/s: Server
Affects Version/s: None
Fix Version/s: 6.1.0-rc0, 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: Alison Huh
Resolution: Fixed Votes: 0
Labels: server-docs-bug-bash
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-65796 convert serverStatus metrics for inde... Closed
Participants:
Days since reply: 29 weeks, 2 days ago

 Description   
Original Downstream Change Summary

"activeIndexBuilds" has been changed to "indexBuilds", and the reported metrics have changed accordingly. Instead of current index builds, the metrics are now cumulative.

Description of Linked Ticket

We added a new section "activeIndexBuilds" in SERVER-57625 to capture metrics for index builds. The metrics are currently implemented as gauges, which go down to zero when there are no longer any in-progress index builds. If these metrics were converted to counters that never decrement, it may work better with some of our diagnostic tools such as FTDC and support better trend analysis.

Separately, if we decide to move forward on this change, we should consider renaming this section since "activeIndexBuilds" will not be accurate anymore. This new section would also be a suitable location for new metrics requested in SERVER-64659.

This section is new to 6.0 and has not been back ported to earlier versions of the server.



 Comments   
Comment by Alison Huh [ 17/Jul/23 ]

PR: https://github.com/10gen/docs-mongodb-internal/pull/3910

Comment by Alison Huh [ 13/Jul/23 ]

Gotcha. I was working on 7.0.0-rc0 and it wasn't showing up for some reason, but I downloaded the latest RC and looks like it's outputting correctly. Sorry about that!

Comment by Yujin Kang Park [ 13/Jul/23 ]

Hi alison.huh@mongodb.com, which version of MongoDB are you using? Should be >= 6.1.

For me, running on master, I get:

MongoDB Enterprise > use testDB
switched to db testDB
MongoDB Enterprise > db.serverStatus().indexBuilds
{
        "total" : 0,
        "killedDueToInsufficientDiskSpace" : 0,
        "failedDueToDataCorruption" : 0,
        "phases" : {
                "scanCollection" : 0,
                "drainSideWritesTable" : 0,
                "drainSideWritesTablePreCommit" : 0,
                "waitForCommitQuorum" : 0,
                "drainSideWritesTableOnCommit" : 0,
                "processConstraintsViolatonTableOnCommit" : 0,
                "commit" : 0
        }
}

Comment by Alison Huh [ 12/Jul/23 ]

Hi yujin.kang@mongodb.com, I'm trying to test this out on my own instance, but I'm not seeing the indexBuilds section when running db.serverStatus() even after creating an index on my collection. Is this a field that appears conditionally or is there something I'm missing?

Comment by Education Bot [ 21/Jun/22 ]

Fix Version updated for upstream SERVER-65796:
6.1.0-rc0

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