module Logbuch

Overview

Method tracing for Crystal.

Defined in:

Constant Summary

DEPTH_CEILING = 256_u32

The deepest any traced value nests, also through a Logbuch.convert in a to_trace, so converting it neither overflows the stack nor grows the tracer's path without bound. A max_depth above it fails to compile or raises.

MAX_CAP = 100_u32

Items logged from one collection; the rest are counted.

MAX_DEPTH = 16_u32

Nesting depth of objects, structs and collections in one traced value; deeper ones are logged as their identity, such as "o-17". See Tracer for the values that take a level.

MAX_LENGTH = 1024_u32

Characters logged from one string; the rest are counted.

VERSION = {{ (`shards version \"/home/runner/work/logbuch/logbuch/src/..\"`).chomp.stringify }}

The shard's version, which shards version reads from its shard.yml when the program compiles.

Class Method Summary

• .convert(value, *, detail : Detail = Detail::Summary) : Log::Metadata::Value

  Converts value into trace data at detail, as a traced method logs it.

• .settings : Settings

  The settings in effect.

Macro Summary

• configure(&block)

  Changes the settings: the block runs with a Configuration as its receiver, and the settings it names change, the others stay.

Class Method Detail

Logbuch.convert(order, detail: :full)

Macro Detail

Logbuch.configure do
  max_depth 3
  max_cap 50
end