Add slog support #1627

sagikazarmark · 2023-09-11T22:39:44Z

This PR adds log/slog support the following way:

On Go 1.21 and above you can use log/slog as usual
On Go 1.20 and below Viper falls back to golang.org/x/exp/slog

Under the hood, Viper uses github.com/sagikazarmark/slog-shim to provide support slog on Go 1.20 and below.

At the same time, this PR breaks backwards compatibility with github.com/spf13/jwalterweatherman. Enabling logging through jww no longer works after this change, but since there are no compile errors the only result is no logs being output.

Enabling logging is possible by using the new WithLogger option:

v := viper.NewWithOptions(viper.WithLogger(slog.Default()))

Further changes:

Trace level logs are now logged as Debug
The previously experimental WithLogger option is changed to accept an *slog.Logger and is now publicly available
Logger interface is deprecated and no longer in use (will be removed in a later release)

Fixes #1270
Fixes #1372

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

github-actions · 2023-09-11T22:39:59Z

👋 Thanks for contributing to Viper! You are awesome! 🎉

A maintainer will take a look at your pull request shortly. 👀

In the meantime: We are working on Viper v2 and we would love to hear your thoughts about what you like or don't like about Viper, so we can improve or fix those issues.

⏰ If you have a couple minutes, please take some time and share your thoughts: https://forms.gle/R6faU74qPRPAzchZ9

📣 If you've already given us your feedback, you can still help by spreading the news,
either by sharing the above link or telling people about this on Twitter:

https://twitter.com/sagikazarmark/status/1306904078967074816

