logging

package

v0.2.0 Latest Latest Go to latest Published: Sep 23, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/KLIXPERT-io/pay-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package logging builds PayCLI's slog logger.

Two rules shape it:

The destination is INJECTED. Only internal/cli/app.go may touch the process's standard streams (§3.1), so a logger is constructed with an io.Writer and every log line a command produces is capturable by a test.
Every attribute passes through internal/redact before it is formatted. `[logging] level = "debug"` / PAY_LOG_LEVEL=debug is the documented way to see what PayCLI sent, and the Authorization header is synthesised by the transport rather than read from configured headers, so the "configured headers are secret" rule never covered it (§5.3).

Index ¶

Constants
Variables
func Discard() *slog.Logger
func New(opts Options) *slog.Logger
func ParseFormat(s string) (string, error)
func ParseLevel(s string) (slog.Level, error)
func URL(key, raw string) slog.Attr
type Options

Constants ¶

View Source

const (
	FormatText = "text"
	FormatJSON = "json"
)

Format values for logging format / PAY_LOG_FORMAT.

View Source

const (
	LevelDebug = "debug"
	LevelInfo  = "info"
	LevelWarn  = "warn"
	LevelError = "error"
)

Level names for logging level / PAY_LOG_LEVEL.

Variables ¶

View Source

var (
	Levels  = []string{LevelDebug, LevelInfo, LevelWarn, LevelError}
	Formats = []string{FormatText, FormatJSON}
)

Levels and Formats are the closed sets, for validation and help.

Functions ¶

func Discard ¶

func Discard() *slog.Logger

Discard is a logger that writes nothing. Packages take a *slog.Logger rather than reaching for slog.Default, so tests hand them this.

func New ¶

func New(opts Options) *slog.Logger

New builds the logger. It never returns nil: an invalid level or format degrades to info/text, because failing to log is not a reason to fail a command. Validate with ParseLevel / ParseFormat when you want the error.

func ParseFormat ¶

func ParseFormat(s string) (string, error)

ParseFormat validates a log format name.

func ParseLevel ¶

func ParseLevel(s string) (slog.Level, error)

ParseLevel validates a level name.

func URL ¶

func URL(key, raw string) slog.Attr

URL is the helper every call site should use when logging a URL, so redaction cannot be forgotten (§5.3 requires it on every URL that crosses a boundary).

Types ¶

type Options ¶

type Options struct {
	// Output is where log lines go. A nil Output discards everything, which is
	// what tests and `--quiet` rely on.
	Output io.Writer
	// Level is one of Levels. Empty means info.
	Level string
	// Format is one of Formats. Empty means text.
	Format string
	// Verbose forces debug and Quiet forces error; Quiet wins, because
	// --quiet is an explicit request for silence.
	Verbose bool
	Quiet   bool
	// Secrets are literal credential values to scrub from every line, in
	// addition to the structural rules. The CLI passes the resolved API key
	// and any minted JWT.
	Secrets []string
	// AddSource includes file:line. Off by default: it doubles the size of a
	// debug transcript and helps nobody but a PayCLI developer.
	AddSource bool
}

Options configures New.

Source Files ¶

View all Source files

logging.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL