cloudfoundry / cloudfoundry/lager

Documentation misses key-aspects of how to use lager-logger

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Go
Stars
71
Forks
28
PR merge metrics
No merged PRs in 30d

Description

Current behavior

Dear development team.

To fix an issue in our software, we wanted to define minimum log-level. Unfortunately the usage-documentation misses instructions on how to do that.

That led to an unfruitful implementation-story where I discovered just at the moment when I wanted to file in a bug-report together with a fixing PR the structure of this repository and how to make use of its transformers (i.e. reconfigurableSink, redactingSink, truncatingSink). As this is a key-aspect of the design of lager-logger I personally think it should be part of the documentation. This would be highly valuable to its users and may safe them time.

Desired behavior

Key-concepts of the design of lager are explained in its usage-documentation.

Affected Version

all versions

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/usage.md and review the usage of the reconfigurableSink, redactingSink, and truncatingSink transformers mentioned in the issue. Document how to define a minimum log level and explain these key design concepts. Done means the usage documentation covers the requested lager features clearly for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.