Post launch Log level control for the Server #4880

edwbuck · 2024-02-13T16:17:49Z

Code for server log level adjustment is complete and functional. Unit tests are being added. Core solution is ready for initial review.

Affected functionality
After the spire server is running, one can request its logger caracteristics with the command

spire-server logger get

Which will output the current logger details

Logger Level  : info
Logger Default: info

Where Logger Level indicates the current logger's level and Logger Default indicates the logger's level according to the configuration at server launch time.

To adjust the log level, on can use the command

spire-server logger set -level debug

Which will adjust the logger's log level and return the updated logger details

Logger Level  : debug
Logger Default: info

Supported logger set values include (panic, fatal, error, warn, info, debug, trace, and default). default will set the Logger Level to the value held in Logger Default

Logger adjustments for the spire-agent will be added soon. Currently, I'm updating the unit testing to obtain more code coverage. Functionality has only been manually tested.

spire-server logger set

Is a no-op, as no directive on what to set (or what value to set it to) is provided.

Description of change
The spire-server executable has two new cli commands logger get and logger set which access the dynamically configurable logger.

logger get builds a grpc call (loggerv1) logger.GetLogger in the new spire-api-sdk logger (v1) api, as detailed in PR spiffe/spire-api-sdk#55

logger set may, if -level <value> is passed, build a grpc call (loggerv1) logger.SetLogLevel, detailed in the same PR spiffe/spire-api-sdk#55

The spire server then processes the request, adjusts the logrus logger level, and returns the system's Logger details, which indicates both the logger's current level and the logger's default level.

azdagron

Thanks @edwbuck. Here's some preliminary feedback.

pkg/common/api/middleware/names.go

cmd/spire-server/cli/run/run.go

pkg/server/endpoints/config.go

pkg/server/endpoints/endpoints.go

pkg/server/api/logger/v1/service.go

cmd/spire-server/cli/logger/printers.go

pkg/server/api/logger/v1/service.go

edwbuck · 2024-03-06T13:04:59Z

