Mattermost-server: Refactor "app/email.go" to use structured logging

Created on 24 Sep 2019  路  6Comments  路  Source: mattermost/mattermost-server

Mattermost is refactoring the logs to be fully structured and we're looking for contributors to help with that effort. This Help Wanted issue is to change the usages of mlog. methods with fmt.Sprintf to proper mlog.Field() calls in file app/email.go.

The expected way to implement it is to open the file app/email.go, look for all calls to mlog.Info, mlog.Debug, etc and in cases where fmt.Sprintf is used to write the log - modify the call to use mlog.Bool, mlog.String, etc to pass the parameters, instead of passing them as part of the format string to Sprintf.

Example: https://github.com/mattermost/mattermost-server/pull/12038


If you're interested please comment here and come join our "Contributors" community channel on our daily build server, where you can discuss questions with community members and the Mattermost core team. For technical advice or questions, please join our "Developers" community channel.

New contributors please see our Developer's Guide.

JIRA: https://mattermost.atlassian.net/browse/MM-18274

AreTechnical Debt Easy Hacktoberfest Help Wanted PR Exists TecGo

Most helpful comment

@hanzei yes, it always contains the the string for the link.

All 6 comments

@mattermod would also love to work on this.

Thanks @Lumexralph

@hanzei line 430 of app/email.go file, bodyPage.Props["Link"] returns an interface, is there any situation its doesn't hold a string?

@hanzei A PR is up for this, please kindly review and any feedback will be appreciated.

@jespino Do you know what Props["Link"] can contain?

@hanzei yes, it always contains the the string for the link.

Was this page helpful?
0 / 5 - 0 ratings