Control Gorouter log level using debugserver reconfigurable sink #495

navinms711 · 2025-06-20T08:15:50Z

Summary

[1] Briefly explain why this PR is necessary

Gorouter uses slog with zap handler as backend for current logging levels. The Gorouter runs a debugserver (a http server) which listens to a few API endpoints. The /log-level -d <debug/info/error/fatal> was introduced to make changes to the log level on demand at runtime. However, a POST request to the log-level endpoint has no effect in the current code. This PR proposes changes needed to make log level change work through a POST request.

[2] Provide details of where this request is coming from including links, GitHub Issues, etc..

This is a request from Broadcom Engineering team to fix it and recorded in TNZ-23119.

[3] Provide details of prior work (if applicable) including links to commits, github issues, etc...

cloudfoundry/gorouter#452

[4] Backward Compatibility

Breaking Change? NO

[5] If this is a breaking change, or modifies currently expected behaviors of core functionality.

[6] Are there any other dependent PRs?

Yes, this PR needs the latest changes to debugserver code in cloudfoundry/debugserver#73

linux-foundation-easycla · 2025-06-20T08:15:56Z

The committers listed above are authorized under a signed CLA.

✅ login: navinms711 / name: Naveen Sreeramachandra (08feac8)

navinms711 · 2025-06-20T08:18:33Z

src/code.cloudfoundry.org/vendor/code.cloudfoundry.org/debugserver/server.go

@@ -42,6 +43,27 @@ func DebugAddress(flags *flag.FlagSet) string {
 	return dbgFlag.Value.String()
 }

