Skip to content

PT-2354: pt-mongodb-summary graceful ARBITER handling #1144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eslavyansky wants to merge 2 commits into
base: 3.x
Choose a base branch
from
Open

PT-2354: pt-mongodb-summary graceful ARBITER handling #1144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc78b1c
PT-2354: pt-mongodb-summary graceful ARBITER handling
eslavyansky Jun 24, 2026
f1c28e7
PT-2354: keep arbiter ReplSet name when serverStatus has none
eslavyansky Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions src/go/mongolib/proto/master_doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,25 @@
package proto

type MasterDoc struct {
SetName interface{} `bson:"setName"`
Hosts interface{} `bson:"hosts"`
Msg string `bson:"msg"`
SetName interface{} `bson:"setName"`
Hosts interface{} `bson:"hosts"`
Msg string `bson:"msg"`
ArbiterOnly bool `bson:"arbiterOnly"`
Me string `bson:"me"`
Arbiters []string `bson:"arbiters"`
}

func (md MasterDoc) IsArbiter() bool {
if md.ArbiterOnly {
return true
}
if md.Me == "" {
return false
}
for _, a := range md.Arbiters {
if a == md.Me {
return true
}
}
return false
}
22 changes: 20 additions & 2 deletions src/go/mongolib/util/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,17 @@ func GetReplicasetMembers(ctx context.Context, clientOptions *options.ClientOpti
}
m.StateStr = strings.ToUpper(cmdOpts.Parsed.Sharding.ClusterRole)

if md, mdErr := GetMasterDoc(ctx, client); mdErr == nil && md.IsArbiter() {
if m.StateStr != "" {
m.StateStr += "/ARBITER"
} else {
m.StateStr = "ARBITER"
}
if setName, ok := md.SetName.(string); ok {
m.Set = setName
}
}

