feat: standardize logging #1302

zivkovicmilos · 2023-10-26T13:59:27Z

Description

This PR introduces log standardization across the codebase, to utilize the slog.Logger.

Since the gno repo currently utilizes go1.20 as the minimum version, this PR utilizes the golang.org/x/exp/log package.

Additionally, this PR removes log level management from the TM2 config, and instead moves it into the start command.

Closes #999

Thank you @gfanton for helping out with zap and simplifying the API 🙏
Special shoutout to @moul's zapconfig, for being an inspiration on zap setup.

BREAKING CHANGE:

the tm2/log logger interface has been removed, everything has been swapped to *slog.Logger

Example of different log levels:

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

zivkovicmilos · 2023-10-26T14:14:51Z

@gfanton @ajnavarro

Things we need to agree on:

logging creation API (should it be able to error out?)
default log levels
how do we manage test loggers? what's the output / level?
... ?

codecov · 2023-10-26T19:38:55Z

Codecov Report

Attention: 103 lines in your changes are missing coverage. Please review.

Comparison is base (87179b9) 55.80% compared to head (18727d8) 56.05%.
Report is 1 commits behind head on master.

Files	Patch %	Lines
tm2/pkg/log/testing.go	0.00%	49 Missing ⚠️
gno.land/pkg/integration/testing_integration.go	38.09%	12 Missing and 1 partial ⚠️
tm2/pkg/log/noop.go	0.00%	12 Missing ⚠️
gno.land/pkg/gnoland/app.go	0.00%	5 Missing ⚠️
gno.land/cmd/gnoland/start.go	85.18%	3 Missing and 1 partial ⚠️
gno.land/cmd/gnoweb/main.go	0.00%	3 Missing ⚠️
tm2/pkg/sdk/context.go	33.33%	2 Missing ⚠️
gno.land/pkg/gnoland/node_inmemory.go	0.00%	1 Missing ⚠️
gno.land/pkg/gnoweb/gnoweb.go	93.33%	1 Missing ⚠️
...pkg/bft/abci/example/kvstore/persistent_kvstore.go	50.00%	1 Missing ⚠️
... and 12 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1302      +/-   ##
==========================================
+ Coverage   55.80%   56.05%   +0.24%     
==========================================
  Files         435      436       +1     
  Lines       66056    66498     +442     
==========================================
+ Hits        36863    37274     +411     
- Misses      26320    26325       +5     
- Partials     2873     2899      +26

