package command import ( "flag" "fmt" "net" "strings" "github.com/hashicorp/serf/cmd/serf/command/agent" "github.com/mitchellh/cli" "github.com/ryanuber/columnize" ) // MembersCommand is a Command implementation that queries a running // Serf agent what members are part of the cluster currently. type MembersCommand struct { Ui cli.Ui } var _ cli.Command = &MembersCommand{} // A container of member details. Maintaining a command-specific struct here // makes sense so that the agent.Member struct can evolve without changing the // keys in the output interface. type Member struct { detail bool Name string `json:"name"` Addr string `json:"addr"` Port uint16 `json:"port"` Tags map[string]string `json:"tags"` Status string `json:"status"` Proto map[string]uint8 `json:"protocol"` } type MemberContainer struct { Members []Member `json:"members"` } func (c MemberContainer) String() string { var result []string for _, member := range c.Members { tags := strings.Join(agent.MarshalTags(member.Tags), ",") line := fmt.Sprintf("%s|%s|%s|%s", member.Name, member.Addr, member.Status, tags) if member.detail { line += fmt.Sprintf( "|Protocol Version: %d|Available Protocol Range: [%d, %d]", member.Proto["version"], member.Proto["min"], member.Proto["max"]) } result = append(result, line) } return columnize.SimpleFormat(result) } func (c *MembersCommand) Help() string { helpText := ` Usage: serf members [options] Outputs the members of a running Serf agent. Options: -detailed Additional information such as protocol verions will be shown (only affects text output format). -format If provided, output is returned in the specified format. Valid formats are 'json', and 'text' (default) -name= If provided, only members matching the regexp are returned. The regexp is anchored at the start and end, and must be a full match. -role= If provided, output is filtered to only nodes matching the regular expression for role '-role' is deprecated in favor of '-tag role=foo'. The regexp is anchored at the start and end, and must be a full match. -status= If provided, output is filtered to only nodes matching the regular expression for status -tag = If provided, output is filtered to only nodes with the tag with value matching the regular expression. tag can be specified multiple times to filter on multiple keys. The regexp is anchored at the start and end, and must be a full match. -rpc-addr=127.0.0.1:7373 RPC address of the Serf agent. -rpc-auth="" RPC auth token of the Serf agent. ` return strings.TrimSpace(helpText) } func (c *MembersCommand) Run(args []string) int { var detailed bool var roleFilter, statusFilter, nameFilter, format string var tags []string cmdFlags := flag.NewFlagSet("members", flag.ContinueOnError) cmdFlags.Usage = func() { c.Ui.Output(c.Help()) } cmdFlags.BoolVar(&detailed, "detailed", false, "detailed output") cmdFlags.StringVar(&roleFilter, "role", "", "role filter") cmdFlags.StringVar(&statusFilter, "status", "", "status filter") cmdFlags.StringVar(&format, "format", "text", "output format") cmdFlags.Var((*agent.AppendSliceValue)(&tags), "tag", "tag filter") cmdFlags.StringVar(&nameFilter, "name", "", "name filter") rpcAddr := RPCAddrFlag(cmdFlags) rpcAuth := RPCAuthFlag(cmdFlags) if err := cmdFlags.Parse(args); err != nil { return 1 } // Deprecation warning for role if roleFilter != "" { c.Ui.Output("Deprecation warning: 'Role' has been replaced with 'Tags'") tags = append(tags, fmt.Sprintf("role=%s", roleFilter)) } reqtags, err := agent.UnmarshalTags(tags) if err != nil { c.Ui.Error(fmt.Sprintf("Error: %s", err)) return 1 } client, err := RPCClient(*rpcAddr, *rpcAuth) if err != nil { c.Ui.Error(fmt.Sprintf("Error connecting to Serf agent: %s", err)) return 1 } defer client.Close() members, err := client.MembersFiltered(reqtags, statusFilter, nameFilter) if err != nil { c.Ui.Error(fmt.Sprintf("Error retrieving members: %s", err)) return 1 } result := MemberContainer{} for _, member := range members { addr := net.TCPAddr{IP: member.Addr, Port: int(member.Port)} result.Members = append(result.Members, Member{ detail: detailed, Name: member.Name, Addr: addr.String(), Port: member.Port, Tags: member.Tags, Status: member.Status, Proto: map[string]uint8{ "min": member.DelegateMin, "max": member.DelegateMax, "version": member.DelegateCur, }, }) } output, err := formatOutput(result, format) if err != nil { c.Ui.Error(fmt.Sprintf("Encoding error: %s", err)) return 1 } c.Ui.Output(string(output)) return 0 } func (c *MembersCommand) Synopsis() string { return "Lists the members of a Serf cluster" }