if serverStatus, err := GetServerStatus(ctx, client); err == nil {
m.ID = serverStatus.Pid
m.StorageEngine = serverStatus.StorageEngine
Expand Down Expand Up @@ -537,9 +548,16 @@ func fillProcInfo(pid int32, procInfo *proto.ProcInfo) error {
return nil
}

func getNodeType(ctx context.Context, client *mongo.Client) (string, error) {
func GetMasterDoc(ctx context.Context, client *mongo.Client) (proto.MasterDoc, error) {
md := proto.MasterDoc{}
if err := client.Database("admin").RunCommand(ctx, primitive.M{"isMaster": 1}).Decode(&md); err != nil {
err := client.Database("admin").RunCommand(ctx, primitive.M{"isMaster": 1}).Decode(&md)

return md, err
}

func getNodeType(ctx context.Context, client *mongo.Client) (string, error) {
md, err := GetMasterDoc(ctx, client)
if err != nil {
return "", err
}

Expand Down
72 changes: 49 additions & 23 deletions src/go/pt-mongodb-summary/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ type hostInfo struct {
ReplicasetName string
Version string
NodeType string
IsArbiter bool
}

type procInfo struct {
Expand Down Expand Up @@ -365,12 +366,14 @@ func formatResults(ci *collectedInfo, format string) ([]byte, error) {
default:
buf = new(bytes.Buffer)

t := template.Must(template.New("mongos").Parse(templates.MongosInfo))
if err := t.Execute(buf, ci.MongosInfo); err != nil {
return nil, errors.Wrap(err, "cannot parse mongos section of the output template")
if ci.MongosInfo != nil {
t := template.Must(template.New("mongos").Parse(templates.MongosInfo))
if err := t.Execute(buf, ci.MongosInfo); err != nil {
return nil, errors.Wrap(err, "cannot parse mongos section of the output template")
}
}

t = template.Must(template.New("replicas").Parse(templates.Replicas))
t := template.Must(template.New("replicas").Parse(templates.Replicas))
if err := t.Execute(buf, ci.ReplicaMembers); err != nil {
return nil, errors.Wrap(err, "cannot parse replicas section of the output template")
}
Expand All @@ -385,14 +388,18 @@ func formatResults(ci *collectedInfo, format string) ([]byte, error) {
return nil, errors.Wrap(err, "cannot parse the command line args section of the output template")
}

t = template.Must(template.New("runningOps").Parse(templates.RunningOps))
if err := t.Execute(buf, ci.RunningOps); err != nil {
return nil, errors.Wrap(err, "cannot parse runningOps section of the output template")
if ci.RunningOps != nil {
t = template.Must(template.New("runningOps").Parse(templates.RunningOps))
if err := t.Execute(buf, ci.RunningOps); err != nil {
return nil, errors.Wrap(err, "cannot parse runningOps section of the output template")
}
}

t = template.Must(template.New("ssl").Parse(templates.Security))
if err := t.Execute(buf, ci.SecuritySettings); err != nil {
return nil, errors.Wrap(err, "cannot parse ssl section of the output template")
if ci.SecuritySettings != nil {
t = template.Must(template.New("ssl").Parse(templates.Security))
if err := t.Execute(buf, ci.SecuritySettings); err != nil {
return nil, errors.Wrap(err, "cannot parse ssl section of the output template")
}
}

if ci.OplogInfo != nil && len(ci.OplogInfo) > 0 {
Expand All @@ -416,24 +423,43 @@ func formatResults(ci *collectedInfo, format string) ([]byte, error) {
return buf.Bytes(), nil
}

func newArbiterHostInfo(md proto.MasterDoc) *hostInfo {
setName, _ := md.SetName.(string)

return &hostInfo{
NodeType: "ARBITER",
Hostname: md.Me,
ReplicasetName: setName,
IsArbiter: true,
}
}

func getHostInfo(ctx context.Context, client *mongo.Client) (*hostInfo, error) {
var i *hostInfo

hi := proto.HostInfo{}
if err := client.Database("admin").RunCommand(ctx, primitive.M{"hostInfo": 1}).Decode(&hi); err != nil {
log.Debugf("run('hostInfo') error: %s", err)

return nil, errors.Wrap(err, "GetHostInfo.hostInfo")
}

nodeType, _ := getNodeType(ctx, client)
procCount, _ := countMongodProcesses()
md, mdErr := util.GetMasterDoc(ctx, client)
if mdErr != nil || !md.IsArbiter() {
return nil, errors.Wrap(err, "GetHostInfo.hostInfo")
}

i := &hostInfo{
Hostname: hi.System.Hostname,
HostOsType: hi.Os.Type,
HostSystemCPUArch: hi.System.CpuArch,
ProcProcessCount: procCount,
NodeType: nodeType,
CmdlineArgs: nil,
i = newArbiterHostInfo(md)
i.ProcProcessCount, _ = countMongodProcesses()
} else {
nodeType, _ := getNodeType(ctx, client)
procCount, _ := countMongodProcesses()

i = &hostInfo{
Hostname: hi.System.Hostname,
HostOsType: hi.Os.Type,
HostSystemCPUArch: hi.System.CpuArch,
ProcProcessCount: procCount,
NodeType: nodeType,
CmdlineArgs: nil,
}
}

var cmdOpts proto.CommandLineOptions
Expand All @@ -454,7 +480,7 @@ func getHostInfo(ctx context.Context, client *mongo.Client) (*hostInfo, error) {
if err == nil {
i.ProcessName = ss.Process
i.Version = ss.Version
if ss.Repl != nil {
if ss.Repl != nil && ss.Repl.SetName != "" {
i.ReplicasetName = ss.Repl.SetName
}

Expand Down
8 changes: 8 additions & 0 deletions src/go/pt-mongodb-summary/templates/hostinfo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ const HostInfo = `# This host
Hostname | {{.Hostname}}
Version | {{.Version}}
Built On | {{.HostOsType}} {{.HostSystemCPUArch}}
{{- if not .ProcCreateTime.IsZero }}
Started | {{.ProcCreateTime}}
{{- end }}
{{- if .DBPath }}
Datadir | {{.DBPath}}
{{- end }}
Expand All @@ -35,5 +37,11 @@ const HostInfo = `# This host
{{- if .ReplicasetName }}
ReplSet | {{.ReplicasetName}}
Repl Status |
{{- end }}
{{- if .IsArbiter }}

# Arbiter ###############################################################################################
This node is a replica-set ARBITER: it holds no data, so host, security, storage and
running operations details are unavailable from this member.
{{- end -}}
`