Skip to content

Commit a5198df

Browse files
pleshakovkate-osbornciarams87sjberman
committed
Add logging guidelines for developers
Problem: The project doesn't include logging guidelines. As a result, there is risk the logging: (1) Evolves chaotically. (2) Not adequately addresses both users and developer needs. Solution: Add logging guidelines for developers. Solves #547 Co-authored-by: Kate Osborn <50597707+kate-osborn@users.noreply.github.com> Co-authored-by: Ciara Stacke <18287516+ciarams87@users.noreply.github.com> Co-authored-by: Saylor Berman <s.berman@f5.com>
1 parent 36daa1d commit a5198df

File tree

2 files changed

+426
-6
lines changed

2 files changed

+426
-6
lines changed

docs/developer/go-style-guide.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -352,12 +352,7 @@ panic(fmt.Errorf("unknown event type %T", e))
352352

353353
## Logging
354354

355-
> **Note**
356-
> This section is a work in progress.
357-
358-
NKG uses [logr](https://pkg.go.dev/github.com/go-logr/logr) for its logging library. Each component that logs should
359-
inherit their logger from the main process using
360-
the [`WithName`](https://pkg.go.dev/github.com/go-logr/logr#hdr-Logger_Names) function.
355+
See the [Logging guidelines](logging-guidelines.md) document.
361356

362357
## Concurrency
363358

0 commit comments

Comments
 (0)