@azdagron All checks passing except the docker ones which are failing on the UID:GID processing not properly populating (an issue being looked at in #4903)

azdagron

Looks good. Thanks for the contribution, @edwbuck.

MarcosDY · 2024-03-07T18:41:27Z

cmd/spire-server/cli/logger/mocks_test.go

+}
+
+// mock implementation for GetLogger
+func (s *mockLoggerServer) GetLogger(_ context.Context, _ *loggerv1.GetLoggerRequest) (*types.Logger, error) {


Suggested change

func (s *mockLoggerServer) GetLogger(_ context.Context, _ *loggerv1.GetLoggerRequest) (*types.Logger, error) {

func (s *mockLoggerServer) GetLogger(context.Context, *loggerv1.GetLoggerRequest) (*types.Logger, error) {

MarcosDY · 2024-03-07T18:41:58Z

cmd/spire-server/cli/logger/mocks_test.go

+	return s.returnLogger, s.returnErr
+}
+
+func (s *mockLoggerServer) ResetLogLevel(_ context.Context, _ *loggerv1.ResetLogLevelRequest) (*types.Logger, error) {


Suggested change

func (s *mockLoggerServer) ResetLogLevel(_ context.Context, _ *loggerv1.ResetLogLevelRequest) (*types.Logger, error) {

func (s *mockLoggerServer) ResetLogLevel(context.Context, *loggerv1.ResetLogLevelRequest) (*types.Logger, error) {

MarcosDY · 2024-03-07T18:44:52Z

cmd/spire-server/cli/logger/set.go

+// The routine that executes the command
+func (c *setCommand) Run(ctx context.Context, _ *commoncli.Env, serverClient util.ServerClient) error {
+	if c.newLevel == "" {
+		return fmt.Errorf("a value (-level) must be set")


Suggested change

return fmt.Errorf("a value (-level) must be set")

return errors.New("a value (-level) must be set")

MarcosDY · 2024-03-07T18:48:26Z

cmd/spire-server/cli/logger/set.go

+		}
+		apiLevel, found := serverlogger.APILevel[logrusLevel]
+		if !found {
+			return fmt.Errorf("the logrus level %d could not be transformed into an api log level", logrusLevel)


mmm decimal has not too much value for a user, what do you think about returning level that is string instead?

If you look carefully, this is an error message for returning a log level that doesn't have an associated string

MarcosDY · 2024-03-07T18:52:05Z

cmd/spire-server/cli/logger/set.go

+	level := strings.ToLower(c.newLevel)
+	var logger *apitype.Logger
+	var err error
+	if level == "launch" {


it is confusing to me to have launch to reset as part of level,
may we add a reset option instead?

--resetLevel

in case we want to keep using launch, I think we must add more documentation about what that launch means

MarcosDY · 2024-03-07T19:17:14Z

pkg/server/api/logger/v1/service.go

+	if req.NewLevel == apitype.LogLevel_UNSPECIFIED {
+		return nil, fmt.Errorf("Invalid request, NewLevel value cannot be LogLevel_UNSPECIFIED")
+	}
+	service.log.WithFields(logrus.Fields{


same as previous function can you get logger from context and use that to add logs?
the service.Log must be used only to change levels
you can get it using:

ctxLog := rpccontext.Logger(ctx)

MarcosDY · 2024-03-07T19:20:33Z

pkg/server/api/logger/v1/service.go

+}
+
+func (service *Service) SetLogLevel(_ context.Context, req *loggerv1.SetLogLevelRequest) (*apitype.Logger, error) {
+	if req.NewLevel == apitype.LogLevel_UNSPECIFIED {


can you add:

rpccontext.AddRPCAuditFields(ctx, logrus.Fields{telemetry.LogLevel: req.NewLevel})

this is to add get parammeters to audit logs

MarcosDY · 2024-03-07T19:21:20Z

pkg/server/api/logger/v1/service.go

+		CurrentLevel: APILevel[service.log.GetLevel()],
+		LaunchLevel:  APILevel[service.launchLevel],
+	}
+	return logger, nil


can you add? (it is to execute audit log)

rpccontext.AuditRPC(ctx)

MarcosDY · 2024-03-07T19:22:39Z

pkg/server/api/logger/v1/service.go

+}
+
+func (service *Service) ResetLogLevel(_ context.Context, _ *loggerv1.ResetLogLevelRequest) (*apitype.Logger, error) {
+	service.log.Info("ResetLogLevel Called")


can you use logger from context?

MarcosDY · 2024-03-07T19:24:31Z

pkg/server/api/logger/v1/service.go

+		CurrentLevel: APILevel[service.log.GetLevel()],
+		LaunchLevel:  APILevel[service.launchLevel],
+	}
+	return logger, nil


can you add? (it is to execute audit log)

rpccontext.AuditRPC(ctx)

Add list command to cli. Add some of the receiving services in the server "run" instance. Add the "registry" of loggers (currently a btree) Beginning unit testing on naming ordering. Signed-off-by: Edwin Buck <[email protected]>

Signed-off-by: Edwin Buck <[email protected]>

JSON now outputs log levels as their logrus lower-case strings. Some unit testing on logger.get cli commands. Signed-off-by: Edwin Buck <[email protected]>

Complete unit testing for spire-server cli. Signed-off-by: Edwin Buck <[email protected]>

Signed-off-by: Edwin Buck <[email protected]>

logrus.Logger. Signed-off-by: Edwin Buck <[email protected]>

The Logger service fields are now private, the service config fields remain public. The Logger variable / field names are now log (or Log) to match conventions. The logger package now adds a Logger type which extends the logrus.Logger interface with set log level and get log level funcs. Signed-off-by: Edwin Buck <[email protected]>

This fixes the inability of this unit test to intialize the new GRPC logger service, as it requires a Logger type that also includes the ability to change log levels. Signed-off-by: Edwin Buck <[email protected]>

Signed-off-by: Edwin Buck <[email protected]>

endpoints_test.go Signed-off-by: Edwin Buck <[email protected]>

is fixed. Removed allow_admin from policy_data.json until determination can be made to make this allow_admin Signed-off-by: Edwin Buck <[email protected]>

Signed-off-by: Edwin Buck <[email protected]>

edwbuck requested review from evan2645, amartinezfayo, azdagron, MarcosDY and rturner3 as code owners February 13, 2024 16:17

azdagron reviewed Feb 21, 2024

View reviewed changes

amartinezfayo assigned azdagron Feb 27, 2024

azdagron reviewed Mar 4, 2024

View reviewed changes

cmd/spire-server/cli/logger/printers.go Outdated Show resolved Hide resolved

azdagron reviewed Mar 5, 2024

View reviewed changes

pkg/server/api/logger/v1/service.go Outdated Show resolved Hide resolved

azdagron added this to the 1.9.1 milestone Mar 5, 2024

edwbuck changed the title ~~Post launch Log level control~~ Post launch Log level control for the Server Mar 6, 2024

azdagron previously approved these changes Mar 6, 2024

View reviewed changes

MarcosDY reviewed Mar 7, 2024

View reviewed changes

edwbuck added 16 commits March 11, 2024 10:05

Initial support for dynamically adjustable log levels.

b1c09c0

Add list command to cli. Add some of the receiving services in the server "run" instance. Add the "registry" of loggers (currently a btree) Beginning unit testing on naming ordering. Signed-off-by: Edwin Buck <[email protected]>

Fixed logical error in comment.

660ef92

Signed-off-by: Edwin Buck <[email protected]>

Functional for get and set logger commands.

0d9355a

Signed-off-by: Edwin Buck <[email protected]>

Adjustments to improve JSON output formatting.

adef016

JSON now outputs log levels as their logrus lower-case strings. Some unit testing on logger.get cli commands. Signed-off-by: Edwin Buck <[email protected]>

Realign to final spire-api-sdk api.

57f3da0

Complete unit testing for spire-server cli. Signed-off-by: Edwin Buck <[email protected]>

Rework server commands to use new API

e274962

Signed-off-by: Edwin Buck <[email protected]>

Fix off-by one log level setting, introduced with new API change.

25ef540

Signed-off-by: Edwin Buck <[email protected]>

Fix the issue of not configuring the log.Logger (from pkg) or

801e8af

logrus.Logger. Signed-off-by: Edwin Buck <[email protected]>

Add the RootLog field to the config in the endpoints_test.go.

0355b90

This fixes the inability of this unit test to intialize the new GRPC logger service, as it requires a Logger type that also includes the ability to change log levels. Signed-off-by: Edwin Buck <[email protected]>

Minor adjustements to conform with go's linting policies.

5aa92ff

Signed-off-by: Edwin Buck <[email protected]>

Fixes for small code review points. Additions for testing under

10ac0f9

endpoints_test.go Signed-off-by: Edwin Buck <[email protected]>

Flipped all testing of various access methods to true until issue 4940

2c35b8b

is fixed. Removed allow_admin from policy_data.json until determination can be made to make this allow_admin Signed-off-by: Edwin Buck <[email protected]>

Add Logger GRPC Service unit testing.

daeb76d

Signed-off-by: Edwin Buck <[email protected]>

Fix lint issues.

b5c6058

Signed-off-by: Edwin Buck <[email protected]>

Fix unit test that was unnoticed as the test was cached.

9966197

Signed-off-by: Edwin Buck <[email protected]>

edwbuck added 4 commits March 11, 2024 11:21

Fix unit tests on windows.

d07317e

Signed-off-by: Edwin Buck <[email protected]>

goimport get_posix_test.go

e4d675f

Signed-off-by: Edwin Buck <[email protected]>

goimport format the windows test data in get_windows_test.go

d8ea93d

Signed-off-by: Edwin Buck <[email protected]>

Fix windows unit testing of logger set cli command.

1c5c144

Signed-off-by: Edwin Buck <[email protected]>

MarcosDY dismissed azdagron’s stale review via 1c5c144 March 11, 2024 14:23

MarcosDY force-pushed the log_level branch from f83da8d to 1c5c144 Compare March 11, 2024 14:23

azdagron approved these changes Mar 11, 2024

View reviewed changes

azdagron merged commit a8d547c into spiffe:main Mar 11, 2024
32 checks passed

rushi47 pushed a commit to rushi47/spire that referenced this pull request Apr 11, 2024

Post launch Log level control for the Server (spiffe#4880)

e957ec1

Signed-off-by: Edwin Buck <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Post launch Log level control for the Server #4880

Post launch Log level control for the Server #4880

edwbuck commented Feb 13, 2024

azdagron left a comment

edwbuck commented Mar 6, 2024

azdagron left a comment

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

edwbuck Mar 13, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

MarcosDY Mar 7, 2024

	func (s mockLoggerServer) GetLogger(_ context.Context, _ loggerv1.GetLoggerRequest) (*types.Logger, error) {
	func (s mockLoggerServer) GetLogger(context.Context, loggerv1.GetLoggerRequest) (*types.Logger, error) {

	func (s mockLoggerServer) ResetLogLevel(_ context.Context, _ loggerv1.ResetLogLevelRequest) (*types.Logger, error) {
	func (s mockLoggerServer) ResetLogLevel(context.Context, loggerv1.ResetLogLevelRequest) (*types.Logger, error) {

	return fmt.Errorf("a value (-level) must be set")
	return errors.New("a value (-level) must be set")

Post launch Log level control for the Server #4880

Post launch Log level control for the Server #4880

Conversation

edwbuck commented Feb 13, 2024

azdagron left a comment

Choose a reason for hiding this comment

edwbuck commented Mar 6, 2024

azdagron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment