Reference Index
Every public module in @chrismichaelps/pudu-lang-log@0.1.0, with its chapter.
| Module | Purpose | Chapter |
|---|---|---|
PuduLangLog |
Levels, values, templates, failures, events | Writing Events |
PuduLangLog.Logger |
Write events, derive contextual loggers, flush, close, reload | Getting Started |
PuduLangLog.Configuration |
Build a pipeline one decision at a time | Configuring Loggers |
PuduLangLog.LevelSwitch |
A minimum level changed while running | Configuring Loggers |
PuduLangLog.Pipeline |
The stages every event passes | Configuring Loggers |
PuduLangLog.Value |
Build captured values; Capturable
|
Writing Events |
PuduLangLog.Event |
Build, read, and change events | Writing Events |
PuduLangLog.Failure |
Errors attached to events | Writing Events |
PuduLangLog.Enricher |
Add properties to events | Enrichment And Context |
PuduLangLog.Context |
Properties for a stretch of work | Enrichment And Context |
PuduLangLog.Enrichers.Environment |
Machine, user, environment, and process properties | Enrichment And Context |
PuduLangLog.Enrichers.Masking |
Hide sensitive values | Enrichment And Context |
PuduLangLog.Filter |
Predicates and filters over events | Filtering And Expressions |
PuduLangLog.Expressions |
Compile expressions into predicates, properties, and formatters | Filtering And Expressions |
PuduLangLog.Formatting.Text |
Output templates | Formatting Output |
PuduLangLog.Formatting.Json |
JSON objects | Formatting Output |
PuduLangLog.Formatting.Compact |
Compact newline-delimited JSON | Formatting Output |
PuduLangLog.Formatting.Reader |
Compact JSON read back into events | Formatting Output |
PuduLangLog.Sink |
The sink record and its wrappers | Sinks |
PuduLangLog.Sinks.Console |
Console output with themes | Sinks |
PuduLangLog.Sinks.Theme |
Console colors | Sinks |
PuduLangLog.Sinks.File |
Rolling files with retention | Sinks |
PuduLangLog.Sinks.Http |
Batches posted over HTTP | Sinks |
PuduLangLog.Sinks.Batching |
Queued batches with retries | Sinks |
PuduLangLog.Sinks.Async |
Writing on a worker thread | Sinks |
PuduLangLog.Sinks.Memory |
Events kept in memory | Sinks |
PuduLangLog.Sinks.Map |
One sink per key | Sinks |
PuduLangLog.Sinks.Observable |
Events handed to observers | Sinks |
PuduLangLog.Settings |
Configure from key-value, JSON, and environment settings | Settings |
PuduLangLog.Settings.Registry |
Named sinks and enrichers for settings | Settings |
PuduLangLog.Web.RequestLogging |
One event per HTTP request | Web, Timing, And Bridge |
PuduLangLog.Web.Diagnostic |
Properties a handler adds to its request's event | Web, Timing, And Bridge |
PuduLangLog.Web.Correlation |
One identifier across a request | Web, Timing, And Bridge |
PuduLangLog.Timing |
Timed operations | Web, Timing, And Bridge |
PuduLangLog.Bridge |
Standard library logging routed into a logger | Web, Timing, And Bridge |
PuduLangLog.SelfLog |
Problems inside the pipeline | Diagnostics And Testing |
PuduLangLog.Clock |
System, UTC, fixed, and stepping clocks | Diagnostics And Testing |
PuduLangLog.Constants.Names |
Property names and default output templates | Formatting Output |
Modules under PuduLangLog.Domain and PuduLangLog.Expressions.* are the package's internals. Full function signatures carry /// documentation for the language server; hover any name in an editor to read it. The per-module design notes live in the repository wiki/src mirrors.
| Function | Chapter |
|---|---|
Configuration.create, createLogger, minimumLevel, writeTo, clock, Logger.close, forSource
|
Getting Started |
verbose, debug, information, warning, error, fatal, write, writeFailure, tryWrite, emit, isEnabled, bindTemplate, bindProperty, Value.of, Failure.of, Failure.causedBy, Failure.withTrace, Failure.describe
|
Writing Events |
Configuration.nested, controlledBy, overrideLevel, overrideSwitch, writeToAtLeast, writeToControlled, writeToWhen, writeToLogger, createReloadableLogger, Logger.reload, LevelSwitch.create, set, onChange
|
Configuring Loggers |
Enricher.property, computed, when, atLevel, atSwitch, Context.pushProperty, using, restore, enricher, Environment.environmentName, Masking.properties, Masking.sensitive, Masking.patterns
|
Enrichment And Context |
Filter.fromSource, withProperty, atLeast, allOf, not, Expressions.compile, evaluate, predicate, computed
|
Filtering And Expressions |
Text.template, Json.formatter, Compact.compact, Compact.rendered, Expressions.template, Reader.readLine, readAll, readFile
|
Formatting Output |
File.sink, Async.start, Async.sinkOf, Batching.sink, Map.sink, Map.byProperty, Observable.subscribe, writeToFallbackChain, writeToFallible, auditTo, Sink.of
|
Sinks |
Settings.fromJson, fromJsonFile, fromEnvironment, apply, switchNamed, argument, Registry.standard, withSink, withEnricher
|
Settings |
RequestLogging.handler, middleware, Diagnostic.set, setFailure, Correlation.middleware, loggerFor, enrich, Timing.beginWith, complete, abandon, Bridge.standard
|
Web, Timing, And Bridge |
SelfLog.create, enable, Clock.stepping, Memory.matching, Memory.latest
|
Diagnostics And Testing |