Remove logrus #50829

rosstimothy · 2025-01-07T16:48:23Z

The only remaining use of logrus is from integrations, which is unfortunately imported by teleport.e, and prevents logrus from being moved to an indirect dependency. The logrus formatter and initialization of the logrus logger will remain in place until integrations is using slog. To prevent any accidental inclusions of logrus within the teleport module the depguard rules have been updated to prohibit importing logrus. The rules also include prohibit a few common log packages that tools like gopls might automatically import.

$ go mod why github.com/sirupsen/logrus
# github.com/sirupsen/logrus
github.com/gravitational/teleport/integrations/access/common/auth
github.com/sirupsen/logrus

Includes https://github.com/gravitational/teleport.e/pull/5807
Depends on #50805

rosstimothy · 2025-01-08T14:20:40Z

lib/utils/log/handle_state.go

@@ -114,13 +113,6 @@ func (s *handleState) appendAttr(a slog.Attr) bool {
 				}
 			}
 			return nonEmpty
-		case logrus.Fields:


There is nothing including these fields in slog output so this is not needed.

rosstimothy · 2025-01-08T14:20:56Z

lib/utils/log/levels.go

This was moved into utils/log/slog.go

rosstimothy · 2025-01-08T14:21:22Z

lib/utils/log/logrus_formatter.go

The items deleted were moved into lib/utils/log/slog.go to facilitate removing this file in the future.

rosstimothy · 2025-01-08T14:21:59Z

tool/tbot/spiffe.go

 )

+// TODO(tross/noah): Remove once go-spiff has a slog<->workloadapi.Logger adapter.


FYI @strideynet. If you have a better solution to this in the short term I'm all ears.

I have a ticket w/ go-spiffe to add slog support - spiffe/go-spiffe#281 - perhaps link this ticket here?

What you've done here is good for now!

codingllama

Nice! We are almost 100% logrus-free!

.golangci.yml

e

lib/utils/log/slog.go

codingllama · 2025-01-08T18:40:17Z

tool/tbot/spiffe.go

+	//nolint:sloglint // msg cannot be constant
+	l.l.DebugContext(context.Background(), fmt.Sprintf(format, args...))


Maybe:

l.log(slog.LevelDebug, format, args...)

and implement the l.log function so it centralized the nolint / fmt.Sprintf logic?

tool/tbot/spiffe.go

tool/teleport/common/teleport.go

The only remaining use of logrus is from integrations, which is unfortunately imported by teleport.e, and prevents logrus from being moved to an indirect dependency. The logrus formatter and initialization of the logrus logger will remain in place until integrations is using slog. To prevent any accidental inclusions of logrus within the teleport module the depguard rules have been updated to prohibit importing logrus. The rules also include prohibit a few common log packages that tools like gopls might automatically import.

Consolidates configuring of global loggers to a single function. This is mainly to facilitate configuring the logger for teleport scp, but will also allow us to remove the copy of logger initialization that currently exists in integrations/lib/logger.

bl-nero · 2025-01-09T10:16:22Z

lib/client/api.go

