Skip to content
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.

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

Feat: Modify log modular output #203

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
20 changes: 20 additions & 0 deletions internal/ccontrol/CmdArgParser.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ var (
FlagHoldTime string
FlagConfigFilePath string
FlagJson bool
FlagLoggerName string
FlagLogLevel string

RootCmd = &cobra.Command{
Use: "ccontrol",
Expand Down Expand Up @@ -161,6 +163,18 @@ var (
}
},
}

1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
updateLoggerCmd = &cobra.Command{
Use: "logger [flags]",
Short: "Modify node logger log level",
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
Long: "",
Run: func(cmd *cobra.Command, args []string) {
if err := ChangeLoggerState(FlagNodeName, FlagLoggerName, FlagLogLevel); err != util.ErrorSuccess {
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
os.Exit(err)
}
},
}

holdCmd = &cobra.Command{
Use: "hold [flags] job_id[,job_id...]",
Short: "prevent specified job from starting. ",
Expand Down Expand Up @@ -250,6 +264,12 @@ func init() {
return
}
}
updateCmd.AddCommand(updateLoggerCmd)
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
{
updateLoggerCmd.Flags().StringVarP(&FlagNodeName, "node-name", "n", "cranectld", "Specify names of the node to be modified(cranectld or real craned name)")
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
updateLoggerCmd.Flags().StringVarP(&FlagLoggerName, "logger-name", "m", "all", "Specify logger name of the node to be modified")
updateLoggerCmd.Flags().StringVarP(&FlagLogLevel, "logger-level", "l", "trace", "Specify logger level")
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
}
}
RootCmd.AddCommand(holdCmd)
{
Expand Down
57 changes: 57 additions & 0 deletions internal/ccontrol/ccontrol.go
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,18 @@ func SummarizeReply(proto interface{}) util.CraneCmdError {
}
return util.ErrorSuccess
case *protos.ModifyCranedStateReply:
if len(reply.ModifiedNodes) > 0 {
fmt.Printf("Nodes %v logger level modified successfully.\n", reply.ModifiedNodes)
}
if len(reply.NotModifiedNodes) > 0 {
for i := 0; i < len(reply.NotModifiedNodes); i++ {
_, _ = fmt.Fprintf(os.Stderr, "Failed to modify node logger: %s. Reason: %s.\n",
reply.NotModifiedNodes[i], reply.NotModifiedReasons[i])
}
return util.ErrorBackend
}
return util.ErrorSuccess
case *protos.SetLoggerLevelReply:
if len(reply.ModifiedNodes) > 0 {
fmt.Printf("Nodes %v modified successfully.\n", reply.ModifiedNodes)
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
}
Expand Down Expand Up @@ -656,3 +668,48 @@ func ChangeNodeState(nodeRegex string, state string, reason string) util.CraneCm

return SummarizeReply(reply)
}

func ChangeLoggerState(inputNodesName, logger, logLevel string) util.CraneCmdError {
nodeNames, ok := util.ParseHostList(inputNodesName)
if !ok {
log.Errorf("Invalid node pattern: %s.\n", inputNodesName)
return util.ErrorCmdArg
}

if len(nodeNames) == 0 {
log.Errorln("No node provided.")
return util.ErrorCmdArg
}

if err := util.CheckLogLevel(logLevel); err != nil {
log.Errorf("Invalid level: %v.\n", err)
return util.ErrorCmdArg
}
logger = strings.ToLower(logger)
if err := util.CheckLoggerName(nodeNames, logger); err != nil {
log.Errorf("Invalid logger: %v.\n", err)
return util.ErrorCmdArg
}

req := &protos.SetLoggerLevelRequest{
NodeName: nodeNames,
Logger: FlagLoggerName,
LogLevel: logLevel,
}
reply, err := stub.SetLoggerLevel(context.Background(), req)
if err != nil {
log.Errorf("Failed to modify node logger: %v.\n", err)
return util.ErrorNetwork
}

if FlagJson {
fmt.Println(util.FmtJson.FormatReply(reply))
if len(reply.NotModifiedNodes) == 0 {
return util.ErrorSuccess
} else {
return util.ErrorBackend
}
}

return SummarizeReply(reply)
}
52 changes: 52 additions & 0 deletions internal/util/log.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
package util