+func validateloglevelrequest(w http.ResponseWriter, r *http.Request, level []byte) error {


I'll remove this change in the vendor copy of debugserver/server.go. This change will be part of another PR for debugserver repo.

Thanks for calling this out. You can remove this change, and link the related PR in the main section. Regular contributors will know how to bump the submodules with multiple linked PRs.

If you've already made the change in the debugserver you can just add a commit on top of this PR to bump to dependency and re-vendor to make this PR self-contained.

The other PR is still not merged cloudfoundry/debugserver#73. I'll get that merged first.

navinms711 · 2025-06-20T08:28:55Z

Following log entries are seen in the /var/vcap/sys/log/gorouter/gorouter.stdout.log for various inputs on the Router VM.

$ curl http://127.0.0.1:17002/log-level -d info
✅ /log-level was invoked with Level: info

time=2025-06-20T07:46:21.091Z level=INFO msg="Gorouter logger -> zapcore log level updated." new-level=info

$ curl http://127.0.0.1:17002/log-level -d debug
✅ /log-level was invoked with Level: debug

time=2025-06-20T07:46:21.091Z level=INFO msg="Gorouter logger -> zapcore log level updated." new-level=debug

$ curl -X GET http://127.0.0.1:17002/log-level -d info
method not allowed, use POST

$ curl -X PUT http://127.0.0.1:17002/log-level -d info
method not allowed, use POST

$ curl -X POST https://127.0.0.1:17002/log-level -d info
curl: (35) error:0A00010B:SSL routines::wrong version number

$ curl -X POST http://127.0.0.1:17002/log-level -d {}
Invalid log level provided: {}

$ curl -X POST http://127.0.0.1:17002/log-level
log level cannot be empty

src/code.cloudfoundry.org/gorouter/cmd/gorouter/main.go

src/code.cloudfoundry.org/gorouter/logger/logger.go

maxmoehl · 2025-06-23T08:22:20Z

src/code.cloudfoundry.org/vendor/code.cloudfoundry.org/debugserver/server.go

@@ -42,6 +43,27 @@ func DebugAddress(flags *flag.FlagSet) string {
 	return dbgFlag.Value.String()
 }

+func validateloglevelrequest(w http.ResponseWriter, r *http.Request, level []byte) error {


If you've already made the change in the debugserver you can just add a commit on top of this PR to bump to dependency and re-vendor to make this PR self-contained.

hoffmaen · 2025-06-23T09:48:56Z

Hello @navinms711 ,
Please do not pollute main.go with code to setup the sink for debugserver.
With cloudfoundry/gorouter#435, we have put a lot of effort to the code base to have a clean and simple abstraction of the zap handler, and we use slog throughout the code as the logging frontend. We have functions to dynamically set the WriteSyncer, which allows to setup a custom sink and to dynamically set the log level (used e.g. in the tests).
Please use the provided library and, if missing, put the code required to run the debugserver into a separate go file.

hoffmaen · 2025-06-23T16:32:23Z

One more thought: Instead of adding all that code to routing-release, couldn't you make the debugserver handle an slog logger instead of a lager logger?

navinms711 · 2025-07-03T10:03:21Z

One more thought: Instead of adding all that code to routing-release, couldn't you make the debugserver handle an slog logger instead of a lager logger?

I looked into this. To change the debugserver support slog instead of lager requires changing the SetMinLevel(level lager.LogLevel) signature and this breaks existing code in tcp-router, loggregator, etc. and the corresponding acceptance/integration tests needs re-written. All of this means much more changes in multiple repos. Hence decided to keep debugserver use lager logger and introduce adapter code (adapter.go) to handle log-level changes.

navinms711 · 2025-07-03T10:16:09Z

Hello @navinms711 , Please do not pollute main.go with code to setup the sink for debugserver. With cloudfoundry/gorouter#435, we have put a lot of effort to the code base to have a clean and simple abstraction of the zap handler, and we use slog throughout the code as the logging frontend. We have functions to dynamically set the WriteSyncer, which allows to setup a custom sink and to dynamically set the log level (used e.g. in the tests). Please use the provided library and, if missing, put the code required to run the debugserver into a separate go file.

I have moved most changes from main.go to adapter.go in the same main package, to keep changes to main.go to a minimum. The necessary integration tests are in main_test.go and it tests the full path from debugserver lager sink to zapcore config level. The following note will help understand the flow.

	// http://<>:<>/log-level -d {0, debug, DEBUG, d}
	// 		calls zapCtrl.SetMinLevel(lagerLogLevel) -> 0
	//		calls conf.level.SetLevel(zapcore.DebugLevel)
	// http://<>:<>/log-level -d {1, info, INFO, I}
	// 		calls zapCtrl.SetMinLevel(lagerLogLevel) -> 1
	//		calls conf.level.SetLevel(zapcore.InfoLevel)
	// http://<>:<>/log-level -d {2, warn, WARN, w}
	//		calls conf.level.SetLevel(zapcore.WarnLevel)
	// http://<>:<>/log-level -d {3, error, ERROR, e}
	// 		calls zapCtrl.SetMinLevel(lagerLogLevel) -> 2
	//		calls conf.level.SetLevel(zapcore.ErrorLevel)
	// http://<>:<>/log-level -d {4, fatal, FATAL, f}
	// 		calls zapCtrl.SetMinLevel(lagerLogLevel) -> 3
	//		calls conf.level.SetLevel(zapcore.FatalLevel)

All tests have passed.

Ran 189 of 189 Specs in 2100.664 seconds
SUCCESS! -- 189 Passed | 0 Failed | 1 Flaked | 0 Pending | 0 Skipped
PASS

src/code.cloudfoundry.org/gorouter/integration/test_utils_test.go

src/code.cloudfoundry.org/gorouter/cmd/gorouter/main.go

src/code.cloudfoundry.org/gorouter/cmd/gorouter/adapter.go

g modified: src/code.cloudfoundry.org/gorouter/test_util/helpers.go

navinms711 requested a review from a team as a code owner June 20, 2025 08:15

navinms711 commented Jun 20, 2025

View reviewed changes

cf-foundation-community-automation bot added this to Application Runtime Platform Working Group Jun 20, 2025

cf-foundation-community-automation bot moved this to Inbox in Application Runtime Platform Working Group Jun 20, 2025

navinms711 mentioned this pull request Jun 20, 2025

Add input validation to support dynamic changes to gorouter log level cloudfoundry/debugserver#73

Merged

ameowlia requested a review from hoffmaen June 20, 2025 20:26

maxmoehl reviewed Jun 23, 2025

View reviewed changes

navinms711 force-pushed the bugfix/debugserver-loglevel branch from ceef6d7 to d66a05d Compare July 3, 2025 09:51

ameowlia requested changes Jul 3, 2025

View reviewed changes

navinms711 force-pushed the bugfix/debugserver-loglevel branch 2 times, most recently from bb0cbd0 to 07a996b Compare July 11, 2025 22:34

Commit for TNZ-23119

08feac8

g modified: src/code.cloudfoundry.org/gorouter/test_util/helpers.go

navinms711 force-pushed the bugfix/debugserver-loglevel branch from 07a996b to 08feac8 Compare July 11, 2025 22:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Control Gorouter log level using debugserver reconfigurable sink #495

Control Gorouter log level using debugserver reconfigurable sink #495

Uh oh!

navinms711 commented Jun 20, 2025 •

edited

Loading

Uh oh!

linux-foundation-easycla bot commented Jun 20, 2025 •

edited

Loading

Uh oh!

navinms711 Jun 20, 2025 •

edited

Loading

Uh oh!

ameowlia Jun 20, 2025 •

edited

Loading

Uh oh!

maxmoehl Jun 23, 2025

Uh oh!

navinms711 Jul 3, 2025

Uh oh!

navinms711 commented Jun 20, 2025

Uh oh!

Uh oh!

Uh oh!

maxmoehl Jun 23, 2025

Uh oh!

hoffmaen commented Jun 23, 2025

Uh oh!

hoffmaen commented Jun 23, 2025

Uh oh!

navinms711 commented Jul 3, 2025 •

edited

Loading

Uh oh!

navinms711 commented Jul 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Control Gorouter log level using debugserver reconfigurable sink #495

Are you sure you want to change the base?

Control Gorouter log level using debugserver reconfigurable sink #495

Uh oh!

Conversation

navinms711 commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

linux-foundation-easycla bot commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

navinms711 Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ameowlia Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maxmoehl Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

navinms711 Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

navinms711 commented Jun 20, 2025

Uh oh!

Uh oh!

Uh oh!

maxmoehl Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

hoffmaen commented Jun 23, 2025

Uh oh!

hoffmaen commented Jun 23, 2025

Uh oh!

navinms711 commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

navinms711 commented Jul 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

navinms711 commented Jun 20, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jun 20, 2025 •

edited

Loading

navinms711 Jun 20, 2025 •

edited

Loading

ameowlia Jun 20, 2025 •

edited

Loading

navinms711 commented Jul 3, 2025 •

edited

Loading