Flag	Coverage Δ
go-1.21.x	`∅ <ø> (∅)`
misc	`∅ <ø> (∅)`
misc-_test.genstd	`∅ <ø> (∅)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

zivkovicmilos · 2024-01-23T14:43:29Z

Pinging @moul to take a look at the discussions 🙏

zivkovicmilos · 2024-01-23T14:43:44Z

I've added a small go mod tidy script:

6471c93

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

zivkovicmilos · 2024-01-23T17:54:17Z

@moul

@gfanton has enabled the support for debug logs in the CI, so now we can grab CI log artifacts on a per-test basis 😎

moul · 2024-01-23T18:42:00Z

Makefile

@@ -45,3 +45,13 @@ fmt:
 .PHONY: lint
 lint:
 	$(rundep) github.com/golangci/golangci-lint/cmd/golangci-lint run --config .github/golangci.yml
+
+.PHONY: imports


can we merge in make fmt instead?

Merged:

7eb92d2

Updated CI:
7720593

We should think about goimports linting for *.gno imports in the future

moul · 2024-01-23T19:32:45Z

Makefile

+.PHONY: tidy
+tidy:
+	$(MAKE) --no-print-directory -C misc     tidy


Can you please double-check? I vaguely recall creating something similar, possibly only in the CI. Just ensure that there isn't already an existing solution for the same purpose.

It turns out we had not 1, but 2 tidy flows 🙂

Fixed:
9ab96d0 and a8fe8d3

## Description This PR fixes the `noop` log reference that was broken in #1574, after the #1302 PR was merged in earlier. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>

@gfanton

## Description This PR introduces log standardization across the codebase, to utilize the `slog.Logger`. Since the gno repo currently utilizes `go1.20` as the minimum version, this PR utilizes the `golang.org/x/exp/log` package. Additionally, this PR removes log level management from the TM2 config, and instead moves it into the start command. Closes gnolang#999 Thank you @gfanton for helping out with zap and simplifying the API 🙏 Special shoutout to @moul's [zapconfig](https://github.com/moul/zapconfig/tree/master), for being an inspiration on zap setup. **BREAKING CHANGE**: - the `tm2/log` logger interface has been removed, everything has been swapped to `*slog.Logger` Example of different log levels: ![cast](https://github.com/gnolang/gno/assets/16712663/2288ad98-7f72-4f05-b749-827b815b7f16) <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [ ] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> --------- Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com> Co-authored-by: gfanton <8671905+gfanton@users.noreply.github.com> Co-authored-by: Manfred Touron <94029+moul@users.noreply.github.com>

## Description This PR fixes the `noop` log reference that was broken in gnolang#1574, after the gnolang#1302 PR was merged in earlier. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>

zivkovicmilos added 3 commits October 26, 2023 09:52

Initial slog switch

72f96cc

Change log level

9328f52

Merge branch 'feat/standardized-logging' into feat/log

3abfc67

zivkovicmilos added the 🌱 feature New update to Gno label Oct 26, 2023

zivkovicmilos assigned ajnavarro, gfanton and zivkovicmilos Oct 26, 2023

github-actions bot added 📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related labels Oct 26, 2023

zivkovicmilos added 6 commits October 26, 2023 14:52

Drop the logger backend in tm2

a4449bd

Use custom zap config

c08de43

Use log level from config

035bbef

Merge branch 'master' into feat/log

e6dd5ac

Update workflows

dec3fed

Remove test case because of Go 1.21

9aa5d7d

zivkovicmilos added 5 commits October 26, 2023 17:40

Resolve faulty log lines

209041f

Revert go version change

568ff80

Merge master

be13b5d

Tidy go mods

b32ea84

Switch to /exp/log because of go 1.20

32603c2

zivkovicmilos added the breaking change Functionality that contains breaking changes label Jan 15, 2024

zivkovicmilos and others added 7 commits January 15, 2024 19:02

Update gnodev logger usage:

71787aa

Please the go mod gods

28bebde

Add logger err case

5db0ddb

Merge branch 'master' into feat/log

13fefe7

fix: use zap logger specific initialization

33f1934

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

Resolve API changes

75c7285

Tidy loop go mod

f23782f

Tidy go mods

6471c93

zivkovicmilos and others added 8 commits January 23, 2024 16:12

Output the log to a dir

86ad349

Update workflows

9e45196

fix: workflow debug env variable

301409a

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

fix: fixup gnoland logs

821c01d

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

fix(ci): glob every log file into the artifact archive

09d3ec0

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

wip: test ci full logging

de264d4

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

fix(log): replace slash by _ in log name to avoid sub-directory

6b9230c

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>

Enable debug artifacts

27e2383

moul reviewed Jan 23, 2024

View reviewed changes

zivkovicmilos added 6 commits January 24, 2024 10:14

Merge branch 'master' into feat/log

bac025e

Merge goimports format with 'fmt'

7eb92d2

Update fmt CI

7720593

Update tidy workflow

a8fe8d3

Simplify tidy workflows

9ab96d0

Add basic base config verification

89c7b62

michelleellen mentioned this pull request Jan 24, 2024

Minutes: Public Dev Calls [every Wednesday] gnolang/meetings#37

Open

Merge branch 'master' into feat/log

18727d8

thehowl mentioned this pull request Jan 25, 2024

Minutes: GitHub Review Meetings [every Thursday] gnolang/meetings#18

Open

3 tasks

moul merged commit da35d3c into master Jan 25, 2024
198 checks passed

moul deleted the feat/log branch January 25, 2024 17:38

zivkovicmilos mentioned this pull request Jan 25, 2024

fix: fix noop logger reference #1586

Merged

7 tasks

zivkovicmilos mentioned this pull request Jan 29, 2024

Minutes: Core Staff Weekly Syncs [every Monday] gnolang/meetings#36

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: standardize logging #1302

feat: standardize logging #1302

zivkovicmilos commented Oct 26, 2023 •

edited

Loading

zivkovicmilos commented Oct 26, 2023

codecov bot commented Oct 26, 2023 •

edited

Loading

zivkovicmilos commented Jan 23, 2024

zivkovicmilos commented Jan 23, 2024

zivkovicmilos commented Jan 23, 2024

moul Jan 23, 2024

zivkovicmilos Jan 24, 2024 •

edited

Loading

moul Jan 23, 2024

zivkovicmilos Jan 24, 2024

feat: standardize logging #1302

feat: standardize logging #1302

Conversation

zivkovicmilos commented Oct 26, 2023 • edited Loading

Description

zivkovicmilos commented Oct 26, 2023

codecov bot commented Oct 26, 2023 • edited Loading

Codecov Report

zivkovicmilos commented Jan 23, 2024

zivkovicmilos commented Jan 23, 2024

zivkovicmilos commented Jan 23, 2024

moul Jan 23, 2024

Choose a reason for hiding this comment

zivkovicmilos Jan 24, 2024 • edited Loading

Choose a reason for hiding this comment

moul Jan 23, 2024

Choose a reason for hiding this comment

zivkovicmilos Jan 24, 2024

Choose a reason for hiding this comment

zivkovicmilos commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 26, 2023 •

edited

Loading

zivkovicmilos Jan 24, 2024 •

edited

Loading