Skip to content

Add logging guidelines for developers #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2023
Merged

Add logging guidelines for developers #905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions docs/developer/go-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,12 +352,7 @@ panic(fmt.Errorf("unknown event type %T", e))

## Logging

> **Note**
> This section is a work in progress.

NKG uses [logr](https://pkg.go.dev/github.com/go-logr/logr) for its logging library. Each component that logs should
inherit their logger from the main process using
the [`WithName`](https://pkg.go.dev/github.com/go-logr/logr#hdr-Logger_Names) function.
See the [Logging guidelines](logging-guidelines.md) document.

## Concurrency

Expand Down
Loading