import (
"fmt"
"strings"

nested "github.com/antonfisher/nested-logrus-formatter"
log "github.com/sirupsen/logrus"
)
Expand All @@ -38,3 +41,52 @@ func InitLogger(level string) {
log.SetReportCaller(false)
log.SetFormatter(&nested.Formatter{})
}

func CheckLogLevel(strLevel string) error {
validLogLevels := map[string]struct{}{
"trace": {},
"debug": {},
"info": {},
"warn": {},
"error": {},
"critical": {},
}

validLevelsStr := strings.Join([]string{"trace", "debug", "info", "warn", "error", "critical"}, ", ")
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved

if _, exists := validLogLevels[strLevel]; !exists {
return fmt.Errorf("invalid log level: %v. Valid log levels are: %s", strLevel, validLevelsStr)
}

return nil
}
func CheckLoggerName(nodeNames []string, strLoggerName string) error {
// cranectld valid logger
cranectldLoggerNames := map[string]struct{}{
"all": {},
"cranedkeeper": {},
"taskscheduler": {},
"default": {},
}
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved

cranedLoggerNames := map[string]struct{}{
"default": {},
}

var validLogNames map[string]struct{}
if len(nodeNames) == 1 && strings.ToLower(nodeNames[0]) == "cranectld" {
validLogNames = cranectldLoggerNames
} else {
validLogNames = cranedLoggerNames
}
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved

if _, exists := validLogNames[strLoggerName]; !exists {
validNames := make([]string, 0, len(validLogNames))
for name := range validLogNames {
validNames = append(validNames, name)
}
return fmt.Errorf("invalid logger %v. Valid loggers are: %v", strLoggerName, strings.Join(validNames, ", "))
}

return nil
}
26 changes: 26 additions & 0 deletions protos/Crane.proto
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,14 @@ message CancelTaskReply {
repeated string not_cancelled_reasons = 4;
}

message SetCranedLoggerLevelRequest {
string logger = 1;
string log_level = 2;
1daidai1 marked this conversation as resolved.
Show resolved Hide resolved
}

message SetCranedLoggerLevelReply {
bool ok = 1;
}

message QueryTaskIdFromPortRequest{
uint32 port = 1;
Expand Down Expand Up @@ -690,6 +698,18 @@ message StreamCforedTaskIOReply {
}
}

message SetLoggerLevelRequest {
repeated string node_name = 1;
string logger = 2;
string log_level = 3;
}

message SetLoggerLevelReply {
repeated string modified_nodes = 1;
repeated string not_modified_nodes = 2;
repeated string not_modified_reasons = 3;
}

// Todo: Divide service into two parts: one for Craned and one for Crun
// We need to distinguish the message sender
// and have some kind of authentication
Expand Down Expand Up @@ -728,6 +748,9 @@ service CraneCtld {
/* RPCs called from cinfo */
rpc QueryClusterInfo(QueryClusterInfoRequest) returns (QueryClusterInfoReply);

/* RPCs called from logger */
rpc SetLoggerLevel(SetLoggerLevelRequest) returns (SetLoggerLevelReply);

/* common RPCs */
rpc QueryTasksInfo(QueryTasksInfoRequest) returns (QueryTasksInfoReply);
}
Expand Down Expand Up @@ -756,6 +779,9 @@ service Craned {
/* ----------------------------------- Called from Craned ------------------------------------------------------ */
rpc QueryTaskIdFromPort(QueryTaskIdFromPortRequest) returns (QueryTaskIdFromPortReply);

/* RPCs called from logger */
rpc SetCranedLoggerLevel(SetCranedLoggerLevelRequest) returns (SetCranedLoggerLevelReply);

/* ----------------------------------- Called from Pam Module --------------------------------------------------- */
rpc QueryTaskIdFromPortForward(QueryTaskIdFromPortForwardRequest) returns (QueryTaskIdFromPortForwardReply);
rpc MigrateSshProcToCgroup(MigrateSshProcToCgroupRequest) returns (MigrateSshProcToCgroupReply);
Expand Down