Thank you! ❤️

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/viper](https://togithub.com/spf13/viper) | require | minor | `v1.16.0` -> `v1.17.0` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>spf13/viper (github.com/spf13/viper)</summary> ### [`v1.17.0`](https://togithub.com/spf13/viper/releases/tag/v1.17.0) [Compare Source](https://togithub.com/spf13/viper/compare/v1.16.0...v1.17.0) #### Major changes Highlighting some of the changes for better visibility. Please share your feedback in the Discussion forum. Thanks! ❤️ ##### Minimum Go version: 1.19 Viper now requires Go 1.19 This change ensures we can stay up to date with modern practices and dependencies. ##### `log/slog` support **\[BREAKING]** Viper [v1.11.0](https://togithub.com/spf13/viper/releases/tag/v1.11.0) added an experimental `Logger` interface to allow custom implementations (besides [jwalterweatherman](https://togithub.com/spf13/jwalterweatherman)). In addition, it also exposed an experimental `WithLogger` function allowing to set a custom logger. This release deprecates that interface in favor of [log/slog](https://pkg.go.dev/log/slog) released in Go 1.21. > \[!WARNING] > `WithLogger` accepts an [\*slog.Logger](https://pkg.go.dev/log/slog#Logger) from now on. To preserve backwards compatibility with older Go versions, prior to Go 1.21 Viper accepts a [\*golang.org/x/exp/slog.Logger](https://pkg.go.dev/golang.org/x/exp/slog#Logger). The experimental flag is removed. ##### New finder implementation **\[BREAKING]** As of this release, Viper uses a new library to look for files, called [locafero](https://togithub.com/sagikazarmark/locafero). The new library is better covered by tests and has been built from scratch as a general purpose file finder library. The implementation is experimental and is hidden behind a `finder` build tag. > \[!WARNING] > The `io/fs` based implementation (that used to be hidden behind a `finder` build tag) has been removed. #### What's Changed ##### Exciting New Features 🎉 - Add NATS support by [@hooksie1](https://togithub.com/hooksie1) in [https://github.com/spf13/viper/pull/1590](https://togithub.com/spf13/viper/pull/1590) - Add slog support by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1627](https://togithub.com/spf13/viper/pull/1627) ##### Enhancements 🚀 - chore: add local development environment using nix by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1572](https://togithub.com/spf13/viper/pull/1572) - feat: add func GetEnvPrefix by [@baruchiro](https://togithub.com/baruchiro) in [https://github.com/spf13/viper/pull/1565](https://togithub.com/spf13/viper/pull/1565) - Improve dev env by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1575](https://togithub.com/spf13/viper/pull/1575) - fix: code optimization by [@testwill](https://togithub.com/testwill) in [https://github.com/spf13/viper/pull/1557](https://togithub.com/spf13/viper/pull/1557) - test: remove not needed testutil.Setenv by [@alexandear](https://togithub.com/alexandear) in [https://github.com/spf13/viper/pull/1610](https://togithub.com/spf13/viper/pull/1610) - new finder library based on afero by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1625](https://togithub.com/spf13/viper/pull/1625) - refactor: make use of `strings.Cut` by [@scop](https://togithub.com/scop) in [https://github.com/spf13/viper/pull/1650](https://togithub.com/spf13/viper/pull/1650) ##### Breaking Changes 🛠 - feat: drop support for Go 1.17 by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1574](https://togithub.com/spf13/viper/pull/1574) ##### Dependency Updates ⬆️ - build(deps): bump mheap/github-action-required-labels from 4 to 5 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1563](https://togithub.com/spf13/viper/pull/1563) - build(deps): bump github.com/stretchr/testify from 1.8.3 to 1.8.4 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1558](https://togithub.com/spf13/viper/pull/1558) - build(deps): bump cachix/install-nix-action from 21 to 22 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1573](https://togithub.com/spf13/viper/pull/1573) - build(deps): bump github.com/pelletier/go-toml/v2 from 2.0.8 to 2.0.9 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1586](https://togithub.com/spf13/viper/pull/1586) - chore: upgrade crypt by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1589](https://togithub.com/spf13/viper/pull/1589) - build(deps): bump actions/checkout from 3.5.3 to 4.0.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1616](https://togithub.com/spf13/viper/pull/1616) - build(deps): bump github/codeql-action from 2.21.2 to 2.21.5 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1615](https://togithub.com/spf13/viper/pull/1615) - build(deps): bump github.com/pelletier/go-toml/v2 from 2.0.9 to 2.1.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1614](https://togithub.com/spf13/viper/pull/1614) - build(deps): bump actions/dependency-review-action from 3.0.6 to 3.0.8 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1605](https://togithub.com/spf13/viper/pull/1605) - build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1604](https://togithub.com/spf13/viper/pull/1604) - build(deps): bump actions/setup-go from 4.0.1 to 4.1.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1593](https://togithub.com/spf13/viper/pull/1593) - build(deps): bump github.com/subosito/gotenv from 1.4.2 to 1.6.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1603](https://togithub.com/spf13/viper/pull/1603) - build(deps): bump cachix/install-nix-action from 22 to 23 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1620](https://togithub.com/spf13/viper/pull/1620) - chore(deps): update crypt by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1621](https://togithub.com/spf13/viper/pull/1621) - build(deps): bump actions/dependency-review-action from 3.0.8 to 3.1.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1623](https://togithub.com/spf13/viper/pull/1623) - Bump minimum Go version to 1.19 by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1626](https://togithub.com/spf13/viper/pull/1626) - build(deps): bump github/codeql-action from 2.21.5 to 2.21.6 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1632](https://togithub.com/spf13/viper/pull/1632) - build(deps): bump github/codeql-action from 2.21.6 to 2.21.7 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1634](https://togithub.com/spf13/viper/pull/1634) - build(deps): bump actions/checkout from 4.0.0 to 4.1.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1641](https://togithub.com/spf13/viper/pull/1641) - build(deps): bump github.com/spf13/afero from 1.9.5 to 1.10.0 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1640](https://togithub.com/spf13/viper/pull/1640) - build(deps): bump github/codeql-action from 2.21.7 to 2.21.8 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1638](https://togithub.com/spf13/viper/pull/1638) - build(deps): bump github/codeql-action from 2.21.8 to 2.21.9 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/viper/pull/1648](https://togithub.com/spf13/viper/pull/1648) - chore(deps): update crypt by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1652](https://togithub.com/spf13/viper/pull/1652) ##### Other Changes - \[StepSecurity] ci: Harden GitHub Actions by [@step-security-bot](https://togithub.com/step-security-bot) in [https://github.com/spf13/viper/pull/1592](https://togithub.com/spf13/viper/pull/1592) - Add Vitess to list of projects using Viper by [@systay](https://togithub.com/systay) in [https://github.com/spf13/viper/pull/1619](https://togithub.com/spf13/viper/pull/1619) - docs: fix typos in comments by [@alexandear](https://togithub.com/alexandear) in [https://github.com/spf13/viper/pull/1609](https://togithub.com/spf13/viper/pull/1609) - ci: add Go 1.21 to the test matrix by [@sagikazarmark](https://togithub.com/sagikazarmark) in [https://github.com/spf13/viper/pull/1622](https://togithub.com/spf13/viper/pull/1622) - Remove usages of deprecated io/ioutil; simplify viper tests by [@alexandear](https://togithub.com/alexandear) in [https://github.com/spf13/viper/pull/1631](https://togithub.com/spf13/viper/pull/1631) - chore: remove deprecated build tags by [@alexandear](https://togithub.com/alexandear) in [https://github.com/spf13/viper/pull/1630](https://togithub.com/spf13/viper/pull/1630) - refactor: replace 'interface{}' with 'any' by [@alexandear](https://togithub.com/alexandear) in [https://github.com/spf13/viper/pull/1646](https://togithub.com/spf13/viper/pull/1646) - test: refactor asserts by [@alexandear](https://togithub.com/alexandear) in [https://github.com/spf13/viper/pull/1644](https://togithub.com/spf13/viper/pull/1644) - docs: add set subset KV example by [@yhliyr](https://togithub.com/yhliyr) in [https://github.com/spf13/viper/pull/1647](https://togithub.com/spf13/viper/pull/1647) - Make deps fixes by [@bersace](https://togithub.com/bersace) in [https://github.com/spf13/viper/pull/1628](https://togithub.com/spf13/viper/pull/1628) #### New Contributors - [@goldeneggg](https://togithub.com/goldeneggg) made their first contribution in [https://github.com/spf13/viper/pull/1561](https://togithub.com/spf13/viper/pull/1561) - [@baruchiro](https://togithub.com/baruchiro) made their first contribution in [https://github.com/spf13/viper/pull/1565](https://togithub.com/spf13/viper/pull/1565) - [@testwill](https://togithub.com/testwill) made their first contribution in [https://github.com/spf13/viper/pull/1557](https://togithub.com/spf13/viper/pull/1557) - [@step-security-bot](https://togithub.com/step-security-bot) made their first contribution in [https://github.com/spf13/viper/pull/1592](https://togithub.com/spf13/viper/pull/1592) - [@systay](https://togithub.com/systay) made their first contribution in [https://github.com/spf13/viper/pull/1619](https://togithub.com/spf13/viper/pull/1619) - [@alexandear](https://togithub.com/alexandear) made their first contribution in [https://github.com/spf13/viper/pull/1609](https://togithub.com/spf13/viper/pull/1609) - [@hooksie1](https://togithub.com/hooksie1) made their first contribution in [https://github.com/spf13/viper/pull/1590](https://togithub.com/spf13/viper/pull/1590) - [@yhliyr](https://togithub.com/yhliyr) made their first contribution in [https://github.com/spf13/viper/pull/1647](https://togithub.com/spf13/viper/pull/1647) - [@bersace](https://togithub.com/bersace) made their first contribution in [https://github.com/spf13/viper/pull/1628](https://togithub.com/spf13/viper/pull/1628) - [@scop](https://togithub.com/scop) made their first contribution in [https://github.com/spf13/viper/pull/1650](https://togithub.com/spf13/viper/pull/1650) **Full Changelog**: spf13/viper@v1.16.0...v1.17.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekday,after 9am and before 5pm" in timezone America/Los_Angeles, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/trussworks/setup-new-aws-user).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

mainly this: spf13/viper#1627

feat: add slog support

ea83533

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

sagikazarmark added kind/enhancement New feature or request release-note/breaking-change Release note: Breaking Changes release-note/new-feature Release note: Exciting New Features labels Sep 11, 2023

sagikazarmark added 3 commits September 12, 2023 00:48

feat: deprecate logger interface

2d2cd1f

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

refactor: drop unused jww code

76d0539

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

fix: lint violations

3f800d5

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

sagikazarmark added this to the v1.17.0 milestone Sep 11, 2023

sagikazarmark merged commit 58b177a into master Sep 13, 2023
17 checks passed

sagikazarmark deleted the logger branch September 13, 2023 14:25

Ejeziemsam mentioned this pull request Oct 9, 2023

build(deps): bump github.com/spf13/viper from 1.15.0 to 1.17.0 tenet-org/tenet-public#118

Closed

spezifisch pushed a commit to spezifisch/stmps that referenced this pull request Oct 26, 2023

go1.19 is new minimum because of viper dep

fa9dfdb

mainly this: spf13/viper#1627

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add slog support #1627

Add slog support #1627

sagikazarmark commented Sep 11, 2023 •

edited

Loading

github-actions bot commented Sep 11, 2023

Add slog support #1627

Add slog support #1627

Conversation

sagikazarmark commented Sep 11, 2023 • edited Loading

github-actions bot commented Sep 11, 2023

sagikazarmark commented Sep 11, 2023 •

edited

Loading