+// sharedWriter is an [io.Writer] implementation that protects
+// writes with a mutex. This allows a single [io.Writer] to be shared
+// by both logrus and slog without their output clobbering each other.
+type sharedWriter struct {


So what hapeened / will happen to lib/utils/log.SharedWriter? Is it being moved here? Why don't I see it being deleted in this PR?

(Also, since this file is already huge, can this struct remain in a separate one?)

log.SharedWriter is going to be removed with the logrus formatter once we are no longer using logrus. I opted to copy it locally here preemptively since a little bit of copying is better than a little bit of dependency.

bl-nero · 2025-01-09T10:25:58Z

lib/config/configuration.go

-		cfg.Console = io.Discard // disable console printing
-	case "stdout", "out", "1":
-		w = os.Stdout
+	case "stderr", "error", "2", "stdout", "out", "1":


I'm having a hard time understanding what's going on here. Why do we disable console printing when the user wants to print to the console? I know it wasn't commented in the original code either, but I still think it warrants a word or two.

The documentation comments of Config.Console and Config.Logger don't help too much, either, as they both sound like serving roughly the same purpose.

Looking at Console more closely, I don't actually see it being used anywhere. For now I'm going to leave this as is and in a follow up PR I will remove it entirely.

Maybe keep the cases for "" and teleport.Syslog in the meantime? Is the case for teleport.Syslog obsolete too?

"" and teleport.Syslog are handled by log.Initialize.

Follow up PRs to remove Console:

Remove unused servicecfg.Config.Console field #50944

https://github.com/gravitational/teleport.e/pull/5829

tool/teleport/common/teleport.go

codingllama · 2025-01-09T14:06:22Z

lib/config/configuration.go

-		cfg.Console = io.Discard // disable console printing
-	case "stdout", "out", "1":
-		w = os.Stdout
+	case "stderr", "error", "2", "stdout", "out", "1":


Maybe keep the cases for "" and teleport.Syslog in the meantime? Is the case for teleport.Syslog obsolete too?

lib/utils/log/log.go

integrations/lib/logger/logger.go

codingllama · 2025-01-09T14:18:05Z

lib/utils/log/slog.go

+
+// ValidateFields ensures the provided fields map to the allowed fields. An error
+// is returned if any of the fields are invalid.
+func ValidateFields(formatInput []string) (result []string, err error) {


Could this be made private and made a responsibility of Initialize? Perhaps after the duplicated code on integrations/ is removed?

Possibly. I will look into it once the integrations changes are made.

tool/teleport/common/teleport.go

rosstimothy added the no-changelog Indicates that a PR does not require a changelog entry label Jan 7, 2025

rosstimothy force-pushed the tross/config_slog branch from 55173a4 to 3a6dea2 Compare January 7, 2025 17:46

rosstimothy force-pushed the tross/remove_config_logrus branch 2 times, most recently from 737af4b to 7bcf7bb Compare January 7, 2025 18:44

Base automatically changed from tross/config_slog to master January 7, 2025 20:29

rosstimothy force-pushed the tross/remove_config_logrus branch 5 times, most recently from 0a31c37 to 9ed50e3 Compare January 8, 2025 14:19

rosstimothy commented Jan 8, 2025

View reviewed changes

rosstimothy force-pushed the tross/remove_config_logrus branch 4 times, most recently from d02cea6 to f9c7fa5 Compare January 8, 2025 17:47

rosstimothy marked this pull request as ready for review January 8, 2025 18:05

github-actions bot added machine-id size/sm tctl tctl - Teleport admin tool tsh tsh - Teleport's command line tool for logging into nodes running Teleport. labels Jan 8, 2025

github-actions bot requested review from bl-nero and strideynet January 8, 2025 18:06

rosstimothy requested a review from codingllama January 8, 2025 18:09

codingllama reviewed Jan 8, 2025

View reviewed changes

rosstimothy force-pushed the tross/remove_config_logrus branch from f9c7fa5 to e0433c8 Compare January 8, 2025 21:27

rosstimothy added 2 commits January 8, 2025 18:38

Refactor logger initialization

95ca8b2

Consolidates configuring of global loggers to a single function. This is mainly to facilitate configuring the logger for teleport scp, but will also allow us to remove the copy of logger initialization that currently exists in integrations/lib/logger.

fix: document ValidateFields

839b31b

rosstimothy force-pushed the tross/remove_config_logrus branch from c31858f to 839b31b Compare January 8, 2025 23:38

strideynet approved these changes Jan 9, 2025

View reviewed changes

bl-nero reviewed Jan 9, 2025

View reviewed changes

rosstimothy requested a review from codingllama January 9, 2025 14:13

codingllama reviewed Jan 9, 2025

View reviewed changes

rosstimothy added 2 commits January 9, 2025 11:10

fix: remove copied yaml tags

d7f25f0

fix: update file path comment

e71186e

rosstimothy requested a review from codingllama January 9, 2025 16:11

codingllama approved these changes Jan 9, 2025

View reviewed changes

rosstimothy added this pull request to the merge queue Jan 9, 2025

Merged via the queue into master with commit 2aed5bf Jan 9, 2025
42 checks passed

rosstimothy deleted the tross/remove_config_logrus branch January 9, 2025 17:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove logrus #50829

Remove logrus #50829

rosstimothy commented Jan 7, 2025 •

edited

Loading

rosstimothy Jan 8, 2025

rosstimothy Jan 8, 2025

rosstimothy Jan 8, 2025

rosstimothy Jan 8, 2025

strideynet Jan 8, 2025 •

edited

Loading

codingllama left a comment

codingllama Jan 8, 2025

bl-nero Jan 9, 2025

rosstimothy Jan 9, 2025

bl-nero Jan 9, 2025

rosstimothy Jan 9, 2025

codingllama Jan 9, 2025

rosstimothy Jan 9, 2025 •

edited

Loading

rosstimothy Jan 10, 2025

codingllama Jan 9, 2025

codingllama Jan 9, 2025

rosstimothy Jan 9, 2025

		)

		// TODO(tross/noah): Remove once go-spiff has a slog<->workloadapi.Logger adapter.

		//nolint:sloglint // msg cannot be constant
		l.l.DebugContext(context.Background(), fmt.Sprintf(format, args...))

Remove logrus #50829

Remove logrus #50829

Conversation

rosstimothy commented Jan 7, 2025 • edited Loading

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

strideynet Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

codingllama 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

rosstimothy Jan 9, 2025 • edited Loading

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

rosstimothy commented Jan 7, 2025 •

edited

Loading

strideynet Jan 8, 2025 •

edited

Loading

rosstimothy Jan 9, 2025 •

edited

Loading