Index (Rainbow Gum 1.0.0-SNAPSHOT)

A B C D E F G H I J K L M N O P Q R S T U V W Y Z _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abbreviatorCache() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Whether keywords that can cache their output (currently just %logger{N} via its abbreviator) actually do so.
abbreviatorCache(PatternConfig.CacheType) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets abbreviatorCache.
AbstractBuilder() - Constructor for class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Do nothing constructor
AbstractBuilder() - Constructor for class io.jstach.rainbowgum.LogProperties.AbstractBuilder: Ignored.
AbstractBuilder() - Constructor for class io.jstach.rainbowgum.LogPublisher.AbstractBuilder: do nothing.
AbstractEncoder() - Constructor for class io.jstach.rainbowgum.LogEncoder.AbstractEncoder: Do nothing constructor.
AbstractFilteringLogger - Class in io.jstach.rainbowgum.slf4j.spi: A base class for LoggerDecoratorService implementations that need to filter or enrich log calls without depending on AbstractLogger's internal dispatch, whose stack depth to the real caller is an unversioned SLF4J implementation detail rather than something Rainbow Gum controls or tests.
AbstractFilteringLogger(LoggerDecoratorService.DepthAwareLogger) - Constructor for class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger: Creates a filtering logger wrapping the given delegate.
AbstractOutputStreamOutput(URI, OutputStream) - Constructor for class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput: Adapts an OutputStream to an Output.
AbstractRouter(String, LogPublisher, LevelResolver) - Constructor for class io.jstach.rainbowgum.LogRouter.AbstractRouter: Router tuple of publisher and resolver.
AbstractStandardEventFormatter - Class in io.jstach.rainbowgum.format: An abstract formatter where the actual full layout of the event is not a concern of the user and by default usually has the semi-standard layout of TTLL - Time, Thread, Level, Logger.
AbstractStandardEventFormatter(LogFormatter, LogFormatter, LogFormatter, LogFormatter, LogFormatter, LogFormatter, LogFormatter) - Constructor for class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: Override
AbstractStandardEventFormatter.AbstractBuilder<T> - Class in io.jstach.rainbowgum.format: Abstract TTLL Builder.
accept(KeyValues, String, String, int, V) - Method in interface io.jstach.rainbowgum.KeyValues.KeyValuesConsumer: Accepts the KeyValues at the current key and value.
accept(String, String) - Method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Same as KeyValues.MutableKeyValues.putKeyValue(String, String) but will ignore null keys from sources that have null keys.
Actuator - Section in Overview
add(LogFormatter) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Adds a formatter.
add(LogProperty.Result) - Method in class io.jstach.rainbowgum.LogProperty.Validator: Adds a result that must be present.
add(String, String) - Method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Fluent version of put.
add(String, String) - Method in interface io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues.Builder: Fluent form of BiConsumer.accept(Object, Object).
addIfError(LogProperty.Result) - Method in class io.jstach.rainbowgum.LogProperty.Validator: Adds a result only if it is a LogProperty.Result.Error; a LogProperty.Result.Missing result is silently ignored.
Adding a custom keyword - Section in package io.jstach.rainbowgum.pattern.format
Additivity - Section in Overview
addListener(LogAlerts.Listener) - Method in interface io.jstach.rainbowgum.LogAlerts: Registers a listener that is notified synchronously, in addition to the alert being recorded in the ring buffer, every time LogAlerts.alert(LogEvent) is called.
addLogger(Logger) - Method in class io.jstach.rainbowgum.jul.logmanager.RainbowGumLogManager
addProperty(Class, String) - Method in interface io.jstach.rainbowgum.LogReporter: Adds a property key whose current value is included in every report, attributed to the package of the given class.
alert(LogEvent) - Method in interface io.jstach.rainbowgum.LogAlerts: Records an alert.
ALERT - Enum constant in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.StrictType: Records an error alert for each key without the logging prefix.
alertFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.LogReporter.Options.Builder: Formatter used to render each alert entry when LogReporter.Section.ALERTS is included.
alerts() - Method in interface io.jstach.rainbowgum.LogConfig: Alerts about problems with the logging system itself (as opposed to application logging routed through the LogRouter).
Alerts - Section in Overview
ALERTS - Enum constant in enum class io.jstach.rainbowgum.LogReporter.Section: Recent entries from LogConfig.alerts(), see LogReporter.Options.Builder.maxAlerts(int).
ALERTS_CAPACITY_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Maximum number of alerts LogAlerts holds in its ring buffer.
ALERTS_FAIL_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Alert level at which starting Rainbow Gum fails, like treating compiler warnings as errors: see LogAlerts.FailLevel.
ALERTS_UNOBSERVED_ERRORS_ACTION_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: What LogAlerts does, once on start, if it has recorded at least one error alert and still has zero LogAlerts.Listeners registered - see LogAlerts.UnobservedErrorsAction for the three choices and LogAlerts.UnobservedErrorsAction.DUMP for the default.
ALERTS_UNUSED_KEY_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Alert level for property keys that were set but not read while starting: see LogAlerts.UnusedKeyLevel.
Alerts, Metrics, and Reporting - Section in Overview
alertsFail(LogAlerts.FailLevel) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets the alert level at which starting fails, used when the property "logging.alerts.fail" is absent.
alertsUnusedKey(LogAlerts.UnusedKeyLevel) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets the alert level of a property key nothing read, used when the property "logging.alerts.unusedKey" is absent.
aliases() - Method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey
aliases() - Method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey
aliases() - Method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry.PatternKey: Keyword names.
aliases() - Method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.SpringBootKey
ALL - Enum constant in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Dump collected alerts as in LogConfig.DebugModeType.INFO, and print a LogReporter report after Rainbow Gum starts.
allKeys() - Method in class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder: Selects all keys, in the order supplied by the event's key values.
ALLOW - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.ThreadLocalMode: Thread locals may be used.
allowedChanges(String) - Method in interface io.jstach.rainbowgum.LogConfig.ChangePublisher: Returns what the logger is allowed to change.
ansiDisabled() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Whether or not print escape outputs.
ansiDisabled(Boolean) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets ansiDisabled.
ansiMode() - Method in class io.jstach.rainbowgum.LogConfig.Globals: Whether output uses ANSI escape codes, from "logging.global.ansi.mode".
ansiMode(LogConfig.Globals.AnsiMode) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets whether output uses ANSI escape codes, used when the property "logging.global.ansi.mode" is absent.
AnsiSupport - Class in io.jstach.rainbowgum.format: Detects whether the current process is attached to an ANSI capable terminal so that formatters (e.g. the pattern module's color keywords) can decide whether to emit ANSI escape codes in the first place instead of emitting and later stripping them.
append(LogEvent) - Method in interface io.jstach.rainbowgum.LogAppender: Appends a single event.
append(LogEvent[], int) - Method in interface io.jstach.rainbowgum.LogAppender: Batch of events.
append(Boolean) - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: Sets append.
append(Boolean) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets append.
appender(LogProvider) - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder: Adds an appender.
appender(String, Consumer) - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder: Adds an appender by giving an appender builder to a consumer.
APPENDER_ENCODER_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogAppender: Encoder appender property.
APPENDER_ENCODER_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Encoder appender property.
APPENDER_FLAGS_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogAppender: Appender flags.
APPENDER_FLAGS_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Appender flags.
APPENDER_OUTPUT_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogAppender: Output appender property.
APPENDER_OUTPUT_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Output appender property.
APPENDER_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Logging appender prefix for configuration.
APPENDER_TYPE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogAppender: Appender type.
APPENDER_TYPE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Appender type (buffer/locking strategy).
Appender Configuration - Section in Overview
appenderLock() - Method in class io.jstach.rainbowgum.LogConfig.Globals: Which kind of lock appenders use, from "logging.global.appender.lock".
appenderLock(LogConfig.Globals.AppenderLock) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets which kind of lock appenders use, used when the property "logging.global.appender.lock" is absent.
Appender Locking Strategy: Native Image vs HotSpot - Section in Overview
Appender Reentry Protection - Section in Overview
Appenders - Section in Overview
APPENDERS_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Enabled Logging appenders.
appenderType(LogAppender.AppenderType) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets the appender type (buffer/locking strategy).
appendThrowable(StringBuilder, Throwable) - Static method in interface io.jstach.rainbowgum.LogFormatter.ThrowableFormatter: Convenience to append a throwable to string builder.
APPLICATION_JSON - Enum constant in enum class io.jstach.rainbowgum.LogOutput.ContentType.StandardContentType: application/json
apply(T) - Method in interface io.jstach.rainbowgum.LogProperty.PropertyFunction
Architecture - Section in Overview
arguments() - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: The arguments added to this builder so far, in the order added.
arguments(LoggingEventBuilder) - Static method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: The arguments added to the builder so far, if possible.
ARRAY_END - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing JSON array end: ]
ARRAY_START - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing JSON array start: [
asList() - Method in class io.jstach.rainbowgum.LogAppender.Appenders: Return the appenders as a list.
asSingle() - Method in class io.jstach.rainbowgum.LogAppender.Appenders: Consolidate the appenders as a single appender, appended synchronously.
async() - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Async builder.
ASYNC_BUFFER_SIZE - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Default async buffer size.
ASYNC_SCHEME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: This is URI scheme for the async publisher used by the publisher builder.
ASYNC_SHUTDOWN_TIMEOUT - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Default time in milliseconds an async publisher's close waits for queued events to be written.
AT - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.ExtendedFieldPrefix: "@" At symbol prefix
atDebug() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
atDebug() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
atError() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
atError() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
atInfo() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
atInfo() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
atTrace() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
atTrace() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
atWarn() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
atWarn() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
AUTO - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesWhenEmpty: Left out for percent encoding and JSON5; {} for JSON, since whatever reads JSON key values expects an object on every line.
AUTO - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.AnsiMode: ANSI is used when the console supports it, see AnsiSupport.isAnsiSupported().
AUTO - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.AppenderLock: LogConfig.Globals.AppenderLock.REENTRANT before JDK 24, where synchronized pins a virtual thread to its carrier (JEP 491).
AUTO_DETECT - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderType: Picks whichever concrete type actually performs best for the platform this process is currently running on, decided once, at appender construction time, not re-checked afterward.
Automatic Exception Rendering - Section in Overview
AVAJE_APPLOG - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: rainbowgum-avaje-config (io.avaje.applog.AppLog).
AvajePropertiesProvider - Class in io.jstach.rainbowgum.avaje: Makes avaje provide properties to RainbowGum.
AvajePropertiesProvider() - Constructor for class io.jstach.rainbowgum.avaje.AvajePropertiesProvider: For service loader.
Avoid java.util.logging if you can - Section in Overview

B

BASIC - Enum constant in enum class io.jstach.rainbowgum.LogEvent.Caller.CallerType: Caller info is computed as a single stack frame (class, method, line).
BASIC - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternConfig.CacheType: The default cache.
BATCH_SWAP_SCHEME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Explicit scheme for BatchSwapAsyncLogPublisher, independent of which implementation is registered as the default LogPublisherRegistry.ASYNC_SCHEME publisher.
BatchSwapAsyncLogPublisher - Class in io.jstach.rainbowgum.publisher: The default bounded async publisher with one output worker.
BatchSwapAsyncLogPublisher.Overflow - Enum Class in io.jstach.rainbowgum.publisher: Behavior when the pending buffer is full.
BatchSwapAsyncLogPublisherBuilder - Class in io.jstach.rainbowgum.publisher: Builder to create LogPublisher.PublisherFactory.
BatchSwapAsyncLogPublisherBuilder(String, String) - Constructor for class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Create a builder for io.jstach.rainbowgum.LogPublisher.PublisherFactory .
BLACK - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI black color
BLOCK - Enum constant in enum class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher.Overflow: Wait for space, preserving accepted events through shutdown.
BlockingQueueAsyncLogPublisher - Class in io.jstach.rainbowgum.publisher: An async publisher that uses a blocking queue and a single thread consumer.
BLUE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI blue color
BOLD_BLUE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldBlue color
BOLD_CYAN - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldCyan color
BOLD_GREEN - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldGreen color
BOLD_MAGENTA - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldMagenta color
BOLD_RED - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldRed color
BOLD_WHITE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldWhite color
BOLD_YELLOW - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI boldYellow color
BRACKETED - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: Upper case in square brackets, like slf4j-simple's levelInBrackets: [INFO].
buffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.LogEncoder.AbstractEncoder
buffer(LogEncoder.BufferHints) - Method in interface io.jstach.rainbowgum.LogEncoder: Creates a new buffer.
buffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoder
BUFFER_SIZE_NAME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Buffer Size property name.
BUFFER_SIZE_PROPERTY - Static variable in class io.jstach.rainbowgum.LogPublisher.AsyncLogPublisher.Builder: Buffer Size Property for Async publishers.
BUFFER_SIZE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Buffer Size Property for Async publishers.
BUFFER_TRIMMED - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.BUFFER_TRIMMED_METRIC.
BUFFER_TRIMMED_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the global count of times a reused encoder buffer had its backing storage shrunk back down after growing past its configured max size (see LogEncoder.Buffer.isOversized()).
bufferHints() - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
bufferHints() - Method in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput
bufferHints() - Method in interface io.jstach.rainbowgum.LogOutput: Hints to the buffer like what write style of the output and maximum buffer size.
bufferSize(int) - Method in class io.jstach.rainbowgum.LogPublisher.AsyncLogPublisher.Builder: Sets buffer size.
bufferSize(DataSize) - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: Sets required bufferSize.
bufferSize(DataSize) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets required bufferSize.
bufferSize(Integer) - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogBuilder: Sets required bufferSize.
bufferSize(Integer) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Sets required bufferSize.
build() - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogBuilder: Creates io.jstach.rainbowgum.LogPublisher.PublisherFactory from this builder.
build() - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: Creates io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.file.FileOutput> from this builder.
build() - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: Creates io.jstach.rainbowgum.LogFormatter from this builder.
build() - Method in class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder: Builds an immutable formatter independent of subsequent builder changes.
build() - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: Creates io.jstach.rainbowgum.LogFormatter from this builder.
build() - Method in class io.jstach.rainbowgum.format.StandardEventFormatter.Builder: Builds the formatter.
build() - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder: Builds the theme.
build() - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Creates io.jstach.rainbowgum.LogFormatter from this builder.
build() - Method in class io.jstach.rainbowgum.jfr.JfrAlertListenerBuilder: Creates io.jstach.rainbowgum.jfr.JfrAlertListener from this builder.
build() - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Creates io.jstach.rainbowgum.json.encoder.EcsEncoder from this builder.
build() - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Creates io.jstach.rainbowgum.json.encoder.GelfEncoder from this builder.
build() - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderBuilder: Creates io.jstach.rainbowgum.json.encoder.LogbackJsonEncoder from this builder.
build() - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder: Creates io.jstach.rainbowgum.json.encoder.LogstashEncoder from this builder.
build() - Method in class io.jstach.rainbowgum.LevelResolver.Builder: Builds a level resolver combining LevelResolver.AbstractBuilder.config(LevelConfig), LevelResolver.AbstractBuilder.level(Level, String), and LevelResolver.Builder.resolver(LevelResolver) into a single resolver of equal priority (the highest severity/most restrictive level found for a logger name wins), and, if any fallbacks were added, wrapping that in a priority chain where the fallbacks are only consulted for logger names the combined resolver above has no opinion on (resolves to System.Logger.Level.ALL).
build() - Method in class io.jstach.rainbowgum.LogAppender.Builder: Builds.
build() - Method in class io.jstach.rainbowgum.LogConfig.Builder: Builds LogConfig which will use the ServiceLoader if set to load missing components and if not set will use static defaults.
build() - Method in class io.jstach.rainbowgum.LogEncoder.Builder: Builds the encoder.
build() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Will create a generic log formatter that has the inner formatters coalesced if possible and will noop if there are no formatters.
build() - Method in class io.jstach.rainbowgum.LogFormatter.ThrowableFormatter.Builder: Builds the formatter.
build() - Method in class io.jstach.rainbowgum.LogProperties.Builder: Builds LogProperties based on builder config.
build() - Method in class io.jstach.rainbowgum.LogProperties.MutableLogProperties.Builder: Builds a mutable log properties.
build() - Method in class io.jstach.rainbowgum.LogPublisher.AbstractBuilder: Creates publisher provider.
build() - Method in class io.jstach.rainbowgum.LogPublisher.AsyncLogPublisher.Builder
build() - Method in class io.jstach.rainbowgum.LogPublisher.SyncLogPublisher.Builder: Build a publisher provider.
build() - Method in class io.jstach.rainbowgum.LogReporter.Options.Builder: Builds the options.
build() - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Creates io.jstach.rainbowgum.otlp.OtlpJsonEncoder from this builder.
build() - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Creates io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.otlp.OtlpOutput> from this builder.
build() - Method in class io.jstach.rainbowgum.output.StdErrOutputBuilder: Creates io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.LogOutput> from this builder.
build() - Method in class io.jstach.rainbowgum.output.StdOutOutputBuilder: Creates io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.LogOutput> from this builder.
build() - Method in class io.jstach.rainbowgum.pattern.format.PatternCompiler.Builder: Creates a pattern compiler.
build() - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Creates io.jstach.rainbowgum.pattern.format.PatternConfig from this builder.
build() - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: Creates io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.LogEncoder> from this builder.
build() - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Creates io.jstach.rainbowgum.LogPublisher.PublisherFactory from this builder.
build() - Method in class io.jstach.rainbowgum.RainbowGum.Builder: Builds an un-started RainbowGum.
build() - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Creates io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.rolling.RollingFileOutput> from this builder.
build() - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Builds the SimpleProperties.
build(LogFormatter, LogFormatter, LogFormatter, LogFormatter, LogFormatter, LogFormatter, LogFormatter) - Static method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: Creates the standard default TTLL layout.
builder() - Static method in class io.jstach.rainbowgum.format.StandardEventFormatter: Create StandardEventFormatter builder.
builder() - Static method in interface io.jstach.rainbowgum.LevelResolver: Level resolver builder.
builder() - Static method in interface io.jstach.rainbowgum.LogConfig: Creates a builder for making LogConfig.
builder() - Static method in interface io.jstach.rainbowgum.LogEncoder: Creates a builder for an encoder backed by the default TTLL (StandardEventFormatter) formatter.
builder() - Static method in interface io.jstach.rainbowgum.LogFormatter: See LogFormatter.builder().
builder() - Static method in interface io.jstach.rainbowgum.LogFormatter.ThrowableFormatter: Creates a builder for a throwable formatter that can limit the number of stack frame lines shown for each throwable in the cause/suppressed chain, exclude frames matching regular expressions, and append packaging data.
builder() - Static method in interface io.jstach.rainbowgum.LogProperties: LogProperties builder.
builder() - Static method in interface io.jstach.rainbowgum.LogProperties.MutableLogProperties: Builder for MutableLogProperties.
builder() - Static method in interface io.jstach.rainbowgum.LogPublisher.AsyncLogPublisher: Async publisher builder.
builder() - Static method in interface io.jstach.rainbowgum.LogPublisher.SyncLogPublisher: Sync publisher builder.
builder() - Static method in class io.jstach.rainbowgum.LogReporter.Options: Creates a builder.
builder() - Static method in interface io.jstach.rainbowgum.pattern.format.PatternCompiler: Creates a pattern compiler builder.
builder() - Static method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Creates a builder to create formatter config.
builder() - Static method in interface io.jstach.rainbowgum.RainbowGum: Use to build a custom RainbowGum which will use the LogConfig provided by the service loader.
builder() - Static method in class io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues: Creates a builder to push a new layer of key values, fetched fresh from whichever ScopedKeyValuesProvider is active.
builder() - Method in interface io.jstach.rainbowgum.scopedkeyvalues.spi.ScopedKeyValuesProvider: Creates a fresh ScopedKeyValues.Builder for one layer of key values.
builder() - Static method in class io.jstach.rainbowgum.simple.props.SimpleProperties: Creates a builder.
builder(LogConfig) - Static method in interface io.jstach.rainbowgum.RainbowGum: Use to build a custom RainbowGum with supplied config.
builder(LogFormatter) - Static method in interface io.jstach.rainbowgum.LogEncoder: Creates a builder for an encoder backed by the given formatter.
builder(String) - Static method in interface io.jstach.rainbowgum.format.TTLL.ColorTheme: Starts a theme.
builder(String) - Static method in interface io.jstach.rainbowgum.LogAppender: Creates a builder.
builder(String) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Creates a builder to create formatter config.
builder(String) - Static method in class io.jstach.rainbowgum.pattern.format.PatternEncoder: Pattern encoder builder.
builder(String) - Static method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher: Creates a named builder.
builder(String, LogConfig) - Static method in interface io.jstach.rainbowgum.LogRouter.Router: Creates a builder from config.
builder(Consumer) - Static method in interface io.jstach.rainbowgum.RainbowGum: Use to build a custom RainbowGum with supplied config.
Builder - Section in Overview
Builder based - Section in Overview
buildLevelConfigOrNull() - Method in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: Builds the level config based on LevelResolver.AbstractBuilder.levelConfigs and LevelResolver.AbstractBuilder.levels.
BUILTIN_SCHEME_PREFIX - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Because publisher configurators through service provider discovery can replace the default schemes of LogPublisherRegistry.ASYNC_SCHEME, LogPublisherRegistry.SYNC_SCHEME all the builtin core providers are prefixed with this value so that they can still be used even if overriden.
Built-in Rolling - Section in Overview
BYTE_BUFFER - Enum constant in enum class io.jstach.rainbowgum.LogOutput.WriteMethod: Prefer calling LogOutput.write(LogEvent, ByteBuffer, ContentType).
BYTES - Enum constant in enum class io.jstach.rainbowgum.LogOutput.WriteMethod: Prefer calling LogOutput.write(LogEvent, byte[], ContentType) or LogOutput.write(LogEvent, byte[], int, int, ContentType).

C

CACHED - Enum constant in enum class io.jstach.rainbowgum.output.ConsoleStream: Uses whatever System.out or System.err is when the output is created.
call() - Method in interface io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues.CallableOp: Runs the operation.
call(ScopedKeyValues.CallableOp) - Method in interface io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues.Builder: Pushes this layer and calls body for its duration.
CALLER_LOGGER_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Per logger caller info properties prefix: see LogEvent.Caller.CallerType.
callerInfoEnabled(String) - Method in interface io.jstach.rainbowgum.LogConfig.ChangePublisher: Whether caller info should be computed for a logger at all, regardless of which non-LogEvent.Caller.CallerType.NONE strategy.
Caller Information - Section in Overview
callerOrNull() - Method in interface io.jstach.rainbowgum.LogEvent: Returns info about caller or null if not supported.
callerType(String) - Method in interface io.jstach.rainbowgum.LogConfig.ChangePublisher: The caller info strategy for a logger, resolved from "logging.caller.logger", independently of LogConfig.ChangePublisher.allowedChanges(String) /"logging.change.logger".
capacity() - Method in record class io.jstach.rainbowgum.LogAlerts.Stats: Returns the value of the capacity record component.
CaseChanging - Annotation Interface in io.jstach.rainbowgum.annotation: API documentation marker that the enum or sealed type may add new case values on feature release and thus external API consumers desiring backward compatibility should have a default case.
cause() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error: Returns the value of the cause record component.
CHANGE_LOGGER_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Per logger change properties prefix: see LogConfig.ChangePublisher.ChangeType.
CHANGE_MODE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Whether runtime changes are on: see LogConfig.ChangePublisher.ChangeMode.
changeMode() - Method in class io.jstach.rainbowgum.LogConfig.Globals: Whether loggers can change at runtime, from "logging.change.mode".
changeMode(LogConfig.ChangePublisher.ChangeMode) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets whether runtime changes are on, used when the property "logging.change.mode" is absent.
changePublisher() - Method in interface io.jstach.rainbowgum.LogConfig: An event changePublisher to publish configuration changes.
Changing Levels at Runtime - Section in Overview
charset(Charset) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: Sets charset.
charset(Charset) - Method in class io.jstach.rainbowgum.LogEncoder.Builder: Charset to encode with.
charsetOrNull() - Method in interface io.jstach.rainbowgum.LogOutput.ContentType: The charset the bytes are encoded with, or null if there is no single fixed charset for this content type.
CHECK - Enum constant in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: (default) Will check if there are implementations of RainbowGumServiceProvider.RainbowGumEagerLoad and if there are not will load rainbow gum.
checkEnabled(System.Logger.Level, System.Logger.Level) - Static method in interface io.jstach.rainbowgum.LevelResolver: Statically checks if requested level is greater than or equal to the logger level based on LevelResolver rules.
CLASS - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Calling class
className() - Method in interface io.jstach.rainbowgum.LogEvent.Caller: See StackWalker.StackFrame.getClassName().
cleanHistoryOnStart(Boolean) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets required cleanHistoryOnStart.
clear() - Method in class io.jstach.rainbowgum.json.JsonBuffer
clear() - Method in interface io.jstach.rainbowgum.LevelResolver: Clears any caching of levels.
clear() - Method in interface io.jstach.rainbowgum.LogAlerts: Clears the ring buffer.
clear() - Method in interface io.jstach.rainbowgum.LogEncoder.Buffer: Prepare the buffer for reuse.
clear() - Method in interface io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor: Clears all of the current thread's state in the underlying context store, including state that is not exposed as key values such as a nested diagnostic context (NDC) stack, so a pooled thread starts its next task with no context left over.
clear() - Method in class io.jstach.rainbowgum.output.ListLogOutput: Clears the currently stored events.
clearMdc() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
clearNdc() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
clearThreadLocals() - Static method in interface io.jstach.rainbowgum.LogAppender: Removes the current thread's encoding buffers from every appender of the globally bound RainbowGum, so a pooled thread does not keep a buffer it may never use again.
clearWhenDisabled() - Method in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: Whether this source's contributor should still be cleared when its contribution is disabled with "logging.keyvalues.disabled".
close() - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogPublisher
close() - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
close() - Method in class io.jstach.rainbowgum.jul.JULConfigurator
close() - Method in interface io.jstach.rainbowgum.LogAppender
close() - Method in interface io.jstach.rainbowgum.LogEncoder.Buffer: Convenience that will call clear.
close() - Method in interface io.jstach.rainbowgum.LogLifecycle
close() - Method in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput
close() - Method in interface io.jstach.rainbowgum.LogOutput: Will close the output and should only be called by the owning appender.
close() - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
close() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
close() - Method in class io.jstach.rainbowgum.output.ListLogOutput
close() - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher
close() - Method in class io.jstach.rainbowgum.publisher.BlockingQueueAsyncLogPublisher
close() - Method in interface io.jstach.rainbowgum.RainbowGum: Will close the RainbowGum and all registered components as well as removed from the shutdown hooks.
close() - Method in interface io.jstach.rainbowgum.ServiceRegistry
CLR - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.SpringBootKey: Spring Boot color pattern key
color(TTLL.ColorMode) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: Sets color.
color(TTLL.ColorMode) - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: Sets color.
color(TTLL.ColorMode) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets color.
COMMA - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing comma separator: ,
Commons Logging (jcl) - Section in Overview
compareTo(DataSize) - Method in class io.jstach.rainbowgum.file.DataSize
compile(String) - Method in interface io.jstach.rainbowgum.pattern.format.PatternCompiler: Compiles a pattern into a formatter.
COMPONENTS - Enum constant in enum class io.jstach.rainbowgum.LogReporter.Section: The wired component tree: active global properties, then each router's publisher, appenders, outputs, and encoders.
compression(String) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets compression.
concat(LogFormatter.StaticFormatter) - Method in record class io.jstach.rainbowgum.LogFormatter.StaticFormatter: Creates a new formatter by concat the LogFormatter.StaticFormatter.content().
concatKey(String) - Static method in interface io.jstach.rainbowgum.LogProperties: Concats a key using LogProperties.SEP to the root prefix.
concatKey(String, String) - Static method in interface io.jstach.rainbowgum.LogProperties: Concats a keys using LogProperties.SEP as the separator.
config() - Method in interface io.jstach.rainbowgum.LogConfig.ConfigSupport: Provides config.
config() - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder: Gets the currently bound config.
config() - Method in interface io.jstach.rainbowgum.RainbowGum: The config associated with this instance.
config(LevelResolver.LevelConfig) - Method in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: Adds a level config.
config(LogProperties, String) - Method in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: Adds a level config based on properties and will use the prefix as the root.
Config - Section in Overview
Config Change during runtime - Section in Overview
configurator(RainbowGumServiceProvider.Configurator) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Add to configure LogConfig and ServiceRegistry.
CONFIGURATOR_PASSES - Static variable in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Configurator: The default amount of passes made to resolve configurators.
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.avaje.AvajePropertiesProvider
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.disruptor.DisruptorConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.jansi.JAnsiConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.jbosslogging.JBossKeyValuesConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.jfr.JfrAlertListenerConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.jfr.JfrConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.jul.JULConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValuesConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.log4j.Log4jKeyValuesConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.opentelemetry.OpenTelemetryConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.otlp.OtlpConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.pattern.format.spi.PatternKeywordProvider
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.rolling.RollingConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.scopedkeyvalues.provider.ScopedKeyValuesConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.simple.props.SimplePropertiesProvider
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.slf4j.SLF4JKeyValuesConfigurator
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in class io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService
configure(LogConfig, RainbowGumServiceProvider.Pass) - Method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Configurator: Do ad-hoc initialization before RainbowGum is fully loaded.
Configuring io.jstach.rainbowgum.pattern.format.PatternConfig - Section in package io.jstach.rainbowgum.pattern.format
Configuring PatternConfig with Properties - Section in Overview
Console - Section in Overview
CONSOLE_APPENDER_NAME - Static variable in interface io.jstach.rainbowgum.LogAppender: Default Console appender name.
CONSOLE_ERR - Enum constant in enum class io.jstach.rainbowgum.LogOutput.OutputType: Standard err.
CONSOLE_OUT - Enum constant in enum class io.jstach.rainbowgum.LogOutput.OutputType: Standard out.
ConsoleStream - Enum Class in io.jstach.rainbowgum.output: How a standard out or standard err output finds the stream it writes to.
constant() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable.DefaultParameter: Uses the named constant of the parameter's enum type as the default instead of a static field.
content() - Method in record class io.jstach.rainbowgum.LogFormatter.StaticFormatter: Returns the value of the content record component.
Contents - Section in Overview
contentType() - Method in interface io.jstach.rainbowgum.LogOutput.ContentType: Content type of binary datay passed to output.
contentType() - Method in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: The HTTP content type of the request body.
contentType(LogOutput.ContentType) - Method in class io.jstach.rainbowgum.LogEncoder.Builder: Content type reported to the output.
convert() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error: Helper just to cast the result to a different parameterized type.
convert() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing: Helper just to cast the result to a different parameterized type.
copy() - Method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Copies.
copy(PatternConfigBuilder, PatternConfig) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Copies the config to builder.
copyProperties(String) - Method in class io.jstach.rainbowgum.LogProperties.MutableLogProperties.Builder: Parses a string as Properties useful for unit testing with Java multiline string literal.
copyToMap() - Method in interface io.jstach.rainbowgum.KeyValues: Copies the KeyValues to a Map.
create(LogPublisher, LevelResolver, String, LogConfig) - Method in interface io.jstach.rainbowgum.LogRouter.Router.RouterFactory: Builder will call this factory if passed in.
create(PatternConfig, PatternKeyword) - Method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory.KeywordFactory: Creates a formatter from a keyword.
create(PatternConfig, PatternKeyword, LogFormatter) - Method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory.CompositeFactory: Creates a formatter from a keyword.
create(String, LogConfig, LogAppender.Appenders) - Method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Create the log publisher from config and appenders.
currentMerged() - Static method in class io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues: Every currently pushed layer, merged into one map - later (more-deeply-nested) pushes win on a key collision.
currentMerged() - Method in interface io.jstach.rainbowgum.scopedkeyvalues.spi.ScopedKeyValuesProvider: Every currently pushed layer, merged into one map - later (more deeply nested) pushes win on a key collision.
Custom Keywords and Programmatic Configuration - Section in Overview
CYAN - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI cyan color

D

DARCULA - Static variable in interface io.jstach.rainbowgum.format.TTLL.ColorTheme: IntelliJ Darcula's colors in 24 bit color: blue time, gray thread and key values, orange logger name, and level bold red, yellow, or green (error, warn, info) with debug and trace gray.
DataSize - Class in io.jstach.rainbowgum.file: A non negative amount of data in bytes, such as a maximum file size.
DATE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Date keywords
debug(LogConfig.DebugModeType) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets the debug mode used when the system property "logging.debug" is absent.
debug(String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(Marker, String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(Marker, String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(Marker, String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(Marker, String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(Marker, String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(Marker, String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(Marker, String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(Marker, String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
debug(Marker, String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
debug(Marker, String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
DEBUG_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Controls direct fail-safe bootstrap diagnostics.
debugMode() - Method in interface io.jstach.rainbowgum.LogConfig: Effective debug mode collected while this configuration was built.
decode(CharSequence, Charset) - Static method in class io.jstach.rainbowgum.PercentCodec: Decodes %XX sequences into bytes and the bytes into text with the charset.
decorate(RainbowGum, LoggerDecoratorService.DepthAwareLogger, int) - Method in class io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService: Decorate a logger.
decorate(LoggingEventBuilder, Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger: Called with the already-populated builder (message, arguments and cause already set from whatever convenience method arity the caller used).
decrement() - Method in interface io.jstach.rainbowgum.LogMetrics.Gauge: Decrements the value by one.
decrement(long) - Method in interface io.jstach.rainbowgum.LogMetrics.Gauge: Subtracts the supplied amount.
DEFAULT - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ColorMode: The theme, or TTLL.ColorTheme.RAINBOWGUM when no theme is set, if ANSI is detected.
DEFAULT - Enum constant in enum class io.jstach.rainbowgum.LogOutput.ProvidesEncoder.Policy: The output's own encoder is used only as a fallback: any explicitly configured encoder, programmatic or property, wins over it.
DEFAULT_BUFFER_SIZE - Static variable in class io.jstach.rainbowgum.disruptor.DisruptorConfigurator: Default size of disruptor ring buffer.
DEFAULT_BUFFER_SIZE - Static variable in interface io.jstach.rainbowgum.file.FileOutput: Default file buffer size: 8KB, based on Logback's default.
DEFAULT_BUFFER_SIZE - Static variable in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher: Default pending buffer capacity.
DEFAULT_BUFFER_SIZE - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Default buffer size, the same as FileOutput.DEFAULT_BUFFER_SIZE.
DEFAULT_CAPACITY - Static variable in interface io.jstach.rainbowgum.LogAlerts: Default capacity of the alert ring buffer.
DEFAULT_CLEAN_HISTORY_ON_START - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Default for whether archive pruning (maxHistory/totalSizeCap) also runs once at LogOutput.start(LogConfig), not just after each roll.
DEFAULT_DISCARD_LEVEL - Static variable in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher: Highest severity eligible for early discarding.
DEFAULT_DISCARD_THRESHOLD - Static variable in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher: Early discarding is disabled by default.
DEFAULT_ENV_PREFIX - Static variable in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Default environment variable prefix: "RAINBOWGUM_".
DEFAULT_FILE_NAME_PATTERN - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Default fileNamePattern - the literal text appended directly after the active file's own path (unlike Logback, never containing the base file name itself) with %i substituted for the rotation index, e.g.
DEFAULT_INITIAL_JSON_CAPACITY - Static variable in class io.jstach.rainbowgum.json.JsonBuffer: Default initial capacity of the raw JSON byte buffer, matching what this class has always used - big enough that most events never need to grow it.
DEFAULT_INITIAL_MESSAGE_CAPACITY - Static variable in class io.jstach.rainbowgum.json.JsonBuffer: Default initial capacity of JsonBuffer.getFormattedMessageBuilder().
DEFAULT_MAX_BATCH_SIZE - Static variable in class io.jstach.rainbowgum.otlp.OtlpOutput: Default maximum number of events per request.
DEFAULT_MAX_FILE_SIZE - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Default max file size before a roll is triggered: 10MB, matching Logback and Spring Boot's own default.
DEFAULT_MAX_HISTORY - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Default number of archives to retain - 7, matching Logback/Spring Boot's own default.
DEFAULT_NAME - Static variable in interface io.jstach.rainbowgum.LogProperties: For properties keys that are parameterized with "name" the name often used if not specified is: "default".
DEFAULT_OVERFLOW - Static variable in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher: Default full-buffer policy.
DEFAULT_RESOURCE - Static variable in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Default classpath resource: "classpath:/logging.properties".
DEFAULT_ROUTER_NAME - Static variable in interface io.jstach.rainbowgum.LogRouter.Router: The router name given if no router is explicitly declared.
DEFAULT_SCHEME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: This is the URI scheme for the default publisher.
DEFAULT_SERVICE_NAME - Static variable in interface io.jstach.rainbowgum.ServiceRegistry: Services that do not have multiple options or need a default should use "default".
DEFAULT_SHUTDOWN_TIMEOUT - Static variable in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher: Default time to wait for delivery and appender closure.
DEFAULT_SPAN_ID_KEY - Static variable in class io.jstach.rainbowgum.otlp.OtlpJsonEncoder: Default key value name holding the span id.
DEFAULT_TIME_FRACTIONAL_DIGITS - Static variable in class io.jstach.rainbowgum.json.encoder.GelfEncoder: Default number of fractional second digits the _time field is rendered with, see GelfEncoder.of(String, String, Map, Boolean, Integer, Integer).
DEFAULT_TIMEOUT - Static variable in class io.jstach.rainbowgum.otlp.OtlpOutput: Default export timeout in milliseconds.
DEFAULT_TOTAL_SIZE_CAP - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Default total archive size cap.
DEFAULT_TRACE_ID_KEY - Static variable in class io.jstach.rainbowgum.otlp.OtlpJsonEncoder: Default key value name holding the trace id.
defaultKeyValues() - Method in interface io.jstach.rainbowgum.LogEventFactory: Key values to use for the next event created by this factory when a caller does not supply an explicit KeyValues.
DefaultKeyValues - Class in io.jstach.rainbowgum.keyvalues.contributor: Key values added to every event, registered as the LogEventFactory.KeyValuesContributor.Source.Standard.DEFAULTS source so every other source overrides them on a key collision.
Default Key Values - Section in Overview
DefaultKeyValuesConfigurator - Class in io.jstach.rainbowgum.keyvalues.contributor: Registers DefaultKeyValues as the LogEventFactory.KeyValuesContributor.Source.Standard.DEFAULTS key values source with the values of "logging.keyvalues.contributor.defaults".
DefaultKeyValuesConfigurator() - Constructor for class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValuesConfigurator: For service loader.
defaultLevel() - Method in interface io.jstach.rainbowgum.LevelResolver.LevelConfig: The default level if no level is found.
defaults() - Static method in interface io.jstach.rainbowgum.RainbowGum: Provides the service loader default based RainbowGum.
DEFAULTS - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: Key values added to every event, such as a build version or instance id, which every other source overrides on a key collision.
DEFAULTS_PROPERTY - Static variable in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues: Key values added to every event, as a map property, in the order the property source gives them, which for the URI query form (a=1&b=2) is the order declared.
delegate() - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties: The properties lookups are forwarded to.
delegate() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger: The downstream logger to forward calls to.
delegate() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger: The wrapped logger that ultimately receives log calls.
delegate() - Method in interface io.jstach.rainbowgum.slf4j.WrappingLogger: The downstream logger to forward calls to.
describe() - Method in interface io.jstach.rainbowgum.LogProperty.Result: A description of the result for error messages.
describe() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error
describe() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing
describe(String) - Method in interface io.jstach.rainbowgum.LogProvider: Wraps with an error description.
describe(Function) - Method in interface io.jstach.rainbowgum.LogProvider: Wraps with an error description.
description - Variable in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: description
description(String) - Method in class io.jstach.rainbowgum.LogEncoder.Builder: A human readable description of the formatter/pattern this encoder was built from (e.g. the actual pattern string), surfaced by LogReporter.Reportable instead of the built encoder only ever showing up as its bare concrete class name.
description(String) - Method in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: Description for properties.
description(String) - Method in interface io.jstach.rainbowgum.LogProperties: Describes a key and by default is usually just the key.
description(String) - Method in enum class io.jstach.rainbowgum.LogProperties.StandardProperties
description(String) - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
Description - Section in Overview
descriptionForKey(String, String) - Static method in interface io.jstach.rainbowgum.LogProperties: Standard way to produce description for a key.
descriptionForResource(String, String, String) - Static method in interface io.jstach.rainbowgum.LogProperties: Standard way to produce description for a key found in a resource (a file or similar), without a line number.
descriptionForResource(String, String, String, long) - Static method in interface io.jstach.rainbowgum.LogProperties: Standard way to produce description for a key found in a resource (a file or similar) at a known index, usually a line number.
DETECT - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ColorMode: The theme if one is set and ANSI is detected; no color without a theme.
Diagnostics and native images - Section in Overview
DISABLE_IMMEDIATE_FLUSH - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderFlag: By default the appender will call flush on each item appended or if in async batch mode for each batch.
discardLevel(System.Logger.Level) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Sets required discardLevel.
discardThreshold(Integer) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Sets required discardThreshold.
DISRUPTOR_SCHEME - Static variable in class io.jstach.rainbowgum.disruptor.DisruptorConfigurator: The URI scheme for the DisruptorLogPublisher
DisruptorConfigurator - Class in io.jstach.rainbowgum.disruptor: Registers DisruptorLogPublisher to the default LogPublisherRegistry.ASYNC_SCHEME which makes it the default async publisher provider.
DisruptorConfigurator() - Constructor for class io.jstach.rainbowgum.disruptor.DisruptorConfigurator: No-Arg constructor for ServiceLoader.
DisruptorLogBuilder - Class in io.jstach.rainbowgum.disruptor: Builder to create LogPublisher.PublisherFactory.
DisruptorLogBuilder(String, String) - Constructor for class io.jstach.rainbowgum.disruptor.DisruptorLogBuilder: Create a builder for io.jstach.rainbowgum.LogPublisher.PublisherFactory .
DisruptorLogPublisher - Class in io.jstach.rainbowgum.disruptor: Disruptor async publisher.
doBuffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoder
doBuffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoder
doBuffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoder
doBuffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoder
doBuffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.LogEncoder.AbstractEncoder: Create a specific buffer implementation.
doBuffer(LogEncoder.BufferHints) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoder
documentBaseUrl() - Static method in class io.jstach.rainbowgum.RainbowGumVersion: Resolves the Rainbow Gum documentation URL based on RainbowGumVersion.VERSION.
doEncode(LogEvent, JsonBuffer) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoder
doEncode(LogEvent, JsonBuffer) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoder
doEncode(LogEvent, JsonBuffer) - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoder
doEncode(LogEvent, JsonBuffer) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoder
doEncode(LogEvent, JsonBuffer) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoder
doEncode(LogEvent, T) - Method in class io.jstach.rainbowgum.LogEncoder.AbstractEncoder: A type safe version of LogEncoder.AbstractEncoder.encode(LogEvent, Buffer).
drain(LogOutput, LogEvent) - Method in class io.jstach.rainbowgum.json.JsonBuffer
drain(LogOutput, LogEvent) - Method in interface io.jstach.rainbowgum.LogEncoder.Buffer: The appender will call this usually within a lock to transfer content from the buffer to the output.
DROP - Enum constant in enum class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher.Overflow: Discard the incoming event regardless of level instead of waiting for buffer space.
dump() - Method in interface io.jstach.rainbowgum.LogAlerts: A snapshot of the alerts currently held in the ring buffer, oldest first.
DUMP - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.UnobservedErrorsAction: Default.

E

ECS_SCHEME - Static variable in class io.jstach.rainbowgum.json.encoder.EcsEncoder: ECS encoder URI scheme.
ECS_VERSION - Static variable in class io.jstach.rainbowgum.json.encoder.EcsEncoder: The ECS schema version this encoder targets.
EcsEncoder - Class in io.jstach.rainbowgum.json.encoder: A JSON encoder in Elastic Common Schema (ECS) logging format.
EcsEncoderBuilder - Class in io.jstach.rainbowgum.json.encoder: Builder to create EcsEncoder.
EcsEncoderBuilder(String) - Constructor for class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Create a builder for io.jstach.rainbowgum.json.encoder.EcsEncoder .
EcsEncoderConfigurator - Class in io.jstach.rainbowgum.json.encoder: Adds Elastic Common Schema (ECS) JSON Encoder to encoder registry with "ecs" URI scheme.
EcsEncoderConfigurator() - Constructor for class io.jstach.rainbowgum.json.encoder.EcsEncoderConfigurator: Default constructor for service loader.
ECS JSON Encoder - Section in Overview
EMPTY - Enum constant in enum class io.jstach.rainbowgum.LogFormatter.KeyValueNullStrategy: A null value is normalized to an empty string, so the key is always printed as key= (with nothing after the =) regardless of whether the underlying value was null or actually an empty string.
EMPTY - Enum constant in enum class io.jstach.rainbowgum.LogProperties.StandardProperties: Empty properties.
encode(LogEvent, LogEncoder.Buffer) - Method in class io.jstach.rainbowgum.LogEncoder.AbstractEncoder
encode(LogEvent, LogEncoder.Buffer) - Method in interface io.jstach.rainbowgum.LogEncoder: Encodes an event to the buffer.
encode(LogEvent, LogEncoder.Buffer) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoder
encode(CharSequence, Charset) - Static method in class io.jstach.rainbowgum.PercentCodec: Percent encodes the content, see PercentCodec.encode(StringBuilder, CharSequence, Charset).
encode(StringBuilder, CharSequence, Charset) - Static method in class io.jstach.rainbowgum.PercentCodec: Appends the content percent encoded: every byte of its encoding in the charset other than the unreserved characters A-Z a-z 0-9 - . _ ~ is written as %XX with upper case hex digits.
ENCODED_MDC - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: RainbowGum's own percent-encoded (RFC 3986 URI query) MDC style, e.g.
encodedKeyValue(String, String) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Creates a formatter that will print a single key value in percent encoding (RFC 3986 URI aka the format usually used in URI.getQuery()).
encoder() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Creates the formatter and starts an encoder builder from it - call LogEncoder.Builder.build() to finish, optionally configuring charset, content type, max buffer size, or initial buffer size first.
encoder(LogEncoder) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets encoder.
encoder(LogProvider) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets encoder.
encoder(String, LogConfig) - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
encoder(String, LogConfig) - Method in interface io.jstach.rainbowgum.LogOutput.ProvidesEncoder: The encoder this output supplies, given the same name/config the output itself was provided with.
encoder(String, LogConfig) - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
ENCODER_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Prefix of the properties configuring an appender's encoder, followed by the encoder's URI scheme, for example logging.appender.
encoderForOutputType(LogOutput.OutputType) - Method in interface io.jstach.rainbowgum.LogEncoderRegistry: Associates a default formatter with a specific output type.
encoderRegistry() - Method in interface io.jstach.rainbowgum.LogConfig: Provides encoders by URI scheme.
Encoders - Section in Overview
endpoint() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput: The endpoint requests are sent to.
endpoint(URI) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets endpoint.
EnumAlias - Annotation Interface in io.jstach.rainbowgum.annotation: API documentation marker on an enum constant listing the other property values, case insensitive, that select it besides its own name, for example true or false.
enumValue(Class, String, String...) - Static method in interface io.jstach.rainbowgum.LogProperty: Parses a case-insensitive enum value and reports the valid property values when parsing fails.
ENVIRONMENT_VARIABLES - Enum constant in enum class io.jstach.rainbowgum.LogProperties.StandardProperties: Uses System.getenv(String) for LogProperties.valueOrNull(String).The LogProperties.order() is 300 which is the same value as MicroProfile config ordinal.
environmentVariables(EnvironmentVariables) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Sets environmentVariables.
environmentVariables(EnvironmentVariables) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets environmentVariables.
EnvironmentVariables - Enum Class in io.jstach.rainbowgum.otlp: Whether the standard OpenTelemetry environment variables (OTEL_SERVICE_NAME, OTEL_RESOURCE_ATTRIBUTES, and OTEL_EXPORTER_OTLP_*) are read.
envPrefix(String) - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Sets the environment variable prefix used in place of the key's "logging." lead segment (for example logging.level.com.myapp becomes RAINBOWGUM_level_com_myapp with the default prefix).
equals(KeyValues, KeyValues) - Static method in interface io.jstach.rainbowgum.KeyValues: Checks if two KeyValues are equal.
equals(Object) - Method in class io.jstach.rainbowgum.file.DataSize
equals(Object) - Method in record class io.jstach.rainbowgum.LogAlerts.Stats: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jstach.rainbowgum.LogFormatter.StaticFormatter: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jstach.rainbowgum.LogMetrics.Metric: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.jstach.rainbowgum.pattern.Padding: Indicates whether some other object is "equal to" this one.
error(Class, String, Throwable) - Method in interface io.jstach.rainbowgum.LogAlerts: Records an alert.
error(Class, Throwable) - Method in interface io.jstach.rainbowgum.LogAlerts: Records an alert.
error(String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(Marker, String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(Marker, String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(Marker, String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(Marker, String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(Marker, String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(Marker, String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(Marker, String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(Marker, String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
error(Marker, String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
error(Marker, String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
Error(String, String, Exception) - Constructor for record class io.jstach.rainbowgum.LogProperty.Result.Error: Creates an instance of a Error record class.
ERROR - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.FailLevel: Fail if an error alert is recorded while starting.
ERROR - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.UnusedKeyLevel: Every unread key is an error, so logging.alerts.fail=error fails on any of them.
ERROR - Enum constant in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Dump the failure and collected alerts if building the config fails.
errorCounter(String, long) - Method in interface io.jstach.rainbowgum.LogMetrics: Increments a counter for something worth tracking as "this happens and it matters".
errorName() - Method in exception class io.jstach.rainbowgum.LogProperty.PropertyConvertException
errorName() - Method in exception class io.jstach.rainbowgum.LogProperty.PropertyMissingException
errorName() - Method in interface io.jstach.rainbowgum.LogProperty.PropertyProblem: A short, stable name for this problem used in error messages instead of the exception's full (and for a nested class, $-separated) class name.
errorName() - Method in exception class io.jstach.rainbowgum.LogProperty.ValidationException
errorName() - Method in exception class io.jstach.rainbowgum.LogProviderRef.NotFoundException
ESB - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.SpringBootKey: Spring Boot converter that surrounds property in square brackets.
ESCAPE - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing JSON escape: \\
event(LogFormatter.EventFormatter) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Adds an event formatter.
eventArgs(System.Logger.Level, String, KeyValues, Object[]) - Method in interface io.jstach.rainbowgum.LogEventFactory: Like LogEventFactory.eventArgs(Level, String, KeyValues, Object[], Throwable) with no throwable.
eventArgs(System.Logger.Level, String, KeyValues, Object[], Throwable) - Method in interface io.jstach.rainbowgum.LogEventFactory: Creates a log event with an array of message arguments.
eventArgs(System.Logger.Level, String, Object[]) - Method in interface io.jstach.rainbowgum.LogEventFactory: Like LogEventFactory.eventArgs(Level, String, KeyValues, Object[], Throwable) but using LogEventFactory.defaultKeyValues() and no throwable.
eventArgs(System.Logger.Level, String, Object[], Throwable) - Method in interface io.jstach.rainbowgum.LogEventFactory: Like LogEventFactory.eventArgs(Level, String, KeyValues, Object[], Throwable) but using LogEventFactory.defaultKeyValues().
Event based Filtering - Section in Overview
eventDataset(String) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets eventDataset.
eventFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: Combined formatter.
eventLogger(String) - Method in interface io.jstach.rainbowgum.LogRouter.RootRouter: The sink to dispatch events to for a logger name, with no level based gating - unlike LogRouter.route(String, java.lang.System.Logger.Level), the returned LogEventLogger always accepts LogEventLogger.log(LogEvent) regardless of what level is currently enabled.
eventNoArg(System.Logger.Level, String, KeyValues, Throwable) - Method in interface io.jstach.rainbowgum.LogEventFactory: Creates a log event whose message is already formatted (no arguments).
eventNoArg(System.Logger.Level, String, Throwable) - Method in interface io.jstach.rainbowgum.LogEventFactory: Like LogEventFactory.eventNoArg(Level, String, KeyValues, Throwable) but using LogEventFactory.defaultKeyValues().
eventOneArg(System.Logger.Level, String, KeyValues, Object) - Method in interface io.jstach.rainbowgum.LogEventFactory: Creates a log event with a single message argument.
eventOneArg(System.Logger.Level, String, Object) - Method in interface io.jstach.rainbowgum.LogEventFactory: Like LogEventFactory.eventOneArg(Level, String, KeyValues, Object) but using LogEventFactory.defaultKeyValues().
events() - Method in class io.jstach.rainbowgum.output.ListLogOutput: The arraylist that contains the logged events so far.
EVENTS_DISCARDED_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the global count of log events an async publisher discarded because its configured overload policy chose to, rather than wait for buffer space.
EVENTS_DROPPED - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.EVENTS_DROPPED_METRIC.
EVENTS_DROPPED_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the global count of log events dropped without ever being written anywhere - for example an appender dropping events on reentry.
EVENTS_FAILED - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.EVENTS_FAILED_METRIC.
EVENTS_FAILED_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the global count of log events an appender failed to write - the encoder or output threw while appending, so the event was caught, alerted (see LogAlerts.error(Class, String, Throwable)), and lost rather than retried.
EVENTS_QUEUED - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.EVENTS_QUEUED_METRIC.
EVENTS_QUEUED_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Gauge name for the aggregate number of events waiting in async publisher buffers.
eventTwoArg(System.Logger.Level, String, KeyValues, Object, Object) - Method in interface io.jstach.rainbowgum.LogEventFactory: Creates a log event with two message arguments.
eventTwoArg(System.Logger.Level, String, Object, Object) - Method in interface io.jstach.rainbowgum.LogEventFactory: Like LogEventFactory.eventTwoArg(Level, String, KeyValues, Object, Object) but using LogEventFactory.defaultKeyValues().
Example Configuration - Section in Overview
excludes(List) - Method in class io.jstach.rainbowgum.LogFormatter.ThrowableFormatter.Builder: Regular expressions matched with Matcher.find() against each frame's StackTraceElement.toString().
exists() - Static method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.RainbowGumEagerLoad: Without loading service providers will carefully check for the existence of any RainbowGumServiceProvider.RainbowGumEagerLoad implementations.
EXTENDED_F - Static variable in class io.jstach.rainbowgum.json.JsonBuffer: A flag to indicate this field is extended which means it will be prefixed with JsonBuffer.ExtendedFieldPrefix.
EXTENDED_THROWABLE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Extended throwable keywords.
Extension development guide - Section in Overview
Extensions and Integrations - Section in Overview
External Tool Support (logrotate) - Section in Overview

F

FACADES - Enum constant in enum class io.jstach.rainbowgum.LogReporter.Section: The distinct set of LoggerAPIs registered via LogConfig.LoggerRegistry.registerLoggerName(LoggerAPI, String), e.g. seeing both SLF4J and JUL means both facades are in active use (not just on the classpath).
factory(LogRouter.Router.RouterFactory) - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder: Factory to use for creating the router.
FAIL - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.UnobservedErrorsAction: Same reporting as LogAlerts.UnobservedErrorsAction.DUMP, but then throws, so LogConfig.Builder.build() (and therefore whatever is building a RainbowGum from it) never completes.
FAIL - Enum constant in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.StrictType: Records error alerts and fails when supplying properties if any key lacks the logging prefix.
FAILED_METRIC - Static variable in class io.jstach.rainbowgum.otlp.OtlpOutput: Metric counting log records dropped because a request failed.
Failing on alerts - Section in Overview
fallback(LevelResolver) - Method in class io.jstach.rainbowgum.LevelResolver.Builder: Adds a lower priority fallback level resolver.
fallbacks - Variable in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: fallbacks
FALSE - Enum constant in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: Will not initialize rainbow gum.
FAQ - Section in Overview
FILE - Enum constant in enum class io.jstach.rainbowgum.LogOutput.OutputType: Output targets a file.
FILE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: File
FILE_APPENDER_NAME - Static variable in interface io.jstach.rainbowgum.LogAppender: Default output file appender name.
FILE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Logging file property for default single file appending.
FILE_SCHEME - Static variable in interface io.jstach.rainbowgum.LogOutput: File URI scheme.
fileName(String) - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: Sets fileName.
fileName(String) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets fileName.
fileNameOrNull() - Method in interface io.jstach.rainbowgum.LogEvent.Caller: See StackWalker.StackFrame.getFileName().
fileNamePattern(String) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets required fileNamePattern.
FileOutput - Interface in io.jstach.rainbowgum.file: An output that is designed for writing to a file.
File Output - Section in Overview
FileOutputBuilder - Class in io.jstach.rainbowgum.file: Builder to create LogProvider<FileOutput>.
FileOutputBuilder(String) - Constructor for class io.jstach.rainbowgum.file.FileOutputBuilder: Create a builder for io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.file.FileOutput> .
Filtering - Section in Overview
find(Class) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Finds all services of a specific type.
findGlobalProperties() - Static method in interface io.jstach.rainbowgum.LogProperties: Finds global properties by checking the currently bound rainbow gum and if not set use system properties.
findGlobalProperties(Supplier) - Static method in interface io.jstach.rainbowgum.LogProperties: Finds global properties by checking the currently bound rainbow gum and if not set use the supplier as the fallback.
findOrNull(Class) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Finds a service with the default name of "default" or null.
findOrNull(Class, String) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Finds a service or null.
findOrNull(String, String, BiFunction) - Method in interface io.jstach.rainbowgum.LogProperties: Searches up a "." separated path using this properties to check for values.
findProviders(ServiceLoader, Class) - Static method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider: Finds service providers based on type.
findUpPathOrNull(String, Function) - Static method in interface io.jstach.rainbowgum.LogProperties: Searches a "." separated property path recursing up the path till a non null value (not missing) is found.
FIRST - Enum constant in enum class io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Pass: First pass.
flag(LogAppender.AppenderFlag) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Adds a flag.
flag(LogRouter.RouteFlag) - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder: Adds a flag.
flags(Collection) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets appender flags.
flatten(List) - Static method in interface io.jstach.rainbowgum.LogProvider: Flattens a list of providers to a single provider of a list.
flush() - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
flush() - Method in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput
flush() - Method in interface io.jstach.rainbowgum.LogOutput: Flushes if the output is maintaining a buffer.
flush() - Method in interface io.jstach.rainbowgum.LogOutputRegistry: Attempts to flush all outputs usually for log rotation.
flush() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
flush() - Method in class io.jstach.rainbowgum.output.ListLogOutput
FOLLOW - Enum constant in enum class io.jstach.rainbowgum.output.ConsoleStream: Reads System.out or System.err on every write, so output follows the stream if it is rebound, for example by a test capturing standard out.
FORBID - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.ThreadLocalMode: Nothing in the logging path uses a thread local: appenders with a thread local buffer become LogAppender.AppenderType.LOCK_NEW_BUFFER, and modules that keep context in a thread local, such as SLF4J's MDC, turn it off.
FORCE - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ColorMode: The theme, or TTLL.ColorTheme.RAINBOWGUM when no theme is set, regardless of ANSI detection.
forEach(KeyValues.KeyValuesConsumer, int, V) - Method in interface io.jstach.rainbowgum.KeyValues: Used to easily iterate over the key value pairs without using an iterator.
forEach(Class, BiConsumer) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Finds all services of a specific type.
forEach(BiConsumer) - Method in interface io.jstach.rainbowgum.KeyValues: Used to easily iterate over the key value pairs without using an iterator.
forKey(String) - Method in interface io.jstach.rainbowgum.LogProperties: Starts resolving a property under key against this properties - the preferred entry point for looking up and converting a property, see LogProperty.
forKey(String, String) - Method in interface io.jstach.rainbowgum.LogProperties: Starts resolving a property under key, with a {name} placeholder in key interpolated to nameParam, against this properties.
format(KeyValuesFormatterBuilder.Format) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: Sets required format.
format(KeyValuesFormatterBuilder.Format) - Method in class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder: Selects the syntax.
format(StringBuilder, LogEvent) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter
format(StringBuilder, LogEvent) - Method in interface io.jstach.rainbowgum.LogFormatter.EventFormatter
format(StringBuilder, LogEvent) - Method in interface io.jstach.rainbowgum.LogFormatter: Formats a log event.
format(StringBuilder, LogEvent) - Method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter
format(StringBuilder, LogEvent) - Method in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter
format(StringBuilder, LogEvent) - Method in record class io.jstach.rainbowgum.LogFormatter.StaticFormatter
format(StringBuilder, LogEvent) - Method in interface io.jstach.rainbowgum.LogFormatter.ThrowableFormatter
format(StringBuilder, LogEvent) - Method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter
format(StringBuilder, CharSequence) - Method in record class io.jstach.rainbowgum.pattern.Padding: Pads the input sequence based on this instance of padding info.
format(StringBuilder, String, Object) - Method in interface io.jstach.rainbowgum.LogMessageFormatter: Formats and appends the results.
format(StringBuilder, String, Object, Object) - Method in interface io.jstach.rainbowgum.LogMessageFormatter: Formats and appends the results.
formatArray(StringBuilder, String, Object[]) - Method in interface io.jstach.rainbowgum.LogMessageFormatter: Formats and appends the result.
formatArray(StringBuilder, String, Object[], int) - Method in interface io.jstach.rainbowgum.LogMessageFormatter: Formats and appends the result.
formatLevel(StringBuilder, System.Logger.Level) - Method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter: Formats the level.
formatLevel(StringBuilder, System.Logger.Level) - Method in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter
formatLevel(System.Logger.Level) - Method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter: Formats a level.
formattedMessage(StringBuilder) - Method in interface io.jstach.rainbowgum.LogEvent: Appends the formatted message.
formattedMessage(StringBuilder, String) - Method in interface io.jstach.rainbowgum.LogEvent: Appends the formatted message.
formatter() - Method in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: The formatter for this choice, without the enclosing braces supplied by TTLL.
formatter() - Method in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: The formatter for this choice.
formatter() - Method in enum class io.jstach.rainbowgum.format.TTLL.LoggerFormat: The formatter for this choice.
formatter() - Method in enum class io.jstach.rainbowgum.format.TTLL.ThreadFormat: The formatter for this choice.
formatter() - Method in enum class io.jstach.rainbowgum.format.TTLL.TimestampFormat: The formatter for this choice.
formatter(LogFormatter) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets formatter as encoder.
formatter(LogFormatter.EventFormatter) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets formatter as encoder.
Formatters - Section in Overview
formatThrowable(StringBuilder, Throwable) - Method in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter
formatThrowable(StringBuilder, Throwable) - Method in interface io.jstach.rainbowgum.LogFormatter.ThrowableFormatter: Formats a throwable and appends.
formatTimestamp(StringBuilder, Instant) - Method in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter
formatTimestamp(StringBuilder, Instant) - Method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: Format timestamp.
ForwardingLogger - Interface in io.jstach.rainbowgum.slf4j: A logger that forwards calls to the ForwardingLogger.delegate() logger.
ForwardingLogProperties - Class in io.jstach.rainbowgum.properties: Properties that forward every lookup to a delegate, for writing decorators that observe or change lookups.
ForwardingLogProperties() - Constructor for class io.jstach.rainbowgum.properties.ForwardingLogProperties: For subclasses.
freeze() - Method in interface io.jstach.rainbowgum.KeyValues: Makes the KeyValues thread safe either by copying or returning if already immutable.
freeze() - Method in interface io.jstach.rainbowgum.LogEvent.Caller: Make the caller info immutable.
freeze() - Method in interface io.jstach.rainbowgum.LogEvent: Freeze will return a LogEvent that is safe to use in a different thread.
freeze(Instant) - Method in interface io.jstach.rainbowgum.LogEvent: Freeze and replace with the given timestamp.
from(TTLL.ColorTheme) - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder: Starts from another theme's colors.
fromFunction(Function) - Method in class io.jstach.rainbowgum.LogProperties.Builder: Sets what is called on LogProperties.valueOrNull(String).
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.file.FileOutputBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.jfr.JfrAlertListenerBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Fills in whatever of flags/appender type is not already explicitly set on this builder from properties keyed under LogAppender.Builder.propertyPrefix() for this builder's name; an already-set field always wins over the property, matching every other generated builder's fromProperties in this project.
fromProperties(LogProperties) - Method in interface io.jstach.rainbowgum.LogBuilder: Will try to convert string key values to parameters needed by the builder.
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.output.StdErrOutputBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.output.StdOutOutputBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder
fromProperties(LogProperties) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder
fromProperties(LogProperties, LogProviderRef) - Method in interface io.jstach.rainbowgum.LogBuilder: Will try to convert string key values to parameters needed by the builder.
fromProperties(String) - Method in class io.jstach.rainbowgum.LogProperties.Builder: Parses a string as Properties.
fromURIQuery(URI) - Method in class io.jstach.rainbowgum.LogProperties.Builder: Parses a string as a URI query string.
FULL - Enum constant in enum class io.jstach.rainbowgum.format.Json5PrettyPrint: Each of the event's fields on its own line, indented one space like the rainbowgum-json encoders' pretty print, with nested key values on one line.
FULL - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LoggerFormat: Full logger name.

G

gauge(String, System.Logger.Level) - Method in interface io.jstach.rainbowgum.LogMetrics: Creates a handle for updating a named value directly.
GELF_SCHEME - Static variable in class io.jstach.rainbowgum.json.encoder.GelfEncoder: GELF encoder URI scheme.
GelfEncoder - Class in io.jstach.rainbowgum.json.encoder: A JSON encoder in GELF JSON format.
GelfEncoderBuilder - Class in io.jstach.rainbowgum.json.encoder: Builder to create GelfEncoder.
GelfEncoderBuilder(String) - Constructor for class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Create a builder for io.jstach.rainbowgum.json.encoder.GelfEncoder .
GelfEncoderConfigurator - Class in io.jstach.rainbowgum.json.encoder: Adds GELF JSON Encoder to encoder registry with "gelf" URI scheme.
GelfEncoderConfigurator() - Constructor for class io.jstach.rainbowgum.json.encoder.GelfEncoderConfigurator: Default constructor for service loader.
GELF JSON Encoder - Section in Overview
GeneratedByATrustedSource - Annotation Interface in io.jstach.rainbowgum.annotation: Indicates a class that was copied from another trusted open source project and does not need test coverage.
getContext(String, ClassLoader, Object, boolean) - Method in class io.jstach.rainbowgum.log4j.RainbowGumLoggerContextFactory
getContext(String, ClassLoader, Object, boolean, URI, String) - Method in class io.jstach.rainbowgum.log4j.RainbowGumLoggerContextFactory
getFormattedMessageBuilder() - Method in class io.jstach.rainbowgum.json.JsonBuffer: Reusable String buffer for formatted messages.
getLogger(String) - Method in class io.jstach.rainbowgum.avaje.RainbowGumAppLog
getLogger(String) - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
getLogger(String) - Method in class io.jstach.rainbowgum.jul.logmanager.RainbowGumLogManager
getLogger(String, Module) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder
getLogger(String, ResourceBundle) - Method in class io.jstach.rainbowgum.avaje.RainbowGumAppLog
getLoggerFactory() - Method in class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider
getLoggerNames() - Method in class io.jstach.rainbowgum.jul.logmanager.RainbowGumLogManager
getMarkerFactory() - Method in class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider
getMdc(String) - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
getMDCAdapter() - Method in class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider
getMdcMap() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
getName() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
getName() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
getName() - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
getNdc() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
getNdcDepth() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
getOrNull() - Static method in interface io.jstach.rainbowgum.RainbowGum: Gets the currently statically bound RainbowGum or null if none are finished binding.
getOrNull(String) - Method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry: Gets the formatter factory for the pattern key.
getRequestedApiVersion() - Method in class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider
Getting Started - Section in Overview
getValueOrNull(String) - Method in interface io.jstach.rainbowgum.KeyValues: Analogous to Map.get(Object)
global() - Static method in interface io.jstach.rainbowgum.LogRouter: Global router which is always available.
global(LogEventFactory.KeyValuesContributor.Source...) - Static method in interface io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor: Combines the contributors registered with whichever RainbowGum is bound globally at the time key values are requested, skipping the excluded sources.
GLOBAL_ANSI_MODE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Whether output uses ANSI escape codes: see LogConfig.Globals.AnsiMode.
GLOBAL_APPENDER_LOCK_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Which kind of lock appenders use: see LogConfig.Globals.AppenderLock.
GLOBAL_OPTIMIZE_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Opts every appender/encoder that has not been given an explicit choice into whatever this release currently believes is the best buffering/locking strategy for the platform the process is actually running on, instead of the fixed defaults (LogAppender.AppenderType.LOCK_THREAD_LOCAL_BUFFER, a CharsetEncoder-based encode) used otherwise.
GLOBAL_QUEUE_ERROR_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: The level threshold of queued events reported to standard error before Rainbow Gum is bound.
GLOBAL_QUEUE_LEVEL_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: The level threshold of events captured before Rainbow Gum is fully bound.
GLOBAL_THREAD_LOCAL_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Whether the logging path may use a ThreadLocal: see LogConfig.Globals.ThreadLocalMode.
globals() - Method in interface io.jstach.rainbowgum.LogConfig: Settings that apply to the whole configuration rather than to one component, resolved once when the config is built.
GraalVM Native Image - Section in Overview
Gradle - Section in Overview
GRAY - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI gray color
GREEN - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI green color
GROUP_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Group property with list of logger names.
GROUPS_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Enabled level groups.
Groups for difficult logger names - Section in Overview

H

hashCode() - Method in class io.jstach.rainbowgum.file.DataSize
hashCode() - Method in record class io.jstach.rainbowgum.LogAlerts.Stats: Returns a hash code value for this object.
hashCode() - Method in record class io.jstach.rainbowgum.LogFormatter.StaticFormatter: Returns a hash code value for this object.
hashCode() - Method in record class io.jstach.rainbowgum.LogMetrics.Metric: Returns a hash code value for this object.
hashCode() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error: Returns a hash code value for this object.
hashCode() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing: Returns a hash code value for this object.
hashCode() - Method in record class io.jstach.rainbowgum.pattern.Padding: Returns a hash code value for this object.
hasMessage() - Method in interface io.jstach.rainbowgum.LogEvent: If the event has a message or not.
headers(Map) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Sets headers.
headers(Map) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets headers.
Helidon - Section in Overview
HELP - Enum constant in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Everything LogConfig.DebugModeType.ALL does, then fails after Rainbow Gum starts if a property key set in a source that can list its keys (system properties, property files) was never read and is close to a key that was, which is almost always a typo.
HIGHLIGHT - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: A special color composite key that will highlight based on logger level.
host(String) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Sets required host.
How it works - Section in Overview
HTTP_JSON - Enum constant in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: JSON, application/json.
HTTP_PROTOBUF - Enum constant in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: Binary protobuf, application/x-protobuf (the OTLP default).

I

ID - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ThreadFormat: Thread id.
IGNORE_GLOBAL_LEVEL_RESOLVER - Enum constant in enum class io.jstach.rainbowgum.LogRouter.RouteFlag: The route will not use the global level resolver and will only use the level config directly on the router.
Implicit default configuration - Section in Overview
increment() - Method in interface io.jstach.rainbowgum.LogMetrics.Gauge: Increments the value by one.
increment(long) - Method in interface io.jstach.rainbowgum.LogMetrics.Gauge: Adds the supplied amount.
info(Class, String) - Method in interface io.jstach.rainbowgum.LogAlerts: Records an informational alert.
info(String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(Marker, String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(Marker, String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(Marker, String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(Marker, String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(Marker, String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(Marker, String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(Marker, String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(Marker, String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
info(Marker, String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
info(Marker, String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
INFO - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.UnusedKeyLevel: Default.
INFO - Enum constant in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Dump collected alerts after every successful config build and on build failure.
infoCounter(String, long) - Method in interface io.jstach.rainbowgum.LogMetrics: Like LogMetrics.errorCounter(String, long) but for a plain running total, not inherently a problem or even a trend worth watching.
initialBufferSize(int) - Method in class io.jstach.rainbowgum.LogEncoder.Builder: The capacity a fresh buffer is allocated with before any event has been encoded into it.
initialization() - Method in class io.jstach.rainbowgum.helidon27.RainbowGumLoggingProvider
initialization() - Method in class io.jstach.rainbowgum.helidon4.RainbowGumLoggingProvider
initialize() - Method in class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider
initialize(RainbowGum) - Method in class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider: For testing Rainbow Gums SLF4J without initializing SLF4J.
INITIALIZE_RAINBOW_GUM_PROPERTY - Static variable in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder: Initialization flag.
initOption(LogProperties) - Static method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder: Gets the init option from properties.
install(LogProperties) - Static method in class io.jstach.rainbowgum.jul.JULConfigurator: Will install the JUL handler if not disabled by properties.
Installation - Section in Overview
INSTANCE - Enum constant in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter: instance.
instanceId() - Method in interface io.jstach.rainbowgum.RainbowGum: Unique id of rainbow gum instance.
interpolateKey(String, Function) - Static method in interface io.jstach.rainbowgum.LogProperties: Replaces property key parameters by using the lookup function.
interpolateKey(String, Map) - Static method in interface io.jstach.rainbowgum.LogProperties: Replace "{name}" tokens in property names.
interpolateNamedKey(String, String) - Static method in interface io.jstach.rainbowgum.LogProperties: Interpolates a named key which is a property key that has a "name".
io.jstach.rainbowgum - module io.jstach.rainbowgum: Core module for RainbowGum which provides low level components for logging as well as a builder for creating custom RainbowGums.
io.jstach.rainbowgum - package io.jstach.rainbowgum: RainbowGum core components.
io.jstach.rainbowgum.annotation - module io.jstach.rainbowgum.annotation: Rainbowgum Annotations used for code generation.
io.jstach.rainbowgum.annotation - package io.jstach.rainbowgum.annotation: RainbowGum annotations used for static code generation.
io.jstach.rainbowgum.avaje - module io.jstach.rainbowgum.avaje: Uses Avaje Config for LogProperties.
io.jstach.rainbowgum.avaje - package io.jstach.rainbowgum.avaje: Avaje Config Log Properties implemention.
io.jstach.rainbowgum.bundle - module io.jstach.rainbowgum.bundle: RainbowGum default grouping of modules transitively pulled in from Maven and module system.
io.jstach.rainbowgum.disruptor - module io.jstach.rainbowgum.disruptor: EXPERIMENTAL Disruptor async publisher.
io.jstach.rainbowgum.disruptor - package io.jstach.rainbowgum.disruptor: Disruptor publisher.
io.jstach.rainbowgum.file - module io.jstach.rainbowgum.file: File output - FileOutput registered under the file URI scheme - plus bare minimum size based rolling on top of it, see RollingFileOutput for the full property list and scope - deliberately does not support calendar/date based rotation or Logback's own fileNamePattern conventions, only a numbered-suffix (%i) scheme.
io.jstach.rainbowgum.file - package io.jstach.rainbowgum.file: File output - see FileOutput.
io.jstach.rainbowgum.format - package io.jstach.rainbowgum.format: Standard Formatters.
io.jstach.rainbowgum.helidon27 - module io.jstach.rainbowgum.helidon27: Rainbow Gum Helidon SE 27.x integration: implements Helidon's own LoggingProvider extension point (the same one io.helidon.logging.jul.JulProvider/ io.helidon.logging.log4j.Log4jProvider implement), registered via ServiceLoader.
io.jstach.rainbowgum.helidon27 - package io.jstach.rainbowgum.helidon27: Rainbow Gum integration for Helidon SE 27.x.
io.jstach.rainbowgum.helidon4 - module io.jstach.rainbowgum.helidon4: Rainbow Gum Helidon SE 4.x integration: implements Helidon's own LoggingProvider extension point (the same one io.helidon.logging.jul.JulProvider/ io.helidon.logging.log4j.Log4jProvider implement), registered via ServiceLoader.
io.jstach.rainbowgum.helidon4 - package io.jstach.rainbowgum.helidon4: Rainbow Gum integration for Helidon SE 4.x.
io.jstach.rainbowgum.jansi - module io.jstach.rainbowgum.jansi: JANSI module that will install Jansi.
io.jstach.rainbowgum.jansi - package io.jstach.rainbowgum.jansi: JAnsi initializer.
io.jstach.rainbowgum.jbosslogging - module io.jstach.rainbowgum.jbosslogging: Rainbow Gum JBoss Logging integration: a native LoggerProvider implementation, not a bridge through SLF4J.
io.jstach.rainbowgum.jbosslogging - package io.jstach.rainbowgum.jbosslogging
io.jstach.rainbowgum.jdk - module io.jstach.rainbowgum.jdk: Rainbow Gum JDK components.
io.jstach.rainbowgum.jfr - module io.jstach.rainbowgum.jfr: Provides a LogOutput that commits each log event as a JDK Flight Recorder event instead of writing bytes anywhere, with URI scheme "jfr", as well as a LogAlerts.Listener that does the same for alerts (opt-in, see JfrAlertListenerConfigurator).
io.jstach.rainbowgum.jfr - package io.jstach.rainbowgum.jfr: A LogOutput backed by JDK Flight Recorder (JFR), inspired by JFRLog.
io.jstach.rainbowgum.json - module io.jstach.rainbowgum.json: Provides JSON encoders.
io.jstach.rainbowgum.json - package io.jstach.rainbowgum.json: JSON related formatters and buffers.
io.jstach.rainbowgum.json.encoder - package io.jstach.rainbowgum.json.encoder: Common JSON encoders like GELF, ECS, Logstash's, and Logback's own JSON format.
io.jstach.rainbowgum.jul - module io.jstach.rainbowgum.jul: Rainbow Gum JUL (java.util.logging) integration.
io.jstach.rainbowgum.jul - package io.jstach.rainbowgum.jul: JUL implementation.
io.jstach.rainbowgum.jul.logmanager - module io.jstach.rainbowgum.jul.logmanager: A LogManager replacement that routes every java.util.logging.Logger directly through Rainbow Gum, bypassing the standard JUL Handler/Level dispatch machinery entirely.
io.jstach.rainbowgum.jul.logmanager - package io.jstach.rainbowgum.jul.logmanager: A java.util.logging.LogManager implementation backed by Rainbow Gum.
io.jstach.rainbowgum.keyvalues.contributor - module io.jstach.rainbowgum.keyvalues.contributor: EXPERIMENTAL Key values added to every event, such as a build version or instance id, from properties or code.
io.jstach.rainbowgum.keyvalues.contributor - package io.jstach.rainbowgum.keyvalues.contributor
io.jstach.rainbowgum.log4j - module io.jstach.rainbowgum.log4j: Rainbow Gum Log4j2 integration: a native LoggerContextFactory implementation, not a bridge through SLF4J.
io.jstach.rainbowgum.log4j - package io.jstach.rainbowgum.log4j
io.jstach.rainbowgum.opentelemetry - module io.jstach.rainbowgum.opentelemetry: Adds the trace and span id of the current OpenTelemetry span to every event as the key values traceId and spanId, the names Micrometer Tracing uses and the OTLP output reads.
io.jstach.rainbowgum.opentelemetry - package io.jstach.rainbowgum.opentelemetry
io.jstach.rainbowgum.otlp - module io.jstach.rainbowgum.otlp: OpenTelemetry Protocol (OTLP) log export without the OpenTelemetry SDK or any protobuf library: an OTLP/JSON lines encoder and an OTLP/HTTP output that sends either protobuf or JSON.
io.jstach.rainbowgum.otlp - package io.jstach.rainbowgum.otlp: OTLP log export.
io.jstach.rainbowgum.output - package io.jstach.rainbowgum.output: Standard Outputs.
io.jstach.rainbowgum.pattern - module io.jstach.rainbowgum.pattern: Provides Logback style pattern formatters. The URI scheme of pattern encoders is "pattern".
io.jstach.rainbowgum.pattern - package io.jstach.rainbowgum.pattern: Base types for pattern compiling.
io.jstach.rainbowgum.pattern.format - package io.jstach.rainbowgum.pattern.format: Provides Logback style pattern formatters. The URI scheme of pattern encoders is "pattern".
io.jstach.rainbowgum.pattern.format.spi - package io.jstach.rainbowgum.pattern.format.spi: SPI for adding custom pattern keywords.
io.jstach.rainbowgum.properties - package io.jstach.rainbowgum.properties: Support for working with properties, such as ForwardingLogProperties for decorators.
io.jstach.rainbowgum.publisher - package io.jstach.rainbowgum.publisher: Standard publishers.
io.jstach.rainbowgum.rolling - package io.jstach.rainbowgum.rolling: Bare minimum size based rolling file output - see RollingFileOutput.
io.jstach.rainbowgum.scopedkeyvalues - module io.jstach.rainbowgum.scopedkeyvalues: A small, self-contained facade for request/task-scoped key values - see ScopedKeyValues.
io.jstach.rainbowgum.scopedkeyvalues - package io.jstach.rainbowgum.scopedkeyvalues: A small, self-contained facade for request/task-scoped key values - see ScopedKeyValues.
io.jstach.rainbowgum.scopedkeyvalues.provider - module io.jstach.rainbowgum.scopedkeyvalues.provider: The RainbowGum-backed io.jstach.rainbowgum.scopedkeyvalues.spi.ScopedKeyValuesProvider for io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues - request/task-scoped key values backed by java.lang.ScopedValue instead of ThreadLocal.
io.jstach.rainbowgum.scopedkeyvalues.provider - package io.jstach.rainbowgum.scopedkeyvalues.provider: The RainbowGum-backed ScopedKeyValuesProvider, using java.lang.ScopedValue for storage, plus the RainbowGumServiceProvider that registers it as a key values contributor for every logging API.
io.jstach.rainbowgum.scopedkeyvalues.spi - package io.jstach.rainbowgum.scopedkeyvalues.spi: The single extension point ScopedKeyValues discovers via ServiceLoader.
io.jstach.rainbowgum.simple.props - module io.jstach.rainbowgum.simple.props: Loads LogProperties from system properties, environment variables, profile resources, and a classpath logging.properties resource.
io.jstach.rainbowgum.simple.props - package io.jstach.rainbowgum.simple.props: A simple LogProperties source loading classpath:/logging.properties, system properties, and environment variables - see SimpleProperties for priority and the environment variable naming convention.
io.jstach.rainbowgum.slf4j - module io.jstach.rainbowgum.slf4j: SLF4J 2.0 implementation.
io.jstach.rainbowgum.slf4j - package io.jstach.rainbowgum.slf4j: SLF4J implementation.
io.jstach.rainbowgum.slf4j.spi - package io.jstach.rainbowgum.slf4j.spi: SLF4J specific rainbowgum services providers.
io.jstach.rainbowgum.spi - package io.jstach.rainbowgum.spi: SPI for RainbowGum.
io.jstach.rainbowgum.spring.boot.spi - module io.jstach.rainbowgum.spring.boot.spi: Rainbow Gum Spring SPI: shared by io.jstach.rainbowgum.spring.boot3 and io.jstach.rainbowgum.spring.boot4.
io.jstach.rainbowgum.spring.boot.spi - package io.jstach.rainbowgum.spring.boot.spi: Spring Rainbow Gum SPI.
io.jstach.rainbowgum.spring.boot3 - module io.jstach.rainbowgum.spring.boot3: Rainbow Gum Spring Boot 3 integration.
io.jstach.rainbowgum.spring.boot3.starter - module io.jstach.rainbowgum.spring.boot3.starter: Spring Boot 3 Rainbow Gum Integration.
io.jstach.rainbowgum.spring.boot4 - module io.jstach.rainbowgum.spring.boot4: Rainbow Gum Spring Boot 4 integration.
io.jstach.rainbowgum.spring.boot4.actuator - module io.jstach.rainbowgum.spring.boot4.actuator: Rainbow Gum Spring Boot 4 Actuator/Micrometer integration.
io.jstach.rainbowgum.spring.boot4.starter - module io.jstach.rainbowgum.spring.boot4.starter: Spring Boot 4 Rainbow Gum Integration.
io.jstach.rainbowgum.systemlogger - module io.jstach.rainbowgum.systemlogger: This module provides a partial System.Logger implementation.
io.jstach.rainbowgum.systemlogger - package io.jstach.rainbowgum.systemlogger: Rainbow Gum System Logger implementation.
io.jstach.rainbowgum.tomcat - module io.jstach.rainbowgum.tomcat: Rainbow Gum Tomcat logging implementation usually for Spring Boot.
isAnsiSupported() - Static method in class io.jstach.rainbowgum.format.AnsiSupport: Determines if ANSI escape codes are likely supported by the current process's standard output.
isChangeable(String) - Method in interface io.jstach.rainbowgum.LogRouter.RootRouter: If a logger name configuration is changeable.
isClassLoaderDependent() - Method in class io.jstach.rainbowgum.log4j.RainbowGumLoggerContextFactory
isDebugEnabled() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isDebugEnabled() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isDebugEnabled(Marker) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isDebugEnabled(Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isEmpty() - Method in interface io.jstach.rainbowgum.KeyValues: Analogous to Map.isEmpty().
isEnabled() - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
isEnabled() - Method in interface io.jstach.rainbowgum.LogRouter.Route: Determines if LogEventLogger.log(LogEvent) maybe called.
isEnabled(String) - Method in interface io.jstach.rainbowgum.LogConfig.ChangePublisher: Test to see if any changes are enabled for a logger - either LogConfig.ChangePublisher.allowedChanges(String) is non-empty or LogConfig.ChangePublisher.callerType(String) is not LogEvent.Caller.CallerType.NONE.
isEnabled(String, System.Logger.Level) - Method in interface io.jstach.rainbowgum.LevelResolver: Convenience method that checks if the loggers resolved level is less than the passed in level.
isEnabled(Level, Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger: Cheap pre-check run before any LoggingEventBuilder is built, analogous to isInfoEnabled()/isInfoEnabled(Marker).
isEnabledForLevel(Level) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isEnabledForLevel(Level) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isErrorEnabled() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isErrorEnabled() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isErrorEnabled(Marker) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isErrorEnabled(Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isExceptionFormatter() - Method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory: Whether this factory's formatter renders (or, like %nopex, deliberately suppresses) a throwable, and thus counts as the pattern having addressed exception rendering itself.
isGauge() - Method in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: Whether this metric can decrease and should be bound as a gauge instead of an increasing counter.
isInfoEnabled() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isInfoEnabled() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isInfoEnabled(Marker) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isInfoEnabled(Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isInstalled() - Static method in class io.jstach.rainbowgum.jul.JULConfigurator: Will test if already installed.
isLoggable(String, Level) - Static method in class io.jstach.rainbowgum.jul.JULBridge: Whether a logger name at a given JUL level is currently enabled, per Rainbow Gum's own level resolution rather than anything cached on a JUL Logger/Handler.
isLoggable(System.Logger.Level) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
isNoop() - Method in interface io.jstach.rainbowgum.LogFormatter: Ask the formatter if will do anything.
isNoopOrNull(LogFormatter) - Static method in interface io.jstach.rainbowgum.LogFormatter: Tests if the log formatter is noop or is null which will be considered as noop.
ISO - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.TimestampFormat: ISO 8601 UTC instant with milliseconds, 2026-10-05T12:00:00.123Z.
isOversized() - Method in class io.jstach.rainbowgum.json.JsonBuffer
isOversized() - Method in interface io.jstach.rainbowgum.LogEncoder.Buffer: Whether this buffer has grown large enough (its capacity, not how much of that capacity the last event actually used) that its backing storage is worth shrinking back down rather than kept at its grown size indefinitely - reused buffers only grow on their own, they never shrink back down without deliberate help.
isTraceEnabled() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isTraceEnabled() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isTraceEnabled(Marker) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isTraceEnabled(Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isWarnEnabled() - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isWarnEnabled() - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
isWarnEnabled(Marker) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
isWarnEnabled(Marker) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger

J

JANSI_DISABLE - Static variable in class io.jstach.rainbowgum.jansi.JAnsiConfigurator: Jansi disable property.
JAnsiConfigurator - Class in io.jstach.rainbowgum.jansi: JAnsi Configurator which will install JAnsi.
JAnsiConfigurator() - Constructor for class io.jstach.rainbowgum.jansi.JAnsiConfigurator: No Arg for service loader.
JAnsi support (largely legacy) - Section in Overview
java.lang.System.Logger and java.util.logging - Section in Overview
JBOSS_LOGGING - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: rainbowgum-jboss-logging (org.jboss.logging.MDC).
JBOSS_LOGGING - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: rainbowgum-jboss-logging.
JBossKeyValuesConfigurator - Class in io.jstach.rainbowgum.jbosslogging: Registers JBoss Logging's MDC as a LogEventFactory.KeyValuesContributor for LogEventFactory.KeyValuesContributor.Source.Standard.JBOSS_LOGGING so events from other logging APIs carry it as well.
JBossKeyValuesConfigurator() - Constructor for class io.jstach.rainbowgum.jbosslogging.JBossKeyValuesConfigurator: For service loader.
JBoss Logging - Section in Overview
JDK Flight Recorder (JFR) - Section in Overview
JFR_SCHEME - Static variable in class io.jstach.rainbowgum.jfr.JfrLogOutput: JFR output URI scheme.
JfrAlertListener - Class in io.jstach.rainbowgum.jfr: A LogAlerts.Listener that commits each alert as its own RainbowGumAlertEvent - deliberately a separate JFR event type family from JfrLogOutput's RainbowGumLogEvent, even though the shape (per-level split, same fields) and rendering are the same; see RainbowGumAlertEvent for why sharing one event type between alerts and application log lines was rejected.
JFR Alert Listener - Section in Overview
JfrAlertListener.Mode - Enum Class in io.jstach.rainbowgum.jfr: Whether alerts are committed as JFR events.
JfrAlertListenerBuilder - Class in io.jstach.rainbowgum.jfr: Builder to create JfrAlertListener.
JfrAlertListenerBuilder() - Constructor for class io.jstach.rainbowgum.jfr.JfrAlertListenerBuilder: Create a builder for io.jstach.rainbowgum.jfr.JfrAlertListener .
JfrAlertListenerConfigurator - Class in io.jstach.rainbowgum.jfr: Registers a JfrAlertListener with LogAlerts if "logging.jfr.alerts.mode" is on.
JfrAlertListenerConfigurator() - Constructor for class io.jstach.rainbowgum.jfr.JfrAlertListenerConfigurator: Default constructor for service loader.
JfrConfigurator - Class in io.jstach.rainbowgum.jfr: Adds JfrLogOutput to the output registry with URI scheme "jfr".
JfrConfigurator() - Constructor for class io.jstach.rainbowgum.jfr.JfrConfigurator: Default constructor for service loader.
JfrLogOutput - Class in io.jstach.rainbowgum.jfr: A LogOutput that commits each log event as a JFR event (see RainbowGumLogEvent) instead of writing anywhere.
JfrLogOutput() - Constructor for class io.jstach.rainbowgum.jfr.JfrLogOutput: Creates a JFR output that emits events only for whatever externally started Flight Recorder session (if any) is currently running, without managing a recording of its own.
JfrLogOutput(URI, Path) - Constructor for class io.jstach.rainbowgum.jfr.JfrLogOutput: Creates a JFR output.
JSON - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder.Format: JSON, with every key enclosed in double quotes.
JSON - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: JSON: {"requestId":"42","user":"Ada Lovelace"}.
JSON5 - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder.Format: JSON5, with identifier keys left unquoted.
JSON5 - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: JSON5, with valid identifier keys left unquoted: {requestId:"42",user:"Ada Lovelace"}.
JSON5 Formatter - Section in Overview
Json5FormatterBuilder - Class in io.jstach.rainbowgum.format: Builder to create LogFormatter.
Json5FormatterBuilder(String) - Constructor for class io.jstach.rainbowgum.format.Json5FormatterBuilder: Create a builder for io.jstach.rainbowgum.LogFormatter .
Json5PrettyPrint - Enum Class in io.jstach.rainbowgum.format: How the core json5 encoder lays out each event's object.
JsonBuffer - Class in io.jstach.rainbowgum.json: A buffer designed for encoding JSON efficiently.
JsonBuffer(boolean, JsonBuffer.ExtendedFieldPrefix, int) - Constructor for class io.jstach.rainbowgum.json.JsonBuffer: Create a JSON buffer.
JsonBuffer.ExtendedFieldPrefix - Enum Class in io.jstach.rainbowgum.json: Extended fields are just fields that have some special prefix for things like GELF and ECS.
JsonBuffer.JSONToken - Enum Class in io.jstach.rainbowgum.json: JSON tokens.
JSON Encoders - Section in Overview
JSON Key Values Formatter - Section in Overview
JUL - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: rainbowgum-jul-logmanager (java.util.logging).
JUL - Enum constant in enum class io.jstach.rainbowgum.LogMessageFormatter.StandardMessageFormatter: java.util.logging MessageFormat style.
JUL_DISABLE_PROPERTY - Static variable in class io.jstach.rainbowgum.jul.JULConfigurator: If true will not install the JUL handler.
JUL_LEVEL_DISABLE_PROPERTY - Static variable in class io.jstach.rainbowgum.jul.JULConfigurator: If true will not set the root loggers level to whatever the curreint rainbow gums global level default is.
JULBridge - Class in io.jstach.rainbowgum.jul: Translates java.util.logging.LogRecord into Rainbow Gum LogEvent and routes it through LogRouter.global().
JULConfigurator - Class in io.jstach.rainbowgum.jul: Will install the JUL handler if the java.logging module is available and is not alreadyi installed.
JULConfigurator() - Constructor for class io.jstach.rainbowgum.jul.JULConfigurator: For service laoder.

K

KEEP - Enum constant in enum class io.jstach.rainbowgum.LogFormatter.KeyValueNullStrategy

The null/empty-string distinction is preserved: a null value prints just the key with no =, while an empty string prints key=.

key() - Method in interface io.jstach.rainbowgum.LogProperty

The first key tried.

key() - Method in exception class io.jstach.rainbowgum.LogProperty.PropertyConvertException

Property key.

key() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error

Returns the value of the key record component.

key() - Method in interface io.jstach.rainbowgum.LogProperty.Result.Success

Original property key where the value was derived from or was passed a fallback.

key() - Method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry.PatternKeyProvider

Key

KEY_VALUES_DISABLED_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties

A comma separated list of key value sources (the lowercase names of LogEventFactory.KeyValuesContributor.Source.Standard, for example defaults,slf4j) whose contributors are left out of every event's key values.

KEY_VALUES_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties

Key values namespace, for properties that configure where an event's key values come from.

keyOrNull() - Method in interface io.jstach.rainbowgum.LogProviderRef

Property key from where the URI came from or null.

keyParameters(String) - Static method in interface io.jstach.rainbowgum.LogProperties

Extract key parameters with LogProperties.PARAMETER_PATTERN.

keys() - Method in interface io.jstach.rainbowgum.LogProperties.Listable

The keys this source holds.

keys() - Method in interface io.jstach.rainbowgum.LogProperty

Every key tried, in order - the first key given to LogProperties.forKey(String)/LogProperties.forKey(String, String) followed by any added via LogProperty.or(String)/LogProperty.or(String, String).

keys() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing

Returns the value of the keys record component.

keys(List) - Method in class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder

Selects the keys to write, in the supplied order.

keyValue(String, String) - Method in class io.jstach.rainbowgum.LogFormatter.Builder

Creates a formatter that will print a single key's value, Logback/Log4j2 %X{key} style: just the raw value (or the fallback, or an empty string if neither is present) - no key prefix, no percent encoding.

keyValues() - Method in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues

keyValues() - Method in interface io.jstach.rainbowgum.LogEvent

Key values that usually come from MDC or an SLF4J Event Builder.

keyValues() - Method in interface io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor

Key values for an event being created on the current thread.

keyValues() - Method in class io.jstach.rainbowgum.LogFormatter.Builder

Adds all of the event's key values in the default key values format, percent encoded like a URI query: requestId=42&user=Ada%20Lovelace.

keyValues() - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder

The key values added to this builder so far (including any inherited from MDC).

keyValues(KeyValuesPlacement) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder

Sets required keyValues.

keyValues(KeyValues) - Method in interface io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor

Like LogEventFactory.KeyValuesContributor.keyValues() but with a logging facade's own key values merged in above every contributor except LogEventFactory.KeyValuesContributor.Source.Standard.USER, which still wins.

keyValues(LogFormatter) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder

Sets required keyValues.

keyValues(String) - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder

Key values color.

keyValues(Consumer) - Method in class io.jstach.rainbowgum.LogFormatter.Builder

Adds the event's key values as configured on a KeyValuesFormatterBuilder, which sets the format (percent encoding by default, JSON, JSON5, or logfmt), the keys, and the null handling, for example:

LogFormatter.builder()
	.keyValues(kv -> kv.format(KeyValuesFormatterBuilder.Format.LOGFMT).keys(List.of("requestId", "user")));

keyValues(LoggingEventBuilder) - Static method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder

The key values added to the builder so far, if possible.

KeyValues - Interface in io.jstach.rainbowgum

Key Value Pairs similar to a Map<String,String> but optimized for memory and less garbage (no iterators).

KeyValues.KeyValuesConsumer<V> - Interface in io.jstach.rainbowgum

A special consumer that avoids lambda garbage.

KeyValues.MutableKeyValues - Interface in io.jstach.rainbowgum

KeyValues that can be updated.

keyValuesDisabled() - Method in class io.jstach.rainbowgum.LogConfig.Globals

Key value sources that are not added to events, from "logging.keyvalues.disabled".

keyValuesDisabled(Set) - Method in class io.jstach.rainbowgum.LogConfig.Builder

Sets the key value sources that are not added to events, used when the property "logging.keyvalues.disabled" is absent.

keyValuesExcluded(List) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder

Sets keyValuesExcluded.

keyValuesExcluded(List) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder

Sets keyValuesExcluded.

keyValuesFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder

mutable field

keyValuesFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter

immutable field

keyValuesFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder

Sets the key values formatter.

KeyValuesFormatterBuilder - Class in io.jstach.rainbowgum.format

Builds a LogFormatter that appends event key values percent encoded, or as JSON, JSON5, or logfmt text, directly to a StringBuilder.

KeyValuesFormatterBuilder() - Constructor for class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder

Creates a builder that writes all event key values percent encoded.

KeyValuesFormatterBuilder.Format - Enum Class in io.jstach.rainbowgum.format

Syntax of the key values object.

keyValuesIncluded(List) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder

Sets keyValuesIncluded.

keyValuesIncluded(List) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder

Sets keyValuesIncluded.

KeyValuesPlacement - Enum Class in io.jstach.rainbowgum.format

Where an event's key values go in a structured event format such as the core json encoder.

keyValuesWhenEmpty(TTLL.KeyValuesWhenEmpty) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder

Sets keyValuesWhenEmpty.

keyword() - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword

Keyword used in pattern.

keyword(PatternRegistry.PatternKey, PatternFormatterFactory.KeywordFactory) - Method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry

Convenience function for PatternRegistry.register(PatternKey, PatternFormatterFactory) as keyword factory is a lambda.

L

label() - Method in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: The protocol name as used by OTEL_EXPORTER_OTLP_PROTOCOL.
LAST - Enum constant in enum class io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Pass: The last pass to return true otherwise Rainbow Gum will fail to load.
leftPad() - Method in record class io.jstach.rainbowgum.pattern.Padding: Returns the value of the leftPad record component.
leftTruncate() - Method in record class io.jstach.rainbowgum.pattern.Padding: Returns the value of the leftTruncate record component.
level() - Method in interface io.jstach.rainbowgum.LogEvent: The logging level.
level() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Adds the default level formatter.
level() - Method in record class io.jstach.rainbowgum.LogMetrics.Metric: Returns the value of the level record component.
level() - Method in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: The significance of this metric, also exposed through LogMetrics.Metric.level() in LogMetrics.snapshot().
level(LogFormatter) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets required level.
level(System.Logger.Level) - Method in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: Sets a level for all loggers.
level(System.Logger.Level, String) - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder: Color of a level.
level(System.Logger.Level, String) - Method in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: Sets a logger to a level.
LEVEL - Enum constant in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeType: The logger is allowed to change levels.
LEVEL - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Level keywords
LEVEL_FILE_PATH_PROPERTY - Static variable in class io.jstach.rainbowgum.simple.props.SimpleProperties: Where the watched level file is, default level.properties.
LEVEL_FILE_PROPERTY - Static variable in class io.jstach.rainbowgum.simple.props.SimpleProperties: Whether to watch a level file for log levels, see "logging.simpleprops.levelFilePath".
LEVEL_PADDING - Enum constant in enum class io.jstach.rainbowgum.format.Json5PrettyPrint: Pads after the level's closing quote so the fields after it line up: level:"INFO" ,logger:....
LEVEL_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Logging level properties prefix.
levelConfigs - Variable in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: level configs.
Level file - Section in Overview
levelFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: mutable field
levelFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: immutable field
levelFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Sets the level formatter.
levelFormatter(LogFormatter.LevelFormatter) - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: Sets required levelFormatter.
Level Groups - Section in Overview
levelOrNull(String) - Method in interface io.jstach.rainbowgum.LevelResolver.LevelConfig: Returns a level exactly matching a logger name.
levelResolver() - Method in interface io.jstach.rainbowgum.LogConfig: Level resolver for resolving levels from logger names.
levelResolver() - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
levelResolver() - Method in interface io.jstach.rainbowgum.LogRouter.RootRouter: Level resolver to find levels for a log name.
levelResolver() - Method in interface io.jstach.rainbowgum.LogRouter.Router: Level resolver.
LevelResolver - Interface in io.jstach.rainbowgum: Resolves levels from logger names.
LevelResolver.AbstractBuilder<T> - Class in io.jstach.rainbowgum: Abstract level resolver builder.
LevelResolver.Builder - Class in io.jstach.rainbowgum: Level resolver builder.
LevelResolver.LevelConfig - Interface in io.jstach.rainbowgum: A special resolver that has direct mappings of logger name to level via LevelResolver.LevelConfig.levelOrNull(String).
Level Resolvers - Section in Overview
levels - Variable in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: levels
Limitations - Section in Overview
LINE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Line no
lineNumber() - Method in interface io.jstach.rainbowgum.LogEvent.Caller: See StackWalker.StackFrame.getLineNumber().
LINESEP - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Newline keywords
lineSeparator() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Line separator for %n by default uses System.lineSeparator().
lineSeparator(String) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets lineSeparator.
LIST_OUTPUT_SCHEME - Static variable in interface io.jstach.rainbowgum.LogOutputRegistry: The URI scheme for list provider.
ListLogOutput - Class in io.jstach.rainbowgum.output: An output for debugging.
ListLogOutput() - Constructor for class io.jstach.rainbowgum.output.ListLogOutput: Creates a list output.
listOrNull(String) - Method in interface io.jstach.rainbowgum.LogProperties: Gets a list or null if the key is missing and by default uses LogProperties.parseList(String).
listOrNull(String) - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
Loading order - Section in Overview
LOCAL_SEQUENCE_NUMBER - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Local sequence number keywords.
LOCK_NEW_BUFFER - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderType: Like LogAppender.AppenderType.LOCK_THREAD_LOCAL_BUFFER (encoding done outside the lock, the lock only guards the final write to the output) except the buffer is allocated fresh for every single event instead of being cached in a ThreadLocal.
LOCK_THREAD_LOCAL_BUFFER - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderType: The appender will give each thread its own reusable buffer (a ThreadLocal) instead of allocating a new buffer per event.
log(LogEvent) - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogPublisher
log(LogEvent) - Method in interface io.jstach.rainbowgum.LogEventLogger: Logs events usually without filtering.
log(LogEvent) - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
log(LogEvent) - Method in interface io.jstach.rainbowgum.LogRouter.Router
log(LogEvent) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher
log(LogEvent) - Method in class io.jstach.rainbowgum.publisher.BlockingQueueAsyncLogPublisher
log(LogEvent) - Method in interface io.jstach.rainbowgum.RainbowGum: This append call is mainly for testing as it does not avoid making events that do not need to be made if no logging needs to be done.
log(System.Logger.Level, String) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(System.Logger.Level, String, Throwable) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(System.Logger.Level, Object) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(System.Logger.Level, ResourceBundle, String, Object...) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(System.Logger.Level, ResourceBundle, String, Throwable) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(System.Logger.Level, Supplier) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(System.Logger.Level, Supplier, Throwable) - Method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger
log(LoggingEventBuilder) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger: Logs a builder obtained from a AbstractFilteringLogger.decorate(LoggingEventBuilder, Marker) override that returned false, with caller-info depth adjusted for the extra frames both AbstractFilteringLogger.decorate(LoggingEventBuilder, Marker) and this method itself add.
Log4j2 - Section in Overview
LOG4J2 - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: rainbowgum-log4j2 (org.apache.logging.log4j.ThreadContext).
LOG4J2 - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: rainbowgum-log4j2 (Log4j2's own API, not an SLF4J binding).
Log4jKeyValuesConfigurator - Class in io.jstach.rainbowgum.log4j: Registers Log4j's ThreadContext as a LogEventFactory.KeyValuesContributor for LogEventFactory.KeyValuesContributor.Source.Standard.LOG4J2 so events from other logging APIs carry it as well.
Log4jKeyValuesConfigurator() - Constructor for class io.jstach.rainbowgum.log4j.Log4jKeyValuesConfigurator: For service loader.
LogAlerts - Interface in io.jstach.rainbowgum: Alerts (sometimes called errors or status events elsewhere) are for reporting problems with the logging system itself rather than application logging - for example an appender failing to write, or an async publisher's queue overflowing.
LogAlerts.FailLevel - Enum Class in io.jstach.rainbowgum: What building LogConfig and starting Rainbow Gum do with alerts recorded while starting, set by "logging.alerts.fail".
LogAlerts.Listener - Interface in io.jstach.rainbowgum: Notified of alerts as they happen.
LogAlerts.Stats - Record Class in io.jstach.rainbowgum: Stats about alerts recorded.
LogAlerts.UnobservedErrorsAction - Enum Class in io.jstach.rainbowgum: What LogLifecycle.start(LogConfig) does if, at that moment, at least one error alert has been recorded and still zero LogAlerts.Listeners are registered - the situation Logback's StatusManager calls an unobserved status: nothing is watching, so whatever went wrong during property loading or a RainbowGumServiceProvider.Configurator would otherwise only ever have reached the individual, easy to miss stderr lines each LogAlerts.alert(LogEvent) call already produces.
LogAlerts.UnusedKeyLevel - Enum Class in io.jstach.rainbowgum: The alert level for a property key that was set but not read while starting, set by "logging.alerts.unusedKey".
LogAppender - Interface in io.jstach.rainbowgum: Appenders are guaranteed to be written synchronously much like an actor in actor concurrency.
LogAppender.AppenderFlag - Enum Class in io.jstach.rainbowgum: Boolean like flags for appender that can be set with LogAppender.APPENDER_FLAGS_PROPERTY.
LogAppender.Appenders - Class in io.jstach.rainbowgum: Provides appenders safely to the publisher.
LogAppender.AppenderType - Enum Class in io.jstach.rainbowgum: The buffer/locking strategy an appender uses.
LogAppender.Builder - Class in io.jstach.rainbowgum: Builder for creating standard appenders.
LOGBACK_SCHEME - Static variable in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoder: Logback JSON encoder URI scheme.
LogbackJsonEncoder - Class in io.jstach.rainbowgum.json.encoder: A JSON encoder resembling Logback's own opinionated ch.qos.logback.classic.encoder.JsonEncoder.
Logback JSON Encoder - Section in Overview
LogbackJsonEncoderBuilder - Class in io.jstach.rainbowgum.json.encoder: Builder to create LogbackJsonEncoder.
LogbackJsonEncoderBuilder(String) - Constructor for class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderBuilder: Create a builder for io.jstach.rainbowgum.json.encoder.LogbackJsonEncoder .
LogbackJsonEncoderConfigurator - Class in io.jstach.rainbowgum.json.encoder: Adds a Logback style JSON encoder to encoder registry with "logback" URI scheme.
LogbackJsonEncoderConfigurator() - Constructor for class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderConfigurator: Default constructor for service loader.
LogBuilder<B,O> - Interface in io.jstach.rainbowgum: A marker interface for custom or generated builders.
LogConfig - Interface in io.jstach.rainbowgum: The configuration of a RainbowGum.
LogConfig.Builder - Class in io.jstach.rainbowgum: Builder for LogConfig.
LogConfig.ChangePublisher - Interface in io.jstach.rainbowgum: Config Change Publisher.
LogConfig.ChangePublisher.ChangeMode - Enum Class in io.jstach.rainbowgum: Whether runtime changes are on for a configuration, set with "logging.change.mode".
LogConfig.ChangePublisher.ChangeType - Enum Class in io.jstach.rainbowgum: Changing type options.
LogConfig.ConfigSupport - Interface in io.jstach.rainbowgum: Mixin for config support.
LogConfig.DebugModeType - Enum Class in io.jstach.rainbowgum: When to dump bootstrap alerts to the fail-safe output.
LogConfig.Globals - Class in io.jstach.rainbowgum: Settings that apply to the whole configuration rather than to one component.
LogConfig.Globals.AnsiMode - Enum Class in io.jstach.rainbowgum: Whether output uses ANSI escape codes, for color.
LogConfig.Globals.AppenderLock - Enum Class in io.jstach.rainbowgum: Which kind of lock appenders use.
LogConfig.Globals.ThreadLocalMode - Enum Class in io.jstach.rainbowgum: Whether the logging path may use a ThreadLocal.
LogConfig.LoggerRegistry - Interface in io.jstach.rainbowgum: Accounts for logger names, and which LoggerAPI vended them, registered via LogConfig.LoggerRegistry.registerLoggerName(LoggerAPI, String), deliberately without exposing the accumulated names/APIs themselves: the one supported way to see them is LogReporter.Section.LOGGERS/LogReporter.Section.FACADES.
LogConfigurable - Annotation Interface in io.jstach.rainbowgum.annotation: Used to generate Rainbow Gum config builder objects that once built will call the method annotated with the properties from the generated builder on build.
LogConfigurable.ConvertParameter - Annotation Interface in io.jstach.rainbowgum.annotation: Wall call a static method on the factory class (the class that contains the annotated LogConfigurable method) with the property value as a string to be converted.
LogConfigurable.DefaultDoc - Annotation Interface in io.jstach.rainbowgum.annotation: Documents the default value of a static field referenced by LogConfigurable.DefaultParameter.value() for when the field's value cannot be shown in the generated builder's javadoc.
LogConfigurable.DefaultParameter - Annotation Interface in io.jstach.rainbowgum.annotation: Use to set static defaults to parameters.
LogConfigurable.KeyParameter - Annotation Interface in io.jstach.rainbowgum.annotation: Use as parameter to property keys with parameters.
LogConfigurable.PassThroughParameter - Annotation Interface in io.jstach.rainbowgum.annotation: A parameter not to be configured with properties that will just pass through to the build method.
LogEncoder - Interface in io.jstach.rainbowgum: Encodes a LogEvent into a buffer of its choosing.
LogEncoder.AbstractEncoder<T> - Class in io.jstach.rainbowgum: Abstract encoder that will cast the buffer to the desired implementation.
LogEncoder.Buffer - Interface in io.jstach.rainbowgum: Encoders buffer.
LogEncoder.BufferHints - Interface in io.jstach.rainbowgum: Hints the output can pass to the encoder for creating buffers like max size and storage style of the buffer etc.
LogEncoder.Builder - Class in io.jstach.rainbowgum: Builds a LogEncoder out of a LogFormatter.
LogEncoder.EncoderProvider - Interface in io.jstach.rainbowgum: Finds output based on URI.
LogEncoderRegistry - Interface in io.jstach.rainbowgum: Encoder registry.
LogEvent - Interface in io.jstach.rainbowgum: A LogEvent is a container for a single call to a logger.
LogEvent.Caller - Interface in io.jstach.rainbowgum: Caller info usually derived from Stack walking.
LogEvent.Caller.CallerType - Enum Class in io.jstach.rainbowgum: Caller info strategies, resolved from "logging.caller.logger".
LogEventFactory - Interface in io.jstach.rainbowgum: A dynamic version of LogEvent's static "of" factory methods - same method shapes (level, message, ...), but LogEventFactory.timestamp(), LogEventFactory.threadName(), LogEventFactory.threadId() and LogEventFactory.loggerName() are resolved through overridable methods instead of being passed in on every call/pulled from Instant.now()/Thread.currentThread() inline the way those static methods do.
LogEventFactory.KeyValuesContributor - Interface in io.jstach.rainbowgum: A source of ambient key values (MDC like context) for events whose logging API has no context of its own, such as JUL or System.Logger.
LogEventFactory.KeyValuesContributor.Source - Interface in io.jstach.rainbowgum: Identifies a context store that contributes key values.
LogEventFactory.KeyValuesContributor.Source.Standard - Enum Class in io.jstach.rainbowgum: The context stores Rainbow Gum supports, in merge order: a later constant wins over an earlier one on a key collision.
LogEventLogger - Interface in io.jstach.rainbowgum: Logs events.
LOGFMT - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder.Format: logfmt: space separated key=value pairs, requestId=42 user="Ada Lovelace".
logfmt Formatter - Section in Overview
LogfmtFormatterBuilder - Class in io.jstach.rainbowgum.format: Builder to create LogFormatter.
LogfmtFormatterBuilder(String) - Constructor for class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: Create a builder for io.jstach.rainbowgum.LogFormatter .
LogFormatter - Interface in io.jstach.rainbowgum: Formats a log event using a StringBuilder.
LogFormatter.Builder - Class in io.jstach.rainbowgum: Log formatter builder that is composed of other formatters.
LogFormatter.EventFormatter - Interface in io.jstach.rainbowgum: Generic event formatting that is lambda friendly.
LogFormatter.KeyValueNullStrategy - Enum Class in io.jstach.rainbowgum: Controls how a null key value is written by key values formatters, see KeyValuesFormatterBuilder.nullStrategy(KeyValueNullStrategy).
LogFormatter.LevelFormatter - Interface in io.jstach.rainbowgum: Formats a System.Logger.Level.
LogFormatter.NoopFormatter - Enum Class in io.jstach.rainbowgum: A special formatter that will do nothing.
LogFormatter.StaticFormatter - Record Class in io.jstach.rainbowgum: A special formatter that will append static text.
LogFormatter.ThrowableFormatter - Interface in io.jstach.rainbowgum: Formats a throwable.
LogFormatter.ThrowableFormatter.Builder - Class in io.jstach.rainbowgum: Builds a configurable LogFormatter.ThrowableFormatter.
LogFormatter.TimestampFormatter - Interface in io.jstach.rainbowgum: Formats event timestamps.
logger - Variable in class io.jstach.rainbowgum.jfr.RainbowGumAlertEvent: The logger name, or null if unavailable.
logger - Variable in class io.jstach.rainbowgum.jfr.RainbowGumLogEvent: The logger name, or null if unavailable.
logger(LogFormatter) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets required logger.
logger(String) - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder: Logger name color.
LOGGER - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Logger keywords
LOGGER_NAMES - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.LOGGER_NAMES_METRIC.
LOGGER_NAMES_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the running count of distinct logger names registered via LogConfig.LoggerRegistry.registerLoggerName(LoggerAPI, String).
LoggerAPI - Interface in io.jstach.rainbowgum: Identifies which logging facade a logger name passed to LogConfig.LoggerRegistry.registerLoggerName(LoggerAPI, String) came through.
LoggerAPI.Standard - Enum Class in io.jstach.rainbowgum: The logging facades RainbowGum ships an implementation for.
LoggerDecoratorService - Class in io.jstach.rainbowgum.slf4j.spi: EXPERIMENTAL: this rainbowgum service provider allows wrapping slf4j loggers created from the logger factory.
LoggerDecoratorService() - Constructor for class io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService: No arg constructor for service loader.
LoggerDecoratorService.DepthAwareEventBuilder - Interface in io.jstach.rainbowgum.slf4j.spi: Because wrapping can change the depth of the logger in the callstack this interface allows implementations to change the depth of the event builder.
LoggerDecoratorService.DepthAwareLogger - Interface in io.jstach.rainbowgum.slf4j.spi: Because wrapping can change the depth of the logger in the callstack this interface allows loggers to recreate themselves with the proper depth if they support it.
loggerLevels(boolean) - Method in class io.jstach.rainbowgum.LogReporter.Options.Builder: Whether to resolve and print each logger's level, via LogConfig.levelResolver(), next to its name when LogReporter.Section.LOGGERS is included.
loggerName() - Method in interface io.jstach.rainbowgum.LogEvent: Name of logger.
loggerName() - Method in interface io.jstach.rainbowgum.LogEventFactory: Name of the logger every event created by this factory will have.
loggerName() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Adds the default logger name formatter.
loggerRegistry() - Method in interface io.jstach.rainbowgum.LogConfig: Accounts for every logger name a facade implementation has vended.
LOGGERS - Enum constant in enum class io.jstach.rainbowgum.LogReporter.Section: Logger names registered via LogConfig.LoggerRegistry.registerLoggerName(LoggerAPI, String), each with its resolved level, see LogReporter.Options.Builder.loggerLevels(boolean).
LOGGING_PATTERN_DISABLE_PROPERTY - Static variable in class io.jstach.rainbowgum.pattern.format.PatternConfigurator: Property that will disable this configurator from replacing the default encoder with the pattern encoder.
LogLifecycle - Interface in io.jstach.rainbowgum: A component that has a start and stop.
LogMessageFormatter - Interface in io.jstach.rainbowgum: Formats a LogEvent message.
LogMessageFormatter.StandardMessageFormatter - Enum Class in io.jstach.rainbowgum: Built-in message formatters.
LogMetrics - Interface in io.jstach.rainbowgum: Numeric metrics about the logging system itself.
LogMetrics.Gauge - Interface in io.jstach.rainbowgum: A retained handle for incrementing or decrementing a metric.
LogMetrics.Metric - Record Class in io.jstach.rainbowgum: A single named metric's current value, as returned by LogMetrics.snapshot().
LogMetrics.StandardMetric - Enum Class in io.jstach.rainbowgum: The fixed, well known set of metrics RainbowGum itself records, as opposed to the open ended, per logger name counters LogAlerts.alert(LogEvent) also drives into the counter matching the alert's level.
LogOutput - Interface in io.jstach.rainbowgum: A resource that can be written to usually in binary.
LogOutput.AbstractOutputStreamOutput - Class in io.jstach.rainbowgum: Abstract output on output stream.
LogOutput.ContentType - Interface in io.jstach.rainbowgum: The content type of the binary data passed to the output from an encoder.
LogOutput.ContentType.StandardContentType - Enum Class in io.jstach.rainbowgum: Builtin content types.
LogOutput.OutputProvider - Interface in io.jstach.rainbowgum: Finds output based on URI.
LogOutput.OutputType - Enum Class in io.jstach.rainbowgum: Output type useful for defaults and categorization.
LogOutput.ProvidesEncoder - Interface in io.jstach.rainbowgum: Marks an output that supplies its own LogEncoder instead of relying entirely on LogAppender.APPENDER_ENCODER_PROPERTY or LogEncoderRegistry.encoderForOutputType(OutputType).
LogOutput.ProvidesEncoder.Policy - Enum Class in io.jstach.rainbowgum: Whether a LogOutput.ProvidesEncoder's LogOutput.ProvidesEncoder.encoder(String, LogConfig) can be overridden by another, explicitly configured encoder.
LogOutput.ThreadSafeLogOutput - Interface in io.jstach.rainbowgum: Marker interface that the output is thread safe.
LogOutput.WriteMethod - Enum Class in io.jstach.rainbowgum: The preferred write style of an output.
LogOutputRegistry - Interface in io.jstach.rainbowgum: Register output providers by URI scheme.
LogProperties - Interface in io.jstach.rainbowgum: Provides String based properties like System.getProperty(String) for default configuration of logging levels and output.
LogProperties.AbstractBuilder<T> - Class in io.jstach.rainbowgum: Abstract log properties builder.
LogProperties.Builder - Class in io.jstach.rainbowgum: Builder for properties.
LogProperties.Listable - Interface in io.jstach.rainbowgum: Properties that can list the keys they hold, so that with LogConfig.DebugModeType.HELP (or LogConfig.DebugModeType.ALL) keys that were set but never read can be reported.
LogProperties.MutableLogProperties - Interface in io.jstach.rainbowgum: A log properties that can be mutated like a map.
LogProperties.MutableLogProperties.Builder - Class in io.jstach.rainbowgum: Mutable Log properties builder.
LogProperties.StandardProperties - Enum Class in io.jstach.rainbowgum: Common static log properties such as System properties ane environment variables.
LogProperty - Interface in io.jstach.rainbowgum: Describes a key (or several fallback keys) resolved against a LogProperties instance - start with LogProperties.forKey(String) - and also serves as the namespace for the shared property machinery: LogProperty.Result, LogProperty.Validator, and the property-specific exceptions.
LogProperty.PropertyConvertException - Exception Class in io.jstach.rainbowgum: Thrown if an error happens while converting a property.
LogProperty.PropertyFunction<T,R,E> - Interface in io.jstach.rainbowgum: An error friendly Function for converting properties.
LogProperty.PropertyMissingException - Exception Class in io.jstach.rainbowgum: Throw if property is missing.
LogProperty.PropertyProblem - Interface in io.jstach.rainbowgum: Parent interface for property exceptions.
LogProperty.PropertySupport - Interface in io.jstach.rainbowgum: Property helper mixin.
LogProperty.RequiredResult<T> - Interface in io.jstach.rainbowgum: A result that is not missing and will either be an error or success.
LogProperty.Result<T> - Interface in io.jstach.rainbowgum: The result of a property fetched from properties.
LogProperty.Result.Error<T> - Record Class in io.jstach.rainbowgum: A property that was present but failed conversion.
LogProperty.Result.Missing<T> - Record Class in io.jstach.rainbowgum: A property that is missing (null).
LogProperty.Result.Success<T> - Interface in io.jstach.rainbowgum: A property that is present.
LogProperty.ValidatedResult<T> - Interface in io.jstach.rainbowgum: A LogProperty.Result that is safe to pull a value out of - either because it can never actually be missing (LogProperty.RequiredResult: a LogProperty.Result.Success or an LogProperty.Result.Error, both already resolved one way or the other) or because a caller has explicitly acknowledged the possibility of a still-LogProperty.Result.Missing result by running it through LogProperty.Result.validate(Validator), LogProperty.Result.validateIfError(Validator), or LogProperty.Result.validateNow(Class).
LogProperty.ValidationException - Exception Class in io.jstach.rainbowgum: Thrown by LogProperty.Validator.validate() when one or more of the accumulated LogProperty.Results failed, reporting every failure in a single message instead of just the first one encountered.
LogProperty.Validator - Class in io.jstach.rainbowgum: Accumulates LogProperty.Results from one or more property lookups and validates them together, so that a caller resolving several properties in sequence can report every failure at once instead of failing fast on the first bad property.
LogProvider<T> - Interface in io.jstach.rainbowgum: A factory that may need config to provide.
LogProvider.ProvisionException - Exception Class in io.jstach.rainbowgum: Thrown if a provider fails and a description needs to be added.
LogProviderRef - Interface in io.jstach.rainbowgum: Log LogProvider Source.
LogProviderRef.NotFoundException - Exception Class in io.jstach.rainbowgum: Thrown if a provider could not be found for the ref.
LogPublisher - Interface in io.jstach.rainbowgum: Publishers push logs to appenders either synchronously or asynchronously.
LogPublisher.AbstractBuilder<T> - Class in io.jstach.rainbowgum: Abstract publisher builder.
LogPublisher.AsyncLogPublisher - Interface in io.jstach.rainbowgum: Async publisher.
LogPublisher.AsyncLogPublisher.Builder - Class in io.jstach.rainbowgum: Async publisher builder.
LogPublisher.PublisherFactory - Interface in io.jstach.rainbowgum: A factory for a publisher from config and appenders.
LogPublisher.PublisherProvider - Interface in io.jstach.rainbowgum: SPI for custom publishers.
LogPublisher.SyncLogPublisher - Interface in io.jstach.rainbowgum: Synchronous publisher.
LogPublisher.SyncLogPublisher.Builder - Class in io.jstach.rainbowgum: Synchronous publisher builder.
LogPublisherRegistry - Interface in io.jstach.rainbowgum: Registry of publishers.
LogReporter - Interface in io.jstach.rainbowgum: Renders a diagnostic report of a LogConfig and, once one is built from it, its RainbowGum.
LogReporter.Options - Class in io.jstach.rainbowgum: Which sections a report includes and how they are rendered.
LogReporter.Options.Builder - Class in io.jstach.rainbowgum: Builds LogReporter.Options.
LogReporter.Reportable - Interface in io.jstach.rainbowgum: Implemented by a component that wants to contribute its own description to a report instead of falling back to just its class name.
LogReporter.Section - Enum Class in io.jstach.rainbowgum: A section of the report that can be independently turned on or off.
LogRouter - Interface in io.jstach.rainbowgum: Routes messages to a publisher by providing a LogRouter.Route from a logger name and level.
LogRouter.AbstractRouter - Class in io.jstach.rainbowgum: A user supplied router usually for filtering or transforming purposes.
LogRouter.RootRouter - Interface in io.jstach.rainbowgum: Root router is a router that has child routers.
LogRouter.Route - Interface in io.jstach.rainbowgum: A route is similar to a SLF4J Logger or System Logger but has a much simpler contract.
LogRouter.Route.Routes - Enum Class in io.jstach.rainbowgum: Route singletons and utilities.
LogRouter.RouteFlag - Enum Class in io.jstach.rainbowgum: Router flags for adhoc router customization.
LogRouter.Router - Interface in io.jstach.rainbowgum: Router routes messages to a publisher.
LogRouter.Router.Builder - Class in io.jstach.rainbowgum: Router builder.
LogRouter.Router.RouterFactory - Interface in io.jstach.rainbowgum: Creates a router.
LOGSTASH_SCHEME - Static variable in class io.jstach.rainbowgum.json.encoder.LogstashEncoder: Logstash encoder URI scheme.
LogstashEncoder - Class in io.jstach.rainbowgum.json.encoder: A JSON encoder in the format produced by logstash-logback-encoder's LogstashEncoder.
LogstashEncoderBuilder - Class in io.jstach.rainbowgum.json.encoder: Builder to create LogstashEncoder.
LogstashEncoderBuilder(String) - Constructor for class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder: Create a builder for io.jstach.rainbowgum.json.encoder.LogstashEncoder .
LogstashEncoderConfigurator - Class in io.jstach.rainbowgum.json.encoder: Adds a logstash-logback-encoder style JSON Encoder to encoder registry with "logstash" URI scheme.
LogstashEncoderConfigurator() - Constructor for class io.jstach.rainbowgum.json.encoder.LogstashEncoderConfigurator: Default constructor for service loader.
Logstash JSON Encoder - Section in Overview

M

MAGENTA - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI magenta color
makeLoggingEventBuilder(Level) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
makeLoggingEventBuilder(Level) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
MANDATORY - Enum constant in enum class io.jstach.rainbowgum.LogOutput.ProvidesEncoder.Policy: The output's own encoder is the only one allowed.
map(LogProperty.PropertyFunction) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error
map(LogProperty.PropertyFunction) - Method in interface io.jstach.rainbowgum.LogProperty.Result: Maps this result's value through mapper.
map(LogProperty.PropertyFunction) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing
MAP_KEYS_SUFFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Suffix of the property listing a map's keys, see LogProperties.mapOrNull(String).
mapOrNull(String) - Method in interface io.jstach.rainbowgum.LogProperties: Gets a map or null if the key is missing and by default uses LogProperties.parseMap(String).
mapOrNull(String) - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
mapValue(LogProperty.Result.Success, U) - Static method in interface io.jstach.rainbowgum.LogProperty: Rewraps a value that was already derived from success's value, keeping the PropertySuccess's origin (topProperties/properties/key/rawValue/kind) intact - useful for a conversion step that cannot itself throw, so LogProperty.Result.map(PropertyFunction) would be overkill, but that still needs to keep the result's origin intact for a later conversion step's error message.
Maven - Section in Overview
max() - Method in record class io.jstach.rainbowgum.pattern.Padding: Returns the value of the max record component.
maxAlerts(int) - Method in class io.jstach.rainbowgum.LogReporter.Options.Builder: Maximum number of most recent alerts to print when LogReporter.Section.ALERTS is included.
maxBatchSize(Integer) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets maxBatchSize.
maxBufferSize(int) - Method in class io.jstach.rainbowgum.LogEncoder.Builder: Configures a maximum buffer size - see LogEncoder.Buffer.isOversized().
maxBufferSize(Integer) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets maxBufferSize.
maxBufferSize(Integer) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Sets maxBufferSize.
maxBufferSize(Integer) - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderBuilder: Sets maxBufferSize.
maxBufferSize(Integer) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder: Sets maxBufferSize.
maxBufferSize(Integer) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: Sets maxBufferSize.
maxFileSize(DataSize) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets required maxFileSize.
maxHistory(Integer) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets required maxHistory.
maximumSize() - Method in interface io.jstach.rainbowgum.LogEncoder.BufferHints: Maximum size of the buffer.
maxLines(int) - Method in class io.jstach.rainbowgum.LogFormatter.ThrowableFormatter.Builder: Maximum number of stack frame ("at ...") lines printed per throwable in the chain.
MDC - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: MDC keywords
MEMORY - Enum constant in enum class io.jstach.rainbowgum.LogOutput.OutputType: Output targets in memory.
merge(KeyValues, KeyValues) - Static method in interface io.jstach.rainbowgum.KeyValues: Creates a key values whose entries are the union of two key values, high taking precedence over low on a key collision.
MERGED - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesPlacement: Alongside the event's own fields, the way logfmt and most log aggregators expect them.
message - Variable in class io.jstach.rainbowgum.jfr.RainbowGumAlertEvent: The already-formatted alert message, or null if there was none.
message - Variable in class io.jstach.rainbowgum.jfr.RainbowGumLogEvent: The already-formatted log message, or null if there was none.
message() - Method in interface io.jstach.rainbowgum.LogEvent: Unformatted message.
message() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Formats the message by calling LogEvent.formattedMessage(StringBuilder).
message() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error: Returns the value of the message record component.
message() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing: Returns the value of the message record component.
message() - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: The message set on this builder so far, if any.
message(LoggingEventBuilder) - Static method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: The message set on the builder so far, if possible.
MESSAGE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Message keywords
messageFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: mutable field
messageFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: immutable field
messageFormatter() - Method in interface io.jstach.rainbowgum.LogEventFactory: Formatter to use for rendering a message when LogEvent.formattedMessage(StringBuilder) is called on events created by this factory that take arguments.
messageOrNull() - Method in interface io.jstach.rainbowgum.LogEvent: Unformatted message or null if no message was passed into the event.
METHOD - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Line no
methodName() - Method in interface io.jstach.rainbowgum.LogEvent.Caller: See StackWalker.StackFrame.getMethodName().
Metric(String, System.Logger.Level, long) - Constructor for record class io.jstach.rainbowgum.LogMetrics.Metric: Creates an instance of a Metric record class.
metricName() - Method in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: The metric name, as passed to a counter method or LogMetrics.gauge(String, Level) and matched against LogMetrics.Metric.name().
metrics() - Method in interface io.jstach.rainbowgum.LogConfig: Metrics about the logging system itself (as opposed to application logging routed through the LogRouter).
Metrics - Section in Overview
METRICS - Enum constant in enum class io.jstach.rainbowgum.LogReporter.Section: Metrics from LogConfig.metrics().
Micronaut - Section in Overview
MICROS - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Micros keywords
MIDDLE - Enum constant in enum class io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Pass: Second or greater pass but not the last pass.
min() - Method in record class io.jstach.rainbowgum.pattern.Padding: Returns the value of the min record component.
Missing(LogProperties, List, String) - Constructor for record class io.jstach.rainbowgum.LogProperty.Result.Missing: A property that is missing (null).
Misspelled and unused property keys - Section in Overview
mode() - Method in class io.jstach.rainbowgum.jfr.JfrAlertListener: Whether this listener should be registered with LogAlerts.addListener(LogAlerts.Listener).
mode(JfrAlertListener.Mode) - Method in class io.jstach.rainbowgum.jfr.JfrAlertListenerBuilder: Sets mode.

N

name() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable: Name of builder.
name() - Method in interface io.jstach.rainbowgum.format.TTLL.ColorTheme: The theme's name, which is its property value.
name() - Method in class io.jstach.rainbowgum.LogAppender.Builder: Name of the appender.
name() - Method in record class io.jstach.rainbowgum.LogMetrics.Metric: Returns the value of the name record component.
name() - Method in class io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService: The name of the decorator and should be unique to avoid collisions.
NAME - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ThreadFormat: Thread name.
NAME - Static variable in interface io.jstach.rainbowgum.LogProperties: A common key parameter is called name.
nameFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: mutable field
nameFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: immutable field
nameFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Sets the logger name formatter.
NESTED - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesPlacement: In a nested object, written even when there are no key values so every event has the same shape.
NETWORK - Enum constant in enum class io.jstach.rainbowgum.LogOutput.OutputType: Output targets something over a network.
newline() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends a newline using the platforms line separator.
NO_EXCEPTION - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: No exception keywords.
NONE - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesPlacement: Key values are left out.
NONE - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: Key values and their braces are left out.
NONE - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: No level.
NONE - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LoggerFormat: No logger name.
NONE - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ThreadFormat: No thread.
NONE - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.TimestampFormat: No time.
NONE - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.UnobservedErrorsAction: Do nothing beyond the immediate reporting of warning and error events.
NONE - Enum constant in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeType: No changes are allowed.
NONE - Enum constant in enum class io.jstach.rainbowgum.LogEvent.Caller.CallerType: Caller info is not computed.
noop() - Static method in interface io.jstach.rainbowgum.LogFormatter: A special formatter that will do nothing.
noop() - Static method in interface io.jstach.rainbowgum.LogMetrics.Gauge: Returns a shared gauge that ignores all updates.
normalizeLevel(System.Logger.Level) - Static method in interface io.jstach.rainbowgum.LevelResolver: Will convert ALL to TRACE.
NotFound - Enum constant in enum class io.jstach.rainbowgum.LogRouter.Route.Routes: A route that is a NOOP and is always disabled.
nullStrategy(LogFormatter.KeyValueNullStrategy) - Method in class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder: Controls null values, and missing keys when a selection is supplied: LogFormatter.KeyValueNullStrategy.KEEP writes null (logfmt: key=, percent encoding: the key alone), LogFormatter.KeyValueNullStrategy.EMPTY writes an empty string, and LogFormatter.KeyValueNullStrategy.SKIP omits the key.

O

OBJECT_END - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing JSON object end: }
OBJECT_START - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing JSON object start: {
of() - Static method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Empty mutable keys with default pre-allocation.
of() - Static method in interface io.jstach.rainbowgum.KeyValues: An immutable empty KeyValues.
of() - Static method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter: Default implementation calls LogFormatter.LevelFormatter.toString(Level)
of() - Static method in interface io.jstach.rainbowgum.LogFormatter.ThrowableFormatter: Default implementation uses Throwable.printStackTrace(PrintWriter).
of() - Static method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: Formats timestamp using LogFormatter.TimestampFormatter.TTLL_TIME_FORMAT.
of() - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Provides the default publisher factory.
of() - Static method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Default config.
of() - Static method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry: Creates a pattern registry with the defaults.
of() - Static method in interface io.jstach.rainbowgum.RainbowGum: Gets the currently statically bound RainbowGum and will try to load and find one if there is none currently bound.
of() - Static method in interface io.jstach.rainbowgum.ServiceRegistry: Creates an empty service registry.
of(int) - Static method in class io.jstach.rainbowgum.disruptor.DisruptorLogPublisher: Creates a factory of disruptor log publishers.
of(int) - Static method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Creates mutable keys with pre-allocation.
of(int, int) - Static method in record class io.jstach.rainbowgum.pattern.Padding: Create padding info.
of(LogAppender, int) - Static method in class io.jstach.rainbowgum.publisher.BlockingQueueAsyncLogPublisher: Creates the publisher with its own standalone LogConfig (not one shared with the rest of the application) for its LogAlerts - mainly useful standalone/in tests.
of(LogAppender, int, LogAlerts) - Static method in class io.jstach.rainbowgum.publisher.BlockingQueueAsyncLogPublisher: Creates the publisher.
of(LogAppender, int, LogAlerts, Duration) - Static method in class io.jstach.rainbowgum.publisher.BlockingQueueAsyncLogPublisher: Creates the publisher.
of(LogFormatter) - Static method in interface io.jstach.rainbowgum.LogEncoder: Creates an encoder from a formatter that encodes with StandardCharsets.UTF_8.
of(LogFormatter) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory.KeywordFactory: Creates a keyword factory from a formatter that only cares about padding info.
of(LogFormatter.EventFormatter) - Static method in interface io.jstach.rainbowgum.LogFormatter: Create a formatter using event formatter that is a lambda so that LogFormater.of((o, e) -> ...); works.
of(LogFormatter, boolean) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory.KeywordFactory: Creates a keyword factory from a formatter that only cares about padding info, additionally marking it as PatternFormatterFactory.isExceptionFormatter().
of(LogProperties, String) - Static method in interface io.jstach.rainbowgum.LogProperty: Creates a LogProperty for a single key.
of(LogProperties, String, String) - Static method in interface io.jstach.rainbowgum.LogProperty: Creates a LogProperty for a single key with a {name} parameter interpolated.
of(LogProperty.Result.Success) - Static method in interface io.jstach.rainbowgum.LogProviderRef: Create a provider ref from a property result.
of(LogProvider) - Static method in interface io.jstach.rainbowgum.LogEncoder.EncoderProvider: Convenience method to register encoders that require no configuration.
of(LogProviderRef) - Static method in interface io.jstach.rainbowgum.file.FileOutput: Create output from provider ref.
of(LogProviderRef) - Static method in interface io.jstach.rainbowgum.LogEncoder: Provides a lazy loaded encoder from a provider ref.
of(LogProviderRef) - Static method in interface io.jstach.rainbowgum.LogOutput: Provides a lazy loaded output from a URI.
of(LogProviderRef) - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Provides a lazy loaded publisher from a URI.
of(LogProviderRef) - Static method in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Creates a rolling file output provider from a URI reference - the entry point used by the "rolling" scheme registration.
of(LogReporter.Section) - Static method in class io.jstach.rainbowgum.LogReporter.Options: Options for a report of only the given section with otherwise default settings.
of(ServiceRegistry) - Static method in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues: Finds the default key values in a service registry, creating them if needed.
of(ServiceRegistry, LogEventFactory.KeyValuesContributor.Source...) - Static method in interface io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor: Combines the contributors currently registered in a service registry, skipping the excluded sources and those disabled with "logging.keyvalues.disabled".
of(Class) - Static method in class io.jstach.rainbowgum.LogProperty.Validator: Creates a validator whose LogProperty.ValidationException messages will be prefixed with the name of the given class.
of(Class, RuntimeException) - Static method in exception class io.jstach.rainbowgum.LogProperty.ValidationException: Wraps cause in a LogProperty.ValidationException, using the same "Validation failed for <class>:" message prefix LogProperty.ValidationException.validate(Class, List) itself uses.
of(StackWalker.StackFrame) - Static method in interface io.jstach.rainbowgum.LogEvent.Caller: Creates caller info from a stack frame.
of(String) - Static method in interface io.jstach.rainbowgum.LogEventFactory: Creates a factory bound to the given logger name, otherwise using default behavior for LogEventFactory.timestamp(), LogEventFactory.threadName(), LogEventFactory.threadId() and LogEventFactory.messageFormatter().
of(String) - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Provides a publisher factory by URI.
of(String) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry.PatternKey: Creates a pattern key of one key name.
of(String, LogRouter) - Static method in class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLogger: Provides a system logger that will use the given root router.
of(String, String...) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry.PatternKey: Creates a pattern key of one key and aliases.
of(String, URI, String, Boolean, Boolean, DataSize) - Static method in interface io.jstach.rainbowgum.file.FileOutput: Creates a file output provider.
of(String, URI, String, Boolean, Boolean, DataSize, DataSize, Integer, DataSize, Boolean, String) - Static method in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Creates a rolling file output provider.
of(String, Charset) - Static method in interface io.jstach.rainbowgum.LogOutput.ContentType: Finds the matching LogOutput.ContentType.StandardContentType for the given content type and charset if one exists, otherwise creates a new plain LogOutput.ContentType.
of(URI) - Static method in interface io.jstach.rainbowgum.LogEncoder: Provides a lazy loaded encoder from a URI.
of(URI) - Static method in interface io.jstach.rainbowgum.LogProviderRef: Creates a log provider ref from URI.
of(URI) - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Provides a publisher factory by URI.
of(URI, String) - Static method in interface io.jstach.rainbowgum.LogProviderRef: Creates a log provider ref from URI.
of(URI, String, LogProperties) - Static method in interface io.jstach.rainbowgum.LogProperties: Creates log properties from a URI query and provided properties.
of(URI, String, LogProperties, String) - Static method in interface io.jstach.rainbowgum.LogProperties: Creates log properties from a URI query and provided properties.
of(DateTimeFormatter) - Static method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: Formats a timestamp using standard JDK date time formatter.
of(DateTimeFormatter, boolean) - Static method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: Formats a timestamp using standard JDK date time formatter.
of(Instant, String, long, System.Logger.Level, String, String, KeyValues, Throwable) - Static method in interface io.jstach.rainbowgum.LogEvent: Creates a log event.
of(Collection) - Static method in interface io.jstach.rainbowgum.LevelResolver.LevelConfig: Creates a level config from a list of level configs.
of(Collection, ThreadFactory, int, LogAlerts) - Static method in class io.jstach.rainbowgum.disruptor.DisruptorLogPublisher: Creates.
of(Consumer) - Static method in interface io.jstach.rainbowgum.file.FileOutput: Creates a file output provider from lambda builder and uses the config properties from the returned log provider.
of(Consumer) - Static method in class io.jstach.rainbowgum.json.encoder.EcsEncoder: Creates an ECS encoder using a lambda for easier registration.
of(Consumer) - Static method in class io.jstach.rainbowgum.json.encoder.GelfEncoder: Creates a GELF encoder using a lambda for easier registration.
of(Consumer) - Static method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoder: Creates a Logback JSON encoder using a lambda for easier registration.
of(Consumer) - Static method in class io.jstach.rainbowgum.json.encoder.LogstashEncoder: Creates a Logstash encoder using a lambda for easier registration.
of(Consumer) - Static method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoder: Creates the encoder with a builder lambda; properties are applied after the lambda.
of(Consumer) - Static method in class io.jstach.rainbowgum.otlp.OtlpOutput: Creates the output with a builder lambda; properties are applied after the lambda.
of(Consumer) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternCompiler: Creates a pattern compiler provider from a builder lambda.
of(Consumer) - Static method in class io.jstach.rainbowgum.pattern.format.PatternEncoder: Creates a pattern encoder with name of the parent component and will use the properties from the provided config.
of(Consumer) - Static method in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Creates a rolling file output provider from a lambda builder and uses the config properties from the returned log provider - mirrors FileOutput.of(Consumer).
of(Function) - Static method in interface io.jstach.rainbowgum.LogRouter.Router.RouterFactory: Creates a router from a function.
of(List) - Static method in interface io.jstach.rainbowgum.LogProperties: Creates log properties from many log properties.
of(List, LogProperties) - Static method in interface io.jstach.rainbowgum.LogProperties: Creates log properties from many log properties.
of(Map) - Static method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Copies a map into KeyValues.MutableKeyValues.
of(Map) - Static method in interface io.jstach.rainbowgum.KeyValues: Creates an immutable key values by copying a Map.
of(U) - Static method in interface io.jstach.rainbowgum.LogProvider: Creates a provider of instance that is already configured.
ofAll(Instant, String, long, System.Logger.Level, String, String, KeyValues, Throwable, LogMessageFormatter, Object[]) - Static method in interface io.jstach.rainbowgum.LogEvent: Creates a log event with everything specified.
ofAll(Instant, String, long, System.Logger.Level, String, String, KeyValues, Throwable, LogMessageFormatter, List) - Static method in interface io.jstach.rainbowgum.LogEvent: Creates a log event with everything specified.
ofAsync(Integer) - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Provides the default async publisher.
ofBoolean() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a boolean.
ofBytes(long) - Static method in class io.jstach.rainbowgum.file.DataSize: Creates a data size from a number of bytes.
ofDepthOrNull(int) - Static method in interface io.jstach.rainbowgum.LogEvent.Caller: Returns caller from a certain depth or null
off() - Static method in interface io.jstach.rainbowgum.LevelResolver: A level resolver that is off.
OFF - Enum constant in enum class io.jstach.rainbowgum.format.Json5PrettyPrint: No added whitespace: level:"INFO",logger:....
OFF - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.ColorMode: No color.
OFF - Enum constant in enum class io.jstach.rainbowgum.jfr.JfrAlertListener.Mode: Alerts are not committed as JFR events (the default).
OFF - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.FailLevel: Default.
OFF - Enum constant in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeMode: Loggers never change after they are created.
OFF - Enum constant in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Do not dump alerts beyond the normal alert startup policy.
OFF - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.AnsiMode: ANSI is never used, and extensions for ANSI such as JANSI are not installed.
OFF - Enum constant in enum class io.jstach.rainbowgum.otlp.EnvironmentVariables: Environment variables are ignored (the default).
OFF - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternConfig.CacheType: No caching - every call recomputes.
OFF - Enum constant in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.LevelFileType: No level file.
OFF - Enum constant in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.StrictType: Disables prefix validation.
ofGigabytes(long) - Static method in class io.jstach.rainbowgum.file.DataSize: Creates a data size from a number of gigabytes (1024 * 1024 * 1024 bytes each).
ofInt() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as an int.
ofISO() - Static method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: Formats a timestamp using ISO format at fixed millisecond precision (e.g.
ofKilobytes(long) - Static method in class io.jstach.rainbowgum.file.DataSize: Creates a data size from a number of kilobytes (1024 bytes each).
ofList() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a list, using LogProperties.listOrNull(String).
ofLong() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a long.
ofMap() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a map, using LogProperties.mapOrNull(String).
ofMegabytes(long) - Static method in class io.jstach.rainbowgum.file.DataSize: Creates a data size from a number of megabytes (1024 * 1024 bytes each).
ofMicros() - Static method in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: Micro seconds over the events last second.
ofOneArg(Instant, String, long, System.Logger.Level, String, String, KeyValues, LogMessageFormatter, Object) - Static method in interface io.jstach.rainbowgum.LogEvent: Creates a log event.
ofProvider(LogProperty.PropertyFunction) - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a LogProviderRef and then maps it to a LogProvider.
ofProviderRef() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a LogProviderRef for component provision.
ofRightPadded() - Static method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter: Default implementation calls LogFormatter.LevelFormatter.rightPadded(Level)
ofStandardErr() - Static method in interface io.jstach.rainbowgum.LogOutput: Standard err output.
ofStandardOut() - Static method in interface io.jstach.rainbowgum.LogOutput: Standard out output.
ofString() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a raw string.
ofSync() - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Provides the default registered sync publisher.
ofTTLL() - Static method in interface io.jstach.rainbowgum.LogEncoder: Provides the standard TTLL encoder.
ofTwoArgs(Instant, String, long, System.Logger.Level, String, String, KeyValues, LogMessageFormatter, Object, Object) - Static method in interface io.jstach.rainbowgum.LogEvent: Creates a log event.
ofUniversal() - Static method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Platform independent formatter config that will not change across timezones or platforms.
ofURI() - Method in interface io.jstach.rainbowgum.LogProperty: Resolves the property as a URI.
OMIT - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesWhenEmpty: Left out.
ON - Enum constant in enum class io.jstach.rainbowgum.jfr.JfrAlertListener.Mode: Every alert is committed as a JFR event.
ON - Enum constant in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeMode: Loggers allowed by "logging.change.logger" change when changes are published.
ON - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.AnsiMode: ANSI is always used.
ON - Enum constant in enum class io.jstach.rainbowgum.otlp.EnvironmentVariables: Environment variables are read for any value not set by a property.
onAlert(LogEvent) - Method in class io.jstach.rainbowgum.jfr.JfrAlertListener
onAlert(LogEvent) - Method in interface io.jstach.rainbowgum.LogAlerts.Listener: Called synchronously every time an alert is recorded.
onChange(Consumer) - Method in interface io.jstach.rainbowgum.LogRouter.RootRouter: Register for a router changes usually involving the level resolver being updated by config.
onClose(AutoCloseable) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Add a closeable to close on close in LIFO order.
ONE_DARK - Static variable in interface io.jstach.rainbowgum.format.TTLL.ColorTheme: Atom One Dark's colors in 24 bit color, so they show the same in any terminal that supports it: cyan time, gray thread and key values, magenta logger name, and level bold red, yellow, or blue (error, warn, info) with debug and trace gray.
onGlobalChange(Consumer) - Static method in interface io.jstach.rainbowgum.RainbowGum: Subscribes to notification of a new RainbowGum becoming the globally bound one (see RainbowGum.set(Supplier), RainbowGum.set(RainbowGum), RainbowGum.Builder.set()).
OpenTelemetry - Section in Overview
OPENTELEMETRY - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: rainbowgum-opentelemetry: the trace and span id of the current OpenTelemetry span.
OpenTelemetryConfigurator - Class in io.jstach.rainbowgum.opentelemetry: Registers the current OpenTelemetry span's ids as the LogEventFactory.KeyValuesContributor.Source.Standard.OPENTELEMETRY key values source.
OpenTelemetryConfigurator() - Constructor for class io.jstach.rainbowgum.opentelemetry.OpenTelemetryConfigurator: For service loader.
opt(int, String) - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword: Helper to get values from PatternKeyword.optionList()
opt(int, T, Function) - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword: Helper to get values from PatternKeyword.optionList().
optimize() - Method in class io.jstach.rainbowgum.LogConfig.Globals: Whether unset appender and encoder choices use what is best for the platform, from "logging.global.optimize".
optimize(boolean) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets whether unset appender and encoder choices use what is best for the platform, used when the property "logging.global.optimize" is absent.
Opting Every Appender/Encoder Into Platform-Specific Defaults At Once - Section in Overview
optional() - Method in interface io.jstach.rainbowgum.LogProperty.ValidatedResult: Convenience that turns a value into an optional.
optional() - Method in class io.jstach.rainbowgum.RainbowGum.Builder: For returning an optional for the LogProvider contract.
optional(Function) - Method in class io.jstach.rainbowgum.RainbowGum.Builder: For returning an optional for the LogProvider contract.
optionList() - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword: Parameters passed in { ...
optOrNull(int) - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword: Helper to get values from PatternKeyword.optionList().
optOrNull(int, Function) - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword: Helper to get values from PatternKeyword.optionList().
or(T) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error
or(T) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing
or(T) - Method in interface io.jstach.rainbowgum.LogProperty.Result: Returns the current result if fallback is null or returns fallback as a result if this result is missing.
or(T) - Method in interface io.jstach.rainbowgum.LogProperty.Result.Success
or(String) - Method in interface io.jstach.rainbowgum.LogProperty: Adds a fallback key to try (without {name} interpolation) if none of the keys tried so far are found.
or(String, String) - Method in interface io.jstach.rainbowgum.LogProperty: Adds a fallback key to try (with {name} interpolated to nameParam) if none of the keys tried so far are found.
or(Supplier) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error
or(Supplier) - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing
or(Supplier) - Method in interface io.jstach.rainbowgum.LogProperty.Result: Returns the current result if success or error otherwise fallback supplier is used.
or(Supplier) - Method in interface io.jstach.rainbowgum.LogProperty.Result.Success
order - Variable in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: order
order() - Method in interface io.jstach.rainbowgum.LogProperties: When log properties are coalesced this method is used to resolve order.
order() - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
order() - Method in class io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService: Lowest integer value will decorate first which means the highest order found actually has the strongest influence on filtering since its returned logger is the one used.
order(int) - Method in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: When log properties are coalesced this method is used to resolve order.
OTLP_SCHEME - Static variable in class io.jstach.rainbowgum.otlp.OtlpJsonEncoder: Encoder URI scheme.
OTLP_SCHEME - Static variable in class io.jstach.rainbowgum.otlp.OtlpOutput: Output URI scheme.
OTLP/HTTP Output - Section in Overview
OTLP/JSON Encoder - Section in Overview
OtlpConfigurator - Class in io.jstach.rainbowgum.otlp: Registers the "otlp" encoder scheme (OtlpJsonEncoder) and output scheme (OtlpOutput).
OtlpConfigurator() - Constructor for class io.jstach.rainbowgum.otlp.OtlpConfigurator: For service loader.
OtlpJsonEncoder - Class in io.jstach.rainbowgum.otlp: Encodes each event as one line of OTLP/JSON: a complete LogsData object holding a single log record.
OtlpJsonEncoderBuilder - Class in io.jstach.rainbowgum.otlp: Builder to create OtlpJsonEncoder.
OtlpJsonEncoderBuilder(String) - Constructor for class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Create a builder for io.jstach.rainbowgum.otlp.OtlpJsonEncoder .
OtlpOutput - Class in io.jstach.rainbowgum.otlp: Sends log events to an OTLP/HTTP endpoint (/v1/logs) as protobuf (the default) or JSON, without the OpenTelemetry SDK or a protobuf library.
OtlpOutputBuilder - Class in io.jstach.rainbowgum.otlp: Builder to create LogProvider<OtlpOutput>.
OtlpOutputBuilder(String) - Constructor for class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Create a builder for io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.otlp.OtlpOutput> .
OtlpProtocol - Enum Class in io.jstach.rainbowgum.otlp: OTLP/HTTP payload encoding, named as in OTEL_EXPORTER_OTLP_PROTOCOL.
output(LogOutput) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets output.
output(LogProvider) - Method in class io.jstach.rainbowgum.LogAppender.Builder: Sets output.
output(String) - Method in interface io.jstach.rainbowgum.LogOutputRegistry: Finds an output by name.
OUTPUT_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Prefix of the properties configuring an appender's output, followed by the output's URI scheme, for example logging.appender.
outputRegistry() - Method in interface io.jstach.rainbowgum.LogConfig: Output provider that uses URI to find output.
Outputs - Section in Overview
outputStream - Variable in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput: output stream to write to.
overflow(BatchSwapAsyncLogPublisher.Overflow) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Sets required overflow.
OVERRIDE_PROPERTIES_NAME - Static variable in interface io.jstach.rainbowgum.LevelResolver: Name of a LogProperties in the ServiceRegistry whose level keys ("logging.level") win over the level keys of every other source, including a level set on a group: a group level in these properties wins over a logger's own level from another source.

P

packagingData(boolean) - Method in class io.jstach.rainbowgum.LogFormatter.ThrowableFormatter.Builder: Whether to append packaging data (the jar or module a frame's class was loaded from, and its version) after each frame line, e.g.
PADDED - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: Upper case, right padded to five characters so messages line up.
padding() - Method in interface io.jstach.rainbowgum.pattern.PatternKeyword: Padding information
Padding - Record Class in io.jstach.rainbowgum.pattern: FormattingInfo instances contain the information obtained when parsing formatting modifiers in conversion modifiers.
Padding(int, int, boolean, boolean) - Constructor for record class io.jstach.rainbowgum.pattern.Padding: Creates an instance of a Padding record class.
padLeft(StringBuilder, CharSequence, int) - Static method in interface io.jstach.rainbowgum.LogFormatter: Pads the left hand side of text with space.
padRight(StringBuilder, CharSequence, int) - Static method in interface io.jstach.rainbowgum.LogFormatter: Pads the right hand side of text with space.
PARAMETER_PATTERN - Static variable in interface io.jstach.rainbowgum.LogProperties: Property prefix parameter pattern.
parse(String) - Static method in class io.jstach.rainbowgum.file.DataSize: Parses a data size such as 10MB, 512 kb, 1.5g, or 1048576.
parse(String) - Static method in enum class io.jstach.rainbowgum.jfr.JfrAlertListener.Mode: Parses a property value: on/true or off/false, case insensitive.
parse(String) - Static method in enum class io.jstach.rainbowgum.otlp.EnvironmentVariables: Parses a property value: on/true or off/false, case insensitive.
parse(String) - Static method in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: Parses http/protobuf or http/json, case insensitive.
parse(String) - Static method in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: Parses an init option from a property value.
parseDataSize(String) - Static method in interface io.jstach.rainbowgum.file.FileOutput: Converts a bufferSize property value.
parseDataSize(String) - Static method in interface io.jstach.rainbowgum.rolling.RollingFileOutput: Converts a maxFileSize or totalSizeCap property value.
parseLevel(String) - Static method in interface io.jstach.rainbowgum.LevelResolver: Parses a Level from a string.
parseList(String) - Static method in interface io.jstach.rainbowgum.LogProperties: Parses a list of strings from a string that is percent encoded for escaping (application/x-www-form-urlencoded) where the separator can be either "&" or ",".
parseMap(String) - Static method in interface io.jstach.rainbowgum.LogProperties: Parses a URI query formatted string to a Map.
parseMultiMap(String) - Static method in interface io.jstach.rainbowgum.LogProperties: Parses a URI query for a multiple value map.
parseUriQuery(String, BiConsumer) - Static method in interface io.jstach.rainbowgum.LogProperties: Parse a URI query in application/x-www-form-urlencoded format useful for parsing properties values that have key values embedded in them.
PASSES - Static variable in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider: The default amount of passes made to resolve registrators or configurators.
pattern(String) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: Sets required pattern.
PATTERN_CONFIG_PREFIX - Static variable in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Formatter properties prefix
PATTERN_PROPERY_PREFIX - Static variable in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Key Values that can be retrieved by various patterns.
PATTERN_SCHEME - Static variable in class io.jstach.rainbowgum.pattern.format.PatternEncoder: Pattern encoder URI provider scheme.
patternCompiler(PatternCompiler) - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: Sets patternCompiler.
PatternCompiler - Interface in io.jstach.rainbowgum.pattern.format: Compiles a pattern into a formatter.
PatternCompiler.Builder - Class in io.jstach.rainbowgum.pattern.format: Builder for PatternCompiler.
patternConfig(PatternConfig) - Method in class io.jstach.rainbowgum.pattern.format.PatternCompiler.Builder: Formatting config that has platform config like time zone etc.
PatternConfig - Interface in io.jstach.rainbowgum.pattern.format: Pattern Config needed for pattern keywords that is generally platform specific.
PatternConfig.CacheType - Enum Class in io.jstach.rainbowgum.pattern.format: Whether a keyword's own internal caching (currently just %logger{N}'s abbreviator) is used.
PatternConfigBuilder - Class in io.jstach.rainbowgum.pattern.format: Builder to create PatternConfig.
PatternConfigBuilder(String) - Constructor for class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Create a builder for io.jstach.rainbowgum.pattern.format.PatternConfig .
PatternConfigurator - Class in io.jstach.rainbowgum.pattern.format: Configures Logback style pattern encoders and offers provision with the URI scheme "pattern".
PatternConfigurator() - Constructor for class io.jstach.rainbowgum.pattern.format.PatternConfigurator: For service loader to call.
PatternEncoder - Class in io.jstach.rainbowgum.pattern.format: Factory for pattern encoders.
PatternEncoderBuilder - Class in io.jstach.rainbowgum.pattern.format: Builder to create LogProvider<LogEncoder>.
PatternEncoderBuilder(String) - Constructor for class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: Create a builder for io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.LogEncoder> .
Pattern Formatter - Section in Overview
PatternFormatterFactory - Interface in io.jstach.rainbowgum.pattern.format: Creates formatters from pattern keywords and are registered to a PatternRegistry.
PatternFormatterFactory.CompositeFactory - Interface in io.jstach.rainbowgum.pattern.format: A composite formatter factory expects possible children.
PatternFormatterFactory.KeywordFactory - Interface in io.jstach.rainbowgum.pattern.format: A keyword formatter factory expects keywords and option list.
PatternKeyword - Interface in io.jstach.rainbowgum.pattern: A pattern keyword instance is the content of percent encoded keywords in a pattern.
PatternKeywordProvider - Class in io.jstach.rainbowgum.pattern.format.spi: Extend for a service provider that will register custom keywords.
PatternKeywordProvider() - Constructor for class io.jstach.rainbowgum.pattern.format.spi.PatternKeywordProvider: Called by service loader.
patternRegistry(PatternRegistry) - Method in class io.jstach.rainbowgum.pattern.format.PatternCompiler.Builder: Pattern keyword registry.
PatternRegistry - Interface in io.jstach.rainbowgum.pattern.format: Pattern registry to register custom keywords.
PatternRegistry.ColorKey - Enum Class in io.jstach.rainbowgum.pattern.format: Built-in supported color pattern keys.
PatternRegistry.KeywordKey - Enum Class in io.jstach.rainbowgum.pattern.format: Built-in supported pattern keys.
PatternRegistry.PatternKey - Interface in io.jstach.rainbowgum.pattern.format: Pattern keywords.
PatternRegistry.PatternKeyProvider - Interface in io.jstach.rainbowgum.pattern.format: Implement this interface along with the formatter for easier registration.
PatternRegistry.SpringBootKey - Enum Class in io.jstach.rainbowgum.pattern.format: Spring Boot patterns.
peekNdc() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
PERCENT - Enum constant in enum class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder.Format: Percent encoded like a URI query, the default: requestId=42&user=Ada%20Lovelace.
PERCENT - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: Percent encoded like a URI query: requestId=42&user=Ada%20Lovelace.
PercentCodec - Class in io.jstach.rainbowgum: Percent encoding (RFC 3986), the encoding Rainbow Gum uses for URI query properties and for key values written with KeyValuesFormatterBuilder.Format.PERCENT, so that key values read from a log decode back to exactly what was logged.
PLAIN - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: Upper case without padding.
Plural keys for enabling/disabling - Section in Overview
policy() - Method in interface io.jstach.rainbowgum.LogOutput.ProvidesEncoder: Whether LogOutput.ProvidesEncoder.encoder(String, LogConfig) can be overridden by an explicitly configured encoder.
policy() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
popNdc() - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
prefix() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable: Property prefix to use for property lookup.
prettyPrint(Json5PrettyPrint) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: Sets required prettyPrint.
prettyPrint(KeyValues, StringBuilder) - Static method in interface io.jstach.rainbowgum.KeyValues: Pretty prints key values.
prettyPrint(Boolean) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets prettyPrint.
prettyPrint(Boolean) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Sets prettyPrint.
prettyPrint(Boolean) - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderBuilder: Sets prettyPrint.
prettyPrint(Boolean) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder: Sets prettyPrint.
priority() - Method in class io.jstach.rainbowgum.jansi.JAnsiConfigurator
priority() - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigurator
priority() - Method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Configurator: Priority of configurators.
priority() - Method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.RainbowGumProvider: If there are multiple rainbow gum providers found the higher priority ones are tried first (RainbowGumServiceProvider.RainbowGumProvider.provide(LogConfig)).
profiles(String...) - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Sets fallback profiles in priority order.
profiles(List) - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Sets fallback profiles in priority order.
Profiles - Section in Overview
PROFILES_PROPERTY - Static variable in class io.jstach.rainbowgum.simple.props.SimpleProperties: Comma-separated profiles, in priority order.
Project Information - Section in Overview
properties() - Method in interface io.jstach.rainbowgum.LogConfig.ConfigSupport
properties() - Method in interface io.jstach.rainbowgum.LogConfig: String key value properties.
properties() - Method in interface io.jstach.rainbowgum.LogProperty: The properties this key (or keys) will be looked up against.
properties() - Method in interface io.jstach.rainbowgum.LogProperty.PropertySupport: String key value properties.
properties() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing: Returns the value of the properties record component.
properties() - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties: The layers described in this class's javadoc, highest priority first.
properties(LogProperties) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets log properties
Properties - Section in Overview
Properties based - Section in Overview
propertiesProvider(RainbowGumServiceProvider.PropertiesProvider) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Add properties.
PROPERTY - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Property keywords
PROPERTY_PREFIX - Static variable in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues: Property prefix of this module.
propertyFunction() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Key Value function for ad-hoc property replacements and lookup in various patterns.
propertyFunction(LogProperties, String) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Creates a property function.
propertyFunction(Function) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets propertyFunction.
propertyPrefix() - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogBuilder: The interpolated property prefix: "logging.route.{name}.publisher.{scheme}.".
propertyPrefix() - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: The interpolated property prefix: "logging.appender.{name}.output.file.".
propertyPrefix() - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.json5.".
propertyPrefix() - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.logfmt.".
propertyPrefix() - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.ttll.".
propertyPrefix() - Method in class io.jstach.rainbowgum.jfr.JfrAlertListenerBuilder: The interpolated property prefix: "logging.jfr.alerts.".
propertyPrefix() - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.ecs.".
propertyPrefix() - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.gelf.".
propertyPrefix() - Method in class io.jstach.rainbowgum.json.encoder.LogbackJsonEncoderBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.logback.".
propertyPrefix() - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.logstash.".
propertyPrefix() - Method in class io.jstach.rainbowgum.LogAppender.Builder
propertyPrefix() - Method in interface io.jstach.rainbowgum.LogBuilder: The property prefix used to resolve which properties to extract from LogProperties.
propertyPrefix() - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.otlp.".
propertyPrefix() - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: The interpolated property prefix: "logging.appender.{name}.output.otlp.".
propertyPrefix() - Method in class io.jstach.rainbowgum.output.StdErrOutputBuilder: The interpolated property prefix: "logging.appender.{name}.output.stderr.".
propertyPrefix() - Method in class io.jstach.rainbowgum.output.StdOutOutputBuilder: The interpolated property prefix: "logging.appender.{name}.output.stdout.".
propertyPrefix() - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: The interpolated property prefix: "logging.pattern.config.{name}.".
propertyPrefix() - Method in class io.jstach.rainbowgum.pattern.format.PatternEncoderBuilder: The interpolated property prefix: "logging.appender.{name}.encoder.pattern.".
propertyPrefix() - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: The interpolated property prefix: "logging.route.{name}.publisher.{scheme}.".
propertyPrefix() - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: The interpolated property prefix: "logging.appender.{name}.output.rolling.".
protocol() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput: The payload encoding.
protocol(OtlpProtocol) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets protocol.
provide() - Method in class io.jstach.rainbowgum.scopedkeyvalues.provider.ScopedKeyValuesProviderFactoryImpl
provide() - Method in interface io.jstach.rainbowgum.scopedkeyvalues.spi.ScopedKeyValuesProviderFactory: Creates (or otherwise obtains) the provider.
provide() - Static method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider: Will load all RainbowGum SPI to create a RainbowGum powered from the ServiceLoader using the current thread context class loader if avaiable otherwise the system classloader.
provide(LogConfig) - Method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.RainbowGumProvider: Optionally provides a rainbow gum based on config.
provide(LogConfig, ClassLoader, Environment) - Method in interface io.jstach.rainbowgum.spring.boot.spi.SpringRainbowGumServiceProvider: Provides a Rainbow Gum that has configuration already Spring Bootified.
provide(LogProviderRef) - Method in interface io.jstach.rainbowgum.LogEncoder.EncoderProvider: Loads an encoder from a URI.
provide(LogProviderRef) - Method in interface io.jstach.rainbowgum.LogOutput.OutputProvider: Creates an output ready to be injected with config.
provide(LogProviderRef) - Method in interface io.jstach.rainbowgum.LogPublisher.PublisherProvider: Provides a publisher factory by properties and uri.
provide(String, LogConfig) - Method in interface io.jstach.rainbowgum.LogProvider: Creates the component from config.
provide(ServiceLoader) - Static method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider: Will load all RainbowGum SPI to create a RainbowGum powered from the ServiceLoader.
provideConfig(ServiceLoader) - Static method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider: Creates config from service loader.
provideOrNull(LogProvider, String, LogConfig) - Static method in interface io.jstach.rainbowgum.LogProvider: Convenience for flattening nullable providers.
provideProperties(ServiceRegistry, LogAlerts) - Method in class io.jstach.rainbowgum.avaje.AvajePropertiesProvider
provideProperties(ServiceRegistry, LogAlerts) - Method in class io.jstach.rainbowgum.simple.props.SimplePropertiesProvider
provideProperties(ServiceRegistry, LogAlerts) - Method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.PropertiesProvider: Provides properties and or register services.
provideValue(LogProperty.Result, String, LogConfig) - Static method in interface io.jstach.rainbowgum.LogProperty: Like LogProperty.Result.map(PropertyFunction) but specifically for the "resolve to a LogProvider, then provide" step used by output/encoder/appender resolution.
providingError(LogProperty.Result.Success, Exception) - Static method in interface io.jstach.rainbowgum.LogProperty: Like LogProperty.richError(Result.Success, Exception) but for a property whose value was used to invoke LogProvider.provide(String, LogConfig) rather than a plain same-property type conversion - see LogProperty.provideValue(Result, String, LogConfig).
prudent(Boolean) - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: Sets prudent.
prudent(Boolean) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets prudent.
publish() - Method in interface io.jstach.rainbowgum.LogConfig.ChangePublisher: Publish that there has been changes.
publish(LogRecord) - Static method in class io.jstach.rainbowgum.jul.JULBridge: Translates a JUL LogRecord into a Rainbow Gum event and routes it, if the record's logger name/level is currently enabled.
publisher() - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
publisher() - Method in interface io.jstach.rainbowgum.LogRouter.Router: Log publisher.
publisher(LogPublisher.PublisherFactory) - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder: Sets the publisher.
PUBLISHER_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Prefix of the properties configuring a route's publisher, followed by the URI scheme of "logging.route.{name}.publisher.uri", for example logging.route.
publisherRegistry() - Method in interface io.jstach.rainbowgum.LogConfig: Provides publishers by URI scheme.
Publishers - Section in Overview
pushNdc(String) - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
put(Class, String, T) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Puts a service.
put(Class, T) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Puts a service.
put(String, String) - Method in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues: Sets one key value from code, keeping the others.
put(String, String) - Method in interface io.jstach.rainbowgum.LogProperties.MutableLogProperties: Assigns key to a value.
putAll(Map) - Method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Same as Map.putAll(Map).
putIfAbsent(Class, String, Supplier) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Puts a service if absent.
putIfAbsent(Class, Supplier) - Method in interface io.jstach.rainbowgum.ServiceRegistry: Puts a service if absent.
putKeyValue(String, String) - Method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Same as Map.put(Object, Object).
putMdc(String, Object) - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider

Q

queued(LogConfig) - Static method in interface io.jstach.rainbowgum.RainbowGum: Creates a RainbowGum that will ALWAYS use the global router.
QUOTE - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing JSON quote: "

R

RainbowGum - Interface in io.jstach.rainbowgum: The main entry point and configuration of RainbowGum logging.
RAINBOWGUM - Static variable in interface io.jstach.rainbowgum.format.TTLL.ColorTheme: The Rainbow Gum colors, the same as the pattern encoder's default: cyan time, faint thread and key values, level highlighted (error and warn bold red, info bold blue) and magenta logger name.
RainbowGum.Builder - Class in io.jstach.rainbowgum: RainbowGum Builder.
RainbowGumAlertEvent - Class in io.jstach.rainbowgum.jfr: Base JFR event committed by JfrAlertListener, one concrete subclass per SLF4J / System.Logger.Level, deliberately a separate JFR event type family from RainbowGumLogEvent (same field shape and per-level split, but its own @Names) even though both are committed the same way and carry the same fields: an alert (an appender failing to write, an async publisher's queue overflowing, etc.) is not an application log line, and merging the two under one event name would make it impossible to tell them apart in a recording - e.g. filtering jfr print --events io.jstach.rainbowgum.Error would return both genuine application errors and RainbowGum's own internal alerts with no way to distinguish them.
RainbowGumAlertEvent.DebugEvent - Class in io.jstach.rainbowgum.jfr: DEBUG level alert.
RainbowGumAlertEvent.ErrorEvent - Class in io.jstach.rainbowgum.jfr: ERROR level alert.
RainbowGumAlertEvent.InfoEvent - Class in io.jstach.rainbowgum.jfr: INFO level alert.
RainbowGumAlertEvent.TraceEvent - Class in io.jstach.rainbowgum.jfr: TRACE level alert.
RainbowGumAlertEvent.WarnEvent - Class in io.jstach.rainbowgum.jfr: WARN level alert.
RainbowGumAppLog - Class in io.jstach.rainbowgum.avaje: Provides an Avaje logger to use RainbowGum global queue to avoid initialization issues.
RainbowGumAppLog() - Constructor for class io.jstach.rainbowgum.avaje.RainbowGumAppLog: For service loader.
RainbowGumJBossLoggerProvider - Class in io.jstach.rainbowgum.jbosslogging: Native LoggerProvider for JBoss Logging backed directly by LogRouter.global(), not through SLF4J.
RainbowGumJBossLoggerProvider() - Constructor for class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider: For ServiceLoader.
RainbowGumLog4jProvider - Class in io.jstach.rainbowgum.log4j: Registered via ServiceLoader (META-INF/services/ org.apache.logging.log4j.spi.Provider), not the older META-INF/log4j-provider.properties mechanism: decompiling this version of log4j-api shows that path's Provider(Properties, URL, ClassLoader) constructor unconditionally sets versions to null, which ProviderUtil/validVersion then rejects outright ("Ignoring provider for incompatible version"), confirmed empirically: a properties-file-registered provider is silently never selected.
RainbowGumLog4jProvider() - Constructor for class io.jstach.rainbowgum.log4j.RainbowGumLog4jProvider: For ServiceLoader.
RainbowGumLogEvent - Class in io.jstach.rainbowgum.jfr: Base JFR event committed by JfrLogOutput, one concrete subclass per SLF4J / System.Logger.Level, so each level can be independently enabled/disabled and thresholded through a Flight Recorder configuration (.jfc) the same way any other JFR event type can.
RainbowGumLogEvent.DebugEvent - Class in io.jstach.rainbowgum.jfr: DEBUG level event.
RainbowGumLogEvent.ErrorEvent - Class in io.jstach.rainbowgum.jfr: ERROR level event.
RainbowGumLogEvent.InfoEvent - Class in io.jstach.rainbowgum.jfr: INFO level event.
RainbowGumLogEvent.TraceEvent - Class in io.jstach.rainbowgum.jfr: TRACE level event.
RainbowGumLogEvent.WarnEvent - Class in io.jstach.rainbowgum.jfr: WARN level event.
RainbowGumLoggerContextFactory - Class in io.jstach.rainbowgum.log4j: Constructed directly by RainbowGumLog4jProvider's own constructor (passed as a Class to the Provider superclass, which instantiates it reflectively via a public no-arg constructor on first use).
RainbowGumLoggerContextFactory() - Constructor for class io.jstach.rainbowgum.log4j.RainbowGumLoggerContextFactory: For reflective construction by Provider.
RainbowGumLoggingProvider - Class in io.jstach.rainbowgum.helidon27: Bootstraps Rainbow Gum at the exact point Helidon itself bootstraps logging.
RainbowGumLoggingProvider - Class in io.jstach.rainbowgum.helidon4: Bootstraps Rainbow Gum at the exact point Helidon itself bootstraps logging.
RainbowGumLoggingProvider() - Constructor for class io.jstach.rainbowgum.helidon27.RainbowGumLoggingProvider: For ServiceLoader.
RainbowGumLoggingProvider() - Constructor for class io.jstach.rainbowgum.helidon4.RainbowGumLoggingProvider: For ServiceLoader.
RainbowGumLogManager - Class in io.jstach.rainbowgum.jul.logmanager: A LogManager implementation that vends RainbowGumJULLoggers, routing every java.util.logging.Logger call directly through Rainbow Gum instead of the normal Handler/Level dispatch.
RainbowGumLogManager() - Constructor for class io.jstach.rainbowgum.jul.logmanager.RainbowGumLogManager: For LogManager.getLogManager()'s reflective instantiation, per the java.util.logging.manager system property contract.
RainbowGumServiceProvider - Interface in io.jstach.rainbowgum.spi: RainbowGum SPI.
RainbowGumServiceProvider.Configurator - Interface in io.jstach.rainbowgum.spi: Called after LogConfig has been loaded to do various custom initialization like registering LogOutput.OutputProviders.
RainbowGumServiceProvider.Pass - Enum Class in io.jstach.rainbowgum.spi: Providers sometimes need multiple passes to support dependencies without using true dependency injection.
RainbowGumServiceProvider.PropertiesProvider - Interface in io.jstach.rainbowgum.spi: Provides properties and or register services.
RainbowGumServiceProvider.RainbowGumEagerLoad - Interface in io.jstach.rainbowgum.spi: This is a marker interface that indicates that a facade implementation will do the eager loading of RainbowGum.
RainbowGumServiceProvider.RainbowGumProvider - Interface in io.jstach.rainbowgum.spi: Implement to create a custom RainbowGum.
rainbowgum-simple - Section in Overview
rainbowgum-simple-props - Section in Overview
RainbowGumSLF4JServiceProvider - Class in io.jstach.rainbowgum.slf4j: SLF4J provider using RainbowGum.
RainbowGumSLF4JServiceProvider() - Constructor for class io.jstach.rainbowgum.slf4j.RainbowGumSLF4JServiceProvider: No Arg for service laoder.
RainbowGumSystemLogger - Class in io.jstach.rainbowgum.systemlogger: Rainbow Gum System Logger implementation.
RainbowGumSystemLoggerFinder - Class in io.jstach.rainbowgum.systemlogger: Abstract System Logger Finder to allow users to create their own custom System.LoggerFinder.
RainbowGumSystemLoggerFinder(Supplier) - Constructor for class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder: Creates the logger inder based on init option.
RainbowGumSystemLoggerFinder.InitOption - Enum Class in io.jstach.rainbowgum.systemlogger: Values (case is ignored) for "logging.systemlogger.initialize".
RainbowGumVersion - Class in io.jstach.rainbowgum: Provides the version information of Rainbow Gum as static literals.
RED - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI red color
redactUri(URI) - Static method in interface io.jstach.rainbowgum.LogProperty: Renders a URI for diagnostics with user information and sensitive query values redacted.
REENTRANT - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.AppenderLock: No appender uses synchronized: a requested LogAppender.AppenderType.SYNCHRONIZED_THREAD_LOCAL_BUFFER becomes LogAppender.AppenderType.LOCK_THREAD_LOCAL_BUFFER.
REENTRY_DROP - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderFlag: The appender will drop events on reentry which happens if an appender during its append causes recursive appending in the same thread.
REENTRY_LOG - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderFlag: The appender will log events as errors to std error on reentry which happens if an appender during its append causes recursive appending in the same thread.
register(LogEncoderRegistry) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: Will register this TTLL like encoder with the uri schema "ttll" and will be used as the default encoder if other encoders are not found.
register(LogEncoderRegistry, String) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: Registers this TTLL like encoder with the given uri schema.
register(PatternRegistry) - Method in class io.jstach.rainbowgum.pattern.format.spi.PatternKeywordProvider: Registers formatter factories with keywords.
register(PatternRegistry.PatternKey, PatternFormatterFactory) - Method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry: Registers a pattern key with a formatter factory.
register(ServiceRegistry, LogEventFactory.KeyValuesContributor.Source, LogEventFactory.KeyValuesContributor) - Static method in interface io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor: Registers the contributor for a context store.
register(String, LogEncoder.EncoderProvider) - Method in interface io.jstach.rainbowgum.LogEncoderRegistry: Registers an encoder by uri scheme.
register(String, LogOutput.OutputProvider) - Method in interface io.jstach.rainbowgum.LogOutputRegistry: Register a provider by scheme.
register(String, LogPublisher.PublisherProvider) - Method in interface io.jstach.rainbowgum.LogPublisherRegistry: Register a publisher provider by URI scheme.
register(P) - Method in interface io.jstach.rainbowgum.pattern.format.PatternRegistry: Convenience to register factories that have keys associated with them by implementing PatternRegistry.PatternKeyProvider.
registerLoggerName(LoggerAPI, String) - Method in interface io.jstach.rainbowgum.LogConfig.LoggerRegistry: Registers that a logger with this name exists.
REJECTED_METRIC - Static variable in class io.jstach.rainbowgum.otlp.OtlpOutput: Metric counting log records the endpoint rejected in a partial success response.
RELATIVE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Relative time keywords.
remove(String) - Method in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues: Removes one key set in code, keeping the others.
remove(String) - Method in interface io.jstach.rainbowgum.KeyValues.MutableKeyValues: Same as Map.remove(Object).
removeContext(LoggerContext) - Method in class io.jstach.rainbowgum.log4j.RainbowGumLoggerContextFactory
removeKeyPrefix(String) - Method in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: Removes the prefix from a key before it accesses the underlying properties.
removeKeyPrefix(String, String) - Static method in interface io.jstach.rainbowgum.LogProperties: Remove key prefix from the key.
removeMdc(String) - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
renameKey - Variable in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: rename key
renameKey(Function) - Method in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: Renames the key before it accesses function.
reopen() - Method in interface io.jstach.rainbowgum.LogOutput: Attempts to reopen the output if supported and SHOULD only be called by the appender!
reopen() - Method in interface io.jstach.rainbowgum.LogOutputRegistry: Attempts to reopen all outputs of a certain type usually for log rotation.
REOPEN - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.REOPEN_METRIC.
REOPEN_FAIL - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.REOPEN_FAIL_METRIC.
REOPEN_FAIL_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the global count of failed appender output reopen attempts.
REOPEN_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for the global count of appender output reopen attempts, whether successful or failed.
report() - Method in interface io.jstach.rainbowgum.LogReporter: Renders the report with the default options as a String.
report(LogReporter.Options) - Method in interface io.jstach.rainbowgum.LogReporter: Renders the report as a String.
report(LogReporter.Options, Appendable) - Method in interface io.jstach.rainbowgum.LogReporter: Writes the report directly to the given appendable, rather than building the whole report in memory first, so a caller can stream straight into a Writer/response even while the system is in a degraded state.
report(LogReporter.Options, StringBuilder) - Method in interface io.jstach.rainbowgum.LogReporter: Writes the report to a StringBuilder, which never actually throws IOException in practice, so callers do not need to handle one.
report(Appendable) - Method in enum class io.jstach.rainbowgum.LogProperties.StandardProperties
report(Appendable) - Method in interface io.jstach.rainbowgum.LogReporter.Reportable: Writes this component's own description directly to the given appendable.
report(Appendable) - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
reporter() - Method in interface io.jstach.rainbowgum.LogConfig: Diagnostic reporter for this config and the RainbowGum built from it.
Reporting - Section in Overview
Reporting a bug - Section in Overview
require(String, T) - Static method in interface io.jstach.rainbowgum.LogProperty: Checks that value is not null, throwing LogProperty.PropertyMissingException naming key if it is.
Requirements - Section in Overview
resolveLevel(String) - Method in interface io.jstach.rainbowgum.LevelResolver.LevelConfig: Resolves a level by walking up the dotted path by calling LevelResolver.LevelConfig.levelOrNull(String) which follows Logbacks Effective Level.
resolveLevel(String) - Method in interface io.jstach.rainbowgum.LevelResolver: Determines what level the logger should be at.
resolver(LevelResolver) - Method in class io.jstach.rainbowgum.LevelResolver.Builder: Adds a level resolver to the end of the resolve list.
resource(String) - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Sets the classpath resource to load properties from.
resourceAttributes(Map) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Sets resourceAttributes.
resourceAttributes(Map) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets resourceAttributes.
REUSE - Enum constant in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: Will reuse an existing rainbow gum or fail.
REUSE_BUFFER - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderType: The appender will create a single buffer that will be reused and will be protected by the appenders locking.
richError(LogProperty.Result.Success, Exception) - Static method in interface io.jstach.rainbowgum.LogProperty: Builds a rich error from a failed conversion of a previously successful result - package-visible (rather than private) only so the top-level PropertySuccess can call it from LogProperty.Result.map(PropertyFunction).
rightPadded(System.Logger.Level) - Static method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter: Turns a Level into a SLF4J like level String that is all upper case and same length with right padding.
ROLL_FAIL - Enum constant in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: See LogMetrics.ROLL_FAIL_METRIC.
ROLL_FAIL_METRIC - Static variable in interface io.jstach.rainbowgum.LogMetrics: Counter name for failed automatic file rotation attempts, including closing the active output, rotating archives, and opening the replacement output.
ROLLING_SCHEME - Static variable in interface io.jstach.rainbowgum.rolling.RollingFileOutput: URI scheme for rolling file outputs.
RollingConfigurator - Class in io.jstach.rainbowgum.rolling: Registers the two URI schemes rainbowgum-file provides: "file" (so file:///path/to/app.log resolves to a FileOutput - core on its own has no such registration) and "rolling" (so rolling:///path/to/app.log resolves to a RollingFileOutput).
RollingConfigurator() - Constructor for class io.jstach.rainbowgum.rolling.RollingConfigurator: No arg for service loader.
RollingFileOutput - Interface in io.jstach.rainbowgum.rolling: A FileOutput that rolls (renames the active file to a numbered archive and starts a fresh one) once it grows past maxFileSize, retaining at most maxHistory archives.
RollingFileOutputBuilder - Class in io.jstach.rainbowgum.rolling: Builder to create LogProvider<RollingFileOutput>.
RollingFileOutputBuilder(String) - Constructor for class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Create a builder for io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.rolling.RollingFileOutput> .
Rolling Files - Section in Overview
ROOT_EXCEPTION - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Root exception keywords.
ROOT_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Logging properties prefix.
rootCauseFirst(boolean) - Method in class io.jstach.rainbowgum.LogFormatter.ThrowableFormatter.Builder: Whether to print the root cause first instead of last, working back up through each wrapping exception ("Wrapped by: ..." instead of "Caused by: ..."), mirroring logback's RootCauseFirstThrowableProxyConverter (%rEx/ %rootException).
route(LogRouter.Router) - Method in class io.jstach.rainbowgum.RainbowGum.Builder: Adds a router.
route(String, System.Logger.Level) - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
route(String, System.Logger.Level) - Method in interface io.jstach.rainbowgum.LogRouter: Finds a route.
route(String, Consumer) - Method in class io.jstach.rainbowgum.RainbowGum.Builder: Adds a route by using a consumer of the route builder.
route(Consumer) - Method in class io.jstach.rainbowgum.RainbowGum.Builder: Adds a route by using a consumer of the route builder.
ROUTE_APPENDERS_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Appenders associated with a route comma separated.
ROUTE_FLAGS_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Route flags.
ROUTE_LEVEL_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Logging level properties prefix.
ROUTE_PREFIX - Static variable in interface io.jstach.rainbowgum.LogProperties: Route prefix for configuration.
ROUTE_PUBLISHER_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Logging publisher URI property.
Route Level Priority - Section in Overview
router() - Method in interface io.jstach.rainbowgum.RainbowGum: The router that will route log messages to publishers.
Router - Section in Overview
ROUTES_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogProperties: Routes enabled with names comma separated.
run(Runnable) - Method in interface io.jstach.rainbowgum.scopedkeyvalues.ScopedKeyValues.Builder: Pushes this layer and runs body for its duration.
runConfigurators(Stream, LogConfig) - Static method in interface io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Configurator: Runs configurators.
runTime() - Method in class io.jstach.rainbowgum.helidon27.RainbowGumLoggingProvider
runTime() - Method in class io.jstach.rainbowgum.helidon4.RainbowGumLoggingProvider

S

SCHEMA - Static variable in interface io.jstach.rainbowgum.format.TTLL: URI scheme of the TTLL encoder, the default encoder when no other is configured.
SCHEME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Key parameter for the URI scheme a publisher was selected with, without "core.".
SCOPED_KEY_VALUES - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: rainbowgum-scopedkeyvalues (ScopedKeyValues).
ScopedKeyValues - Class in io.jstach.rainbowgum.scopedkeyvalues: Request/task-scoped key values, pushed once (typically once, wrapping an entire request or task at its boundary) and never mutated afterward.
Scoped Key Values (java.lang.ScopedValue based MDC alternative) - Section in Overview
ScopedKeyValues.Builder - Interface in io.jstach.rainbowgum.scopedkeyvalues: Builds one immutable layer of key values and pushes it for the duration of a ScopedKeyValues.Builder.run(Runnable)/ScopedKeyValues.Builder.call(CallableOp) call.
ScopedKeyValues.CallableOp<R,X> - Interface in io.jstach.rainbowgum.scopedkeyvalues: Like java.lang.ScopedValue.CallableOp but declared here so this API module never has to reference java.lang.ScopedValue itself, keeping it compilable on older JDKs - the real ScopedValue-backed provider (a separate module requiring a newer JDK) bridges the two with a plain method reference, since both interfaces share the same R call() throws X shape.
ScopedKeyValuesConfigurator - Class in io.jstach.rainbowgum.scopedkeyvalues.provider: Registers ScopedKeyValues as a LogEventFactory.KeyValuesContributor for LogEventFactory.KeyValuesContributor.Source.Standard.SCOPED_KEY_VALUES, so every logging API Rainbow Gum supports picks up the current scoped key values.
ScopedKeyValuesConfigurator() - Constructor for class io.jstach.rainbowgum.scopedkeyvalues.provider.ScopedKeyValuesConfigurator: For service loader.
ScopedKeyValuesProvider - Interface in io.jstach.rainbowgum.scopedkeyvalues.spi: Service Provider Interface for ScopedKeyValues, discovered with ServiceLoader.
ScopedKeyValuesProviderFactory - Interface in io.jstach.rainbowgum.scopedkeyvalues.spi: Service Provider Interface ServiceLoader actually discovers for ScopedKeyValues - a factory rather than the ScopedKeyValuesProvider itself, since a factory method can do things a bare no-arg-constructor ServiceLoader instantiation cannot (validate preconditions, choose between alternate implementations, read configuration, etc) without ScopedKeyValues needing to know anything about how the provider it gets back was actually put together.
ScopedKeyValuesProviderFactoryImpl - Class in io.jstach.rainbowgum.scopedkeyvalues.provider: The java.util.ServiceLoader-discovered factory for ScopedKeyValuesProviderImpl.
ScopedKeyValuesProviderFactoryImpl() - Constructor for class io.jstach.rainbowgum.scopedkeyvalues.provider.ScopedKeyValuesProviderFactoryImpl: For ServiceLoader.
section(LogReporter.Section) - Method in class io.jstach.rainbowgum.LogReporter.Options.Builder: Adds a single section to print, in addition to any already added.
sections(Set) - Method in class io.jstach.rainbowgum.LogReporter.Options.Builder: Replaces the set of sections to print.
Selecting and Configuring the Pattern Encoder - Section in Overview
self() - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: For builder
self() - Method in class io.jstach.rainbowgum.format.StandardEventFormatter.Builder
self() - Method in class io.jstach.rainbowgum.LevelResolver.AbstractBuilder: This.
self() - Method in class io.jstach.rainbowgum.LevelResolver.Builder: This.
self() - Method in class io.jstach.rainbowgum.LogConfig.Builder
self() - Method in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: For returning this.
self() - Method in class io.jstach.rainbowgum.LogProperties.Builder
self() - Method in class io.jstach.rainbowgum.LogProperties.MutableLogProperties.Builder
self() - Method in class io.jstach.rainbowgum.LogPublisher.AbstractBuilder: This.
self() - Method in class io.jstach.rainbowgum.LogPublisher.AsyncLogPublisher.Builder
self() - Method in class io.jstach.rainbowgum.LogPublisher.SyncLogPublisher.Builder: This builder.
self() - Method in class io.jstach.rainbowgum.LogRouter.Router.Builder
SEMI - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Helper for writing semicolon: :
SEP - Static variable in interface io.jstach.rainbowgum.LogProperties: properties separator.
sequenceNumberStart() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: The first value returned by %lsn.
sequenceNumberStart(Long) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets sequenceNumberStart.
serviceEnvironment(String) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets serviceEnvironment.
serviceLoader() - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets a default service loader to use for loading components that were not set.
serviceLoader(ServiceLoader) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets the service loader to use for loading components that were not set.
serviceName(String) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets serviceName.
serviceName(String) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Sets serviceName.
serviceName(String) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets serviceName.
serviceNodeName(String) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets serviceNodeName.
serviceRegistry() - Method in interface io.jstach.rainbowgum.LogConfig: Service registry are custom services needed by plugins particularly during the initialization process.
serviceRegistry(ServiceRegistry) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: Sets serviceRegistry.
serviceRegistry(ServiceRegistry) - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: Sets serviceRegistry.
serviceRegistry(ServiceRegistry) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets serviceRegistry.
serviceRegistry(ServiceRegistry) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets service registry
ServiceRegistry - Interface in io.jstach.rainbowgum: A simple service locator for initialization purposes and external services provided by plugins.
serviceVersion(String) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets serviceVersion.
set() - Method in class io.jstach.rainbowgum.RainbowGum.Builder: Builds, starts and sets the RainbowGum as the global one picked up by logging facades.
set(KeyValues) - Method in class io.jstach.rainbowgum.keyvalues.contributor.DefaultKeyValues: Replaces the key values set in code.
set(RainbowGum) - Static method in interface io.jstach.rainbowgum.RainbowGum: Sets a Rainbow Gum and provides a supplier that will start it globally.
set(Supplier) - Static method in interface io.jstach.rainbowgum.RainbowGum: Sets the global default RainbowGum.
setConsumer(BiConsumer) - Method in class io.jstach.rainbowgum.output.ListLogOutput: Sets a consumer for testing purposes.
setDepth(int) - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: Sets the depth of an event builder.
setDepth(LoggingEventBuilder, int) - Static method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: Will recreate the logger with desired depth if possible.
setEncoderForOutputType(LogOutput.OutputType, LogProvider) - Method in interface io.jstach.rainbowgum.LogEncoderRegistry: Sets a default formatter for a specific output type.
setLogger(LogEventLogger) - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: Redirects the output.
setNdcMaxDepth(int) - Method in class io.jstach.rainbowgum.jbosslogging.RainbowGumJBossLoggerProvider
SHORT - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.LoggerFormat: Only the last component of the name, like slf4j-simple's showShortLogName: App for com.example.App.
SHORT - Enum constant in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.StrictType: Keys without the logging prefix get it, in the base resource and profile resources: level.com.myco=debug is logging.level.com.myco=debug.
SHOW - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesWhenEmpty: Always written, {} when there are no key values.
SHUTDOWN_TIMEOUT_NAME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Shutdown timeout property name.
SHUTDOWN_TIMEOUT_PROPERTY - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: Milliseconds an async publisher's close waits for queued events to be written.
shutdownTimeout(Duration) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisherBuilder: Sets required shutdownTimeout.
Simple logging and properties - Section in Overview
SimpleProperties - Class in io.jstach.rainbowgum.simple.props: Resolves LogProperties from the following layers, highest priority first: The optional watched level file, enabled by "logging.simpleprops.levelFile".
SimpleProperties.Builder - Class in io.jstach.rainbowgum.simple.props: Builds a SimpleProperties.
SimpleProperties.LevelFileType - Enum Class in io.jstach.rainbowgum.simple.props: Whether to watch a level file, see "logging.simpleprops.levelFile".
SimpleProperties.StrictType - Enum Class in io.jstach.rainbowgum.simple.props: Controls how resource property keys without the logging prefix are treated.
SimplePropertiesProvider - Class in io.jstach.rainbowgum.simple.props: Makes SimpleProperties provide properties to RainbowGum.
SimplePropertiesProvider() - Constructor for class io.jstach.rainbowgum.simple.props.SimplePropertiesProvider: For service loader.
size() - Method in interface io.jstach.rainbowgum.KeyValues: Analogous to Map.size().
size() - Method in record class io.jstach.rainbowgum.LogAlerts.Stats: Returns the value of the size record component.
SKIP - Enum constant in enum class io.jstach.rainbowgum.LogFormatter.KeyValueNullStrategy: The key is omitted entirely (no key, no =) if its value is null.
SLF4J - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: rainbowgum-slf4j (org.slf4j.MDC).
SLF4J - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: rainbowgum-slf4j.
SLF4J - Enum constant in enum class io.jstach.rainbowgum.LogMessageFormatter.StandardMessageFormatter: SLF4J format style where "{}" is replaced with the parameters.
SLF4J 2.0 - Section in Overview
SLF4J based filtering - Section in Overview
SLF4JKeyValuesConfigurator - Class in io.jstach.rainbowgum.slf4j: Registers SLF4J's MDC as a LogEventFactory.KeyValuesContributor for LogEventFactory.KeyValuesContributor.Source.Standard.SLF4J so events from other logging APIs (JUL, System.Logger, ...) carry the current MDC as well.
SLF4JKeyValuesConfigurator() - Constructor for class io.jstach.rainbowgum.slf4j.SLF4JKeyValuesConfigurator: For service loader.
SLF4JRainbowGumEagerLoad - Class in io.jstach.rainbowgum.slf4j: This is an internal detail to signal that this SLF4J implementation will load Rainbow Gum.
SLF4JRainbowGumEagerLoad() - Constructor for class io.jstach.rainbowgum.slf4j.SLF4JRainbowGumEagerLoad: no arg constructor required for service loader however it will unlikely be called.
snapshot() - Method in interface io.jstach.rainbowgum.LogMetrics: A snapshot of every metric recorded via LogMetrics.errorCounter(String, long), LogMetrics.warnCounter(String, long), LogMetrics.infoCounter(String, long), and LogMetrics.gauge(String, Level).
space() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends a space.
SPACING - Enum constant in enum class io.jstach.rainbowgum.format.Json5PrettyPrint: Level padding and a space after every comma: level:"INFO" , logger:"com.example.App", thread:....
SPAN_ID_KEY - Static variable in class io.jstach.rainbowgum.opentelemetry.OpenTelemetryConfigurator: Key value holding the current span's span id.
spanIdKey(String) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Sets spanIdKey.
spanIdKey(String) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets spanIdKey.
SPRING - Static variable in interface io.jstach.rainbowgum.format.TTLL.ColorTheme: Spring Boot's console colors: faint time and thread, level colored by severity (error red, warn yellow, the rest green) and cyan logger name.
Spring Boot - Section in Overview
SpringRainbowGumServiceProvider - Interface in io.jstach.rainbowgum.spring.boot.spi: Provides a custom Spring Boot aware RainbowGum through META-INF/spring.factories.
StandardEventFormatter - Class in io.jstach.rainbowgum.format: A TTLL formatter that has the layout of TTLL - Time, Thread, Level, Logger but allows changing the format of time, thread, level, logger, etc.
StandardEventFormatter.Builder - Class in io.jstach.rainbowgum.format: Builder for StandardEventFormatter aka TTLL formatter.
start() - Method in interface io.jstach.rainbowgum.RainbowGum: Starts the rainbow gum and returns it.
start(LogConfig) - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogPublisher
start(LogConfig) - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
start(LogConfig) - Method in interface io.jstach.rainbowgum.LogLifecycle: Starts a component.
start(LogConfig) - Method in interface io.jstach.rainbowgum.LogOutput
start(LogConfig) - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
start(LogConfig) - Method in class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher
start(LogConfig) - Method in class io.jstach.rainbowgum.publisher.BlockingQueueAsyncLogPublisher
Starting A Recording - Section in Overview
startTime() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: The baseline instant used by %r/%relative to compute elapsed milliseconds.
startTime(Instant) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets startTime.
StaticFormatter(String) - Constructor for record class io.jstach.rainbowgum.LogFormatter.StaticFormatter: Creates an instance of a StaticFormatter record class.
stats() - Method in interface io.jstach.rainbowgum.LogAlerts: Stats about the alerts recorded so far.
Stats(long, int, int) - Constructor for record class io.jstach.rainbowgum.LogAlerts.Stats: Creates an instance of a Stats record class.
STDERR_SCHEME - Static variable in interface io.jstach.rainbowgum.LogOutput: FileDescriptor.err URI scheme.
STDERR_URI - Static variable in interface io.jstach.rainbowgum.LogOutput: Standard ERR URI
StdErrOutputBuilder - Class in io.jstach.rainbowgum.output: Builder to create LogProvider<LogOutput>.
StdErrOutputBuilder(String) - Constructor for class io.jstach.rainbowgum.output.StdErrOutputBuilder: Create a builder for io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.LogOutput> .
STDOUT_SCHEME - Static variable in interface io.jstach.rainbowgum.LogOutput: FileDescriptor.out URI scheme.
STDOUT_URI - Static variable in interface io.jstach.rainbowgum.LogOutput: Standard OUT URI.
StdOutOutputBuilder - Class in io.jstach.rainbowgum.output: Builder to create LogProvider<LogOutput>.
StdOutOutputBuilder(String) - Constructor for class io.jstach.rainbowgum.output.StdOutOutputBuilder: Create a builder for io.jstach.rainbowgum.LogProvider<io.jstach.rainbowgum.LogOutput> .
stream(ConsoleStream) - Method in class io.jstach.rainbowgum.output.StdErrOutputBuilder: Sets required stream.
stream(ConsoleStream) - Method in class io.jstach.rainbowgum.output.StdOutOutputBuilder: Sets required stream.
strict(SimpleProperties.StrictType) - Method in class io.jstach.rainbowgum.simple.props.SimpleProperties.Builder: Sets how resource keys without the logging prefix are treated.
STRICT_PROPERTY - Static variable in class io.jstach.rainbowgum.simple.props.SimpleProperties: How resource keys without the logging prefix are treated.
STRING - Enum constant in enum class io.jstach.rainbowgum.LogOutput.WriteMethod: Prefer calling LogOutput.write(LogEvent, String).
structured() - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoder: Whether fields are nested JSON objects (Spring Boot's ECS shape) instead of the default flattened, dotted field names (the reference ecs-logging-java shape).
structured(Boolean) - Method in class io.jstach.rainbowgum.json.encoder.EcsEncoderBuilder: Sets structured.
subscribe(Consumer) - Method in interface io.jstach.rainbowgum.LogConfig.ChangePublisher: Subscribe to changes.
sync() - Static method in interface io.jstach.rainbowgum.LogPublisher.PublisherFactory: Sync builder.
SYNC_SCHEME - Static variable in interface io.jstach.rainbowgum.LogPublisherRegistry: This is the URI scheme for the sync publisher builder to find a sync publisher.
SYNCHRONIZED - Enum constant in enum class io.jstach.rainbowgum.LogConfig.Globals.AppenderLock: Appenders with a thread local buffer use synchronized: a requested LogAppender.AppenderType.LOCK_THREAD_LOCAL_BUFFER becomes LogAppender.AppenderType.SYNCHRONIZED_THREAD_LOCAL_BUFFER.
SYNCHRONIZED_THREAD_LOCAL_BUFFER - Enum constant in enum class io.jstach.rainbowgum.LogAppender.AppenderType: Like LogAppender.AppenderType.LOCK_THREAD_LOCAL_BUFFER (a reused per-thread buffer, encoding done outside any lock) except the final write to the output is protected by a plain synchronized block (the JVM's intrinsic monitor) instead of a ReentrantLock.
synchronous() - Method in interface io.jstach.rainbowgum.LogPublisher.AsyncLogPublisher
synchronous() - Method in interface io.jstach.rainbowgum.LogPublisher: If the publisher is synchronous.
synchronous() - Method in interface io.jstach.rainbowgum.LogPublisher.SyncLogPublisher
synchronous() - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
synchronous() - Method in interface io.jstach.rainbowgum.LogRouter.Router: Whether or not the publisher is synchronous.
SYSTEM_LOGGER - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: rainbowgum-systemlogger (System.Logger).
SYSTEM_PROPERTIES - Enum constant in enum class io.jstach.rainbowgum.LogProperties.StandardProperties: Uses System.getProperty(String) for LogProperties.valueOrNull(String).

T

text(String) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends static text.
TEXT_PLAIN - Enum constant in enum class io.jstach.rainbowgum.LogOutput.ContentType.StandardContentType: text/plain
textIfThrowable(String) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends text if throwable is set.
theme(TTLL.ColorTheme) - Method in class io.jstach.rainbowgum.format.Json5FormatterBuilder: Sets theme.
theme(TTLL.ColorTheme) - Method in class io.jstach.rainbowgum.format.LogfmtFormatterBuilder: Sets theme.
theme(TTLL.ColorTheme) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets theme.
There is a typo in this documentation how can I fix it? - Section in Overview
thread(LogFormatter) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets required thread.
thread(String) - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder: Thread color.
THREAD - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Thread keywords
threadFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: mutable field
threadFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: immutable field
threadFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Sets thread formatter.
threadId() - Method in interface io.jstach.rainbowgum.LogEvent: Thread id.
threadId() - Method in interface io.jstach.rainbowgum.LogEventFactory: Thread id to use for the next event created by this factory.
threadId() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends a thread ID : Thread.threadId().
threadLocal() - Method in class io.jstach.rainbowgum.LogConfig.Globals: Whether the logging path may use a ThreadLocal, from "logging.global.threadLocal".
threadLocal(LogConfig.Globals.ThreadLocalMode) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Sets whether the logging path may use a ThreadLocal, used when the property "logging.global.threadLocal" is absent.
threadName() - Method in interface io.jstach.rainbowgum.LogEvent: Name of the thread.
threadName() - Method in interface io.jstach.rainbowgum.LogEventFactory: Thread name to use for the next event created by this factory.
threadName() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends a thread name : Thread.getName().
throwable - Variable in class io.jstach.rainbowgum.jfr.RainbowGumAlertEvent: The alert's throwable formatted as a stack trace string, or null if none was logged.
throwable - Variable in class io.jstach.rainbowgum.jfr.RainbowGumLogEvent: The logged throwable formatted as a stack trace string, or null if none was logged.
throwable() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends the events throwable stack trace.
throwable() - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: The cause set on this builder so far, if any.
throwable(LogFormatter.ThrowableFormatter) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Appends the events throwable stack trace using a custom LogFormatter.ThrowableFormatter (e.g. one created with LogFormatter.ThrowableFormatter.builder()).
throwable(LoggingEventBuilder) - Static method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareEventBuilder: The cause set on the builder so far, if possible.
THROWABLE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Throwable keywords
throwableFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: mutable field
throwableFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: immutable field
throwableFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Sets the throwable formatter.
throwableFormatter(LogFormatter.ThrowableFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Sets the throwable formatter.
throwableFormatter(PatternKeyword, boolean) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory: Parses the depth (full/short/a number) and exclude regex options shared by throwable keywords such as %ex/%xEx and Spring Boot's %wEx.
throwableFormatter(PatternKeyword, boolean, boolean) - Static method in interface io.jstach.rainbowgum.pattern.format.PatternFormatterFactory: Like PatternFormatterFactory.throwableFormatter(PatternKeyword, boolean) but also able to build a root-cause-first formatter for %rEx/%rootException.
throwableOrNull() - Method in interface io.jstach.rainbowgum.LogEvent: Throwable at the time of the event passed from the logger.
timeFractionalDigits(Integer) - Method in class io.jstach.rainbowgum.json.encoder.GelfEncoderBuilder: Sets timeFractionalDigits.
timeout(Integer) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets timeout.
timestamp() - Method in interface io.jstach.rainbowgum.LogEvent: Timestamp when the event was created.
timestamp() - Method in interface io.jstach.rainbowgum.LogEventFactory: Timestamp to use for the next event created by this factory.
timestamp(LogFormatter) - Method in class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Sets required timestamp.
timestamp(String) - Method in class io.jstach.rainbowgum.format.TTLL.ColorTheme.Builder: Timestamp color.
timeStamp() - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Append the timestamp in ISO format.
timeStamp(DateTimeFormatter) - Method in class io.jstach.rainbowgum.LogFormatter.Builder: Formatter for LogEvent.timestamp() derived from standard DateTimeFormatter.
timestampFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: mutable field
timestampFormatter - Variable in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: immutable field
timestampFormatter(LogFormatter) - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter.AbstractBuilder: Sets timestamp formatter.
toBytes() - Method in class io.jstach.rainbowgum.file.DataSize: The size in bytes.
toEncoderProvider() - Method in class io.jstach.rainbowgum.format.AbstractStandardEventFormatter: Convenience to register the encoder.
toLevel(Level) - Static method in class io.jstach.rainbowgum.jul.JULBridge: Maps a java.util.logging.Level to the closest System.Logger.Level, the same threshold buckets JUL's own builtin levels (FINEST/FINE/INFO/WARNING/SEVERE) fall into, so custom intermediate levels still translate sensibly.
toString() - Method in class io.jstach.rainbowgum.disruptor.DisruptorLogPublisher
toString() - Method in class io.jstach.rainbowgum.file.DataSize: A string that DataSize.parse(String) accepts, using the largest unit that divides the size exactly, for example 10MB or 1500.
toString() - Method in record class io.jstach.rainbowgum.LogAlerts.Stats: Returns a string representation of this record class.
toString() - Method in record class io.jstach.rainbowgum.LogFormatter.StaticFormatter: Returns a string representation of this record class.
toString() - Method in record class io.jstach.rainbowgum.LogMetrics.Metric: Returns a string representation of this record class.
toString() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error: Returns a string representation of this record class.
toString() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing: Returns a string representation of this record class.
toString() - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter
toString() - Method in class io.jstach.rainbowgum.output.ListLogOutput
toString() - Method in record class io.jstach.rainbowgum.pattern.Padding: Returns a string representation of this record class.
toString() - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
toString(LogEvent.Caller) - Static method in interface io.jstach.rainbowgum.LogEvent.Caller: Convenience toString for caller.
toString(Object, String) - Static method in interface io.jstach.rainbowgum.LogReporter.Reportable: Returns a concise description of a component.
toString(System.Logger.Level) - Static method in interface io.jstach.rainbowgum.LogFormatter.LevelFormatter: Turns a Level into a SLF4J like level String that is all upper case.
total() - Method in record class io.jstach.rainbowgum.LogAlerts.Stats: Returns the value of the total record component.
totalSizeCap(DataSize) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets required totalSizeCap.
trace(String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(Marker, String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(Marker, String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(Marker, String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(Marker, String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(Marker, String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(Marker, String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(Marker, String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(Marker, String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
trace(Marker, String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
trace(Marker, String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
TRACE_ID_KEY - Static variable in class io.jstach.rainbowgum.opentelemetry.OpenTelemetryConfigurator: Key value holding the current span's trace id.
traceIdKey(String) - Method in class io.jstach.rainbowgum.otlp.OtlpJsonEncoderBuilder: Sets traceIdKey.
traceIdKey(String) - Method in class io.jstach.rainbowgum.otlp.OtlpOutputBuilder: Sets traceIdKey.
transformOrNull(LogEvent) - Method in class io.jstach.rainbowgum.LogRouter.AbstractRouter: Implement for custom filtering or transformation.
translateKey(String) - Method in enum class io.jstach.rainbowgum.LogProperties.StandardProperties: Translate the key.
Troubleshooting - Section in Overview
TRUE - Enum constant in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: Will initialize rainbow gum.
TTLL - Enum constant in enum class io.jstach.rainbowgum.format.TTLL.TimestampFormat: HH:mm:ss.SSS in UTC.
TTLL - Interface in io.jstach.rainbowgum.format: The choices for each part of the TTLL (Time, Thread, Level, Logger) format, the default text format, configured with TTLLFormatterBuilder or properties of the "ttll" encoder.
TTLL_TIME_FORMAT - Static variable in interface io.jstach.rainbowgum.LogFormatter.TimestampFormatter: The default timestamp format used in many logging frameworks which does not have dates and only time at millisecond precision.
TTLL.ColorMode - Enum Class in io.jstach.rainbowgum.format: Whether to color, see TTLL.ColorTheme for which colors.
TTLL.ColorTheme - Interface in io.jstach.rainbowgum.format: ANSI color theme, the colors used when TTLL.ColorMode decides to color.
TTLL.ColorTheme.Builder - Class in io.jstach.rainbowgum.format: Builds a TTLL.ColorTheme.
TTLL.KeyValuesFormat - Enum Class in io.jstach.rainbowgum.format: Key values part, written in braces after the logger name; see TTLL.KeyValuesWhenEmpty for events with no key values.
TTLL.KeyValuesWhenEmpty - Enum Class in io.jstach.rainbowgum.format: Whether the key values braces are written when an event has no key values.
TTLL.LevelFormat - Enum Class in io.jstach.rainbowgum.format: Level part.
TTLL.LoggerFormat - Enum Class in io.jstach.rainbowgum.format: Logger name part.
TTLL.ThreadFormat - Enum Class in io.jstach.rainbowgum.format: Thread part, written in square brackets.
TTLL.TimestampFormat - Enum Class in io.jstach.rainbowgum.format: Time part.
TTLL Formatter - Section in Overview
TTLLFormatterBuilder - Class in io.jstach.rainbowgum.format: Builder to create LogFormatter.
TTLLFormatterBuilder(String) - Constructor for class io.jstach.rainbowgum.format.TTLLFormatterBuilder: Create a builder for io.jstach.rainbowgum.LogFormatter .
Two modules: API and provider - Section in Overview
type() - Method in interface io.jstach.rainbowgum.file.FileOutput
type() - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
type() - Method in interface io.jstach.rainbowgum.LogOutput: Gross categorization of an output.
type() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
type() - Method in class io.jstach.rainbowgum.output.ListLogOutput

U

UNDERSCORE - Enum constant in enum class io.jstach.rainbowgum.json.JsonBuffer.ExtendedFieldPrefix: "_" Underscore prefix
unset() - Method in class io.jstach.rainbowgum.RainbowGum.Builder: Removes the currently set Rainbow Gum which will close it if one exists and will be replaced by the default provision process if RainbowGum.of() is called before RainbowGum.Builder.set().
UNSUPPORTED - Enum constant in enum class io.jstach.rainbowgum.LoggerAPI.Standard: A facade not represented by another constant of this enum.
uri - Variable in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput: passed in uri
uri() - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
uri() - Method in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput
uri() - Method in interface io.jstach.rainbowgum.LogOutput: The uri of the output.
uri() - Method in interface io.jstach.rainbowgum.LogProviderRef: URI of the log provider.
uri() - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
uri() - Method in class io.jstach.rainbowgum.output.ListLogOutput
uri(URI) - Method in class io.jstach.rainbowgum.file.FileOutputBuilder: Sets uri.
uri(URI) - Method in class io.jstach.rainbowgum.rolling.RollingFileOutputBuilder: Sets uri.
useGetBytes(boolean) - Method in class io.jstach.rainbowgum.LogEncoder.Builder: If set, converts to bytes with String.getBytes(Charset) on the fully formatted string instead of the default CharsetEncoder-based copy directly into a reused byte buffer.
USER - Enum constant in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: The application's own contributor, which wins over every other source including a logging facade's own context store.
User Guide - Section in Overview
Using RainbowGum Builders - Section in Overview
Using rainbowgum-simple - Section in Overview
Using Spring Boot - Section in Overview
Using System properties - Section in Overview

V

validate() - Method in class io.jstach.rainbowgum.LogProperty.Validator: Validates every result added so far via LogProperty.Validator.add(Result) or LogProperty.Validator.addIfError(Result), throwing a single exception listing all failures if one or more of them are not LogProperty.Result.Success.
validate(LogProperty.Validator) - Method in interface io.jstach.rainbowgum.LogProperty.Result: Registers this result with validator via LogProperty.Validator.add(Result) (a still-LogProperty.Result.Missing result is treated as a real failure) and returns this result unchanged, so a chain that builds a required property can register itself with a shared LogProperty.Validator and keep going in one expression - properties.forKey(key).ofString().or(fallback).validate(v) - instead of a separate var x = ...; v.add(x); statement pair.
validate(Class, List) - Static method in exception class io.jstach.rainbowgum.LogProperty.ValidationException: Validates a list of results and throws LogProperty.ValidationException if any results are not LogProperty.Result.Success.
validateIfError(LogProperty.Validator) - Method in interface io.jstach.rainbowgum.LogProperty.Result: Like LogProperty.Result.validate(Validator) but via LogProperty.Validator.addIfError(Result) instead of LogProperty.Validator.add(Result) - a LogProperty.Result.Missing result is expected and ignored, only a LogProperty.Result.Error is treated as a failure.
validateKeyParameters(String, Set) - Static method in interface io.jstach.rainbowgum.LogProperties: Validate key parameters.
validateNow(Class) - Method in interface io.jstach.rainbowgum.LogProperty.Result: Convenience for a genuine one-off, single-property validation that does not need to participate in a larger batch: builds a single-use LogProperty.Validator, registers this result with it via LogProperty.Validator.add(Result), and validates immediately - instead of registering with a caller-managed LogProperty.Validator via LogProperty.Result.validate(Validator) and deferring to a later LogProperty.Validator.validate() call.
value() - Element in annotation interface io.jstach.rainbowgum.annotation.EnumAlias: The aliases.
value() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable.ConvertParameter: Static method on target type to call to convert the parameter.
value() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable.DefaultDoc: Javadoc text for the default.
value() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable.DefaultParameter: Will use use a static field on the factory class (the class that contains the annotated LogConfigurable method) as a default value if missing from properties or not set.
value() - Element in annotation interface io.jstach.rainbowgum.annotation.LogConfigurable.KeyParameter: Use as parameter to a property name specified in LogConfigurable.prefix().
value() - Method in record class io.jstach.rainbowgum.LogMetrics.Metric: Returns the value of the value record component.
value() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error
value() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing
value() - Method in interface io.jstach.rainbowgum.LogProperty.Result.Success: Gets the value and will never fail for Success.
value() - Method in interface io.jstach.rainbowgum.LogProperty.ValidatedResult: Gets the value and will fail with NoSuchElementException if there is no value.
value(String, String) - Method in interface io.jstach.rainbowgum.LogProperties: Analogous to System.getProperty(String, String) with the exception that the fallback cannot be null and the return cannot be null.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.Json5PrettyPrint: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder.Format: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.KeyValuesPlacement: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.ColorMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesWhenEmpty: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.LoggerFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.ThreadFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.format.TTLL.TimestampFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.jfr.JfrAlertListener.Mode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.json.JsonBuffer.ExtendedFieldPrefix: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogAlerts.FailLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogAlerts.UnobservedErrorsAction: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogAlerts.UnusedKeyLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogAppender.AppenderFlag: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogAppender.AppenderType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogConfig.Globals.AnsiMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogConfig.Globals.AppenderLock: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogConfig.Globals.ThreadLocalMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogEvent.Caller.CallerType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogFormatter.KeyValueNullStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LoggerAPI.Standard: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogMessageFormatter.StandardMessageFormatter: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogOutput.ContentType.StandardContentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogOutput.OutputType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogOutput.ProvidesEncoder.Policy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogOutput.WriteMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogProperties.StandardProperties: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogReporter.Section: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogRouter.Route.Routes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.LogRouter.RouteFlag: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.otlp.EnvironmentVariables: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.output.ConsoleStream: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternConfig.CacheType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.SpringBootKey: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in record class io.jstach.rainbowgum.pattern.Padding: This method is used to parse a string such as "5", ".7", "5.7" or "-5.7" into a Padding.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher.Overflow: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.LevelFileType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.StrictType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Pass: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: Returns the enum constant of this class with the specified name.
valueOrNull() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Error
valueOrNull() - Method in record class io.jstach.rainbowgum.LogProperty.Result.Missing
valueOrNull() - Method in interface io.jstach.rainbowgum.LogProperty.Result.Success
valueOrNull() - Method in interface io.jstach.rainbowgum.LogProperty.ValidatedResult: Gets the value.
valueOrNull(T) - Method in interface io.jstach.rainbowgum.LogProperty.ValidatedResult: Gets a value if there is if not uses the fallback.
valueOrNull(String) - Method in interface io.jstach.rainbowgum.LogProperties: Analogous to System.getProperty(String).
valueOrNull(String) - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties
values() - Static method in enum class io.jstach.rainbowgum.format.Json5PrettyPrint: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.KeyValuesFormatterBuilder.Format: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.KeyValuesPlacement: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.ColorMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.KeyValuesWhenEmpty: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.LevelFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.LoggerFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.ThreadFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.format.TTLL.TimestampFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.jfr.JfrAlertListener.Mode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.json.JsonBuffer.ExtendedFieldPrefix: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.json.JsonBuffer.JSONToken: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogAlerts.FailLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogAlerts.UnobservedErrorsAction: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogAlerts.UnusedKeyLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogAppender.AppenderFlag: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogAppender.AppenderType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogConfig.ChangePublisher.ChangeType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogConfig.DebugModeType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogConfig.Globals.AnsiMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogConfig.Globals.AppenderLock: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogConfig.Globals.ThreadLocalMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogEvent.Caller.CallerType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogEventFactory.KeyValuesContributor.Source.Standard: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogFormatter.KeyValueNullStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogFormatter.NoopFormatter: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LoggerAPI.Standard: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogMessageFormatter.StandardMessageFormatter: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogMetrics.StandardMetric: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogOutput.ContentType.StandardContentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogOutput.OutputType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogOutput.ProvidesEncoder.Policy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogOutput.WriteMethod: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogProperties.StandardProperties: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogReporter.Section: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogRouter.Route.Routes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.LogRouter.RouteFlag: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.otlp.EnvironmentVariables: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.otlp.OtlpProtocol: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.output.ConsoleStream: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternConfig.CacheType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.KeywordKey: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.SpringBootKey: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.publisher.BatchSwapAsyncLogPublisher.Overflow: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.LevelFileType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.StrictType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.spi.RainbowGumServiceProvider.Pass: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.jstach.rainbowgum.systemlogger.RainbowGumSystemLoggerFinder.InitOption: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Enum constant in enum class io.jstach.rainbowgum.LogReporter.Section: Rainbow Gum's own version, printed first if included.
VERSION - Static variable in class io.jstach.rainbowgum.RainbowGumVersion: Rainbow Gum Version.
visit(String, BiFunction) - Method in interface io.jstach.rainbowgum.LogProperties: Visits this properties with visitor, by default just applying visitor to this and key directly.
visit(String, BiFunction) - Method in class io.jstach.rainbowgum.properties.ForwardingLogProperties

W

warn(Class, String) - Method in interface io.jstach.rainbowgum.LogAlerts: Records a warning alert.
warn(String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(Marker, String) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(Marker, String) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(Marker, String, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(Marker, String, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(Marker, String, Object...) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(Marker, String, Object...) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(Marker, String, Object, Object) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(Marker, String, Object, Object) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warn(Marker, String, Throwable) - Method in interface io.jstach.rainbowgum.slf4j.ForwardingLogger
warn(Marker, String, Throwable) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger
warnCounter(String, long) - Method in interface io.jstach.rainbowgum.LogMetrics: Like LogMetrics.errorCounter(String, long) but for something worth tracking yet less significant than an error - a trend worth watching rather than something that, by itself, indicates a problem.
WARNING - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.FailLevel: Fail if a warning or error alert is recorded while starting.
WARNING - Enum constant in enum class io.jstach.rainbowgum.LogAlerts.UnusedKeyLevel: Every unread key is a warning, so logging.alerts.fail=warning fails on any of them.
WATCH - Enum constant in enum class io.jstach.rainbowgum.simple.props.SimpleProperties.LevelFileType: Polls the level file, see "logging.simpleprops.levelFilePath".
Where is the Javadoc? - Section in Overview
WHITE - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI white color
with(LogProperties) - Method in class io.jstach.rainbowgum.LogProperties.AbstractBuilder: Add a fallback properties.
with(Consumer) - Method in class io.jstach.rainbowgum.LogConfig.Builder: Configures the builder with a function for ergonomics.
with(Map) - Method in class io.jstach.rainbowgum.LogProperties.MutableLogProperties.Builder: Sets the backing mutable map.
withCaller(LogEvent, LogEvent.Caller) - Static method in interface io.jstach.rainbowgum.LogEvent: Creates a new event with the caller info attached.
withDepth(int) - Method in class io.jstach.rainbowgum.slf4j.spi.AbstractFilteringLogger: A no-op: unlike AbstractLogger-based decorators, this class's caller-info depth is a fixed internal constant rather than derived from the wrap-count LoggerDecoratorService.decorate(RainbowGum, DepthAwareLogger, int) passes in, so there is nothing to recreate.
withDepth(int) - Method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareLogger: Will recreate the logger with desired depth.
withDepth(Logger, int) - Static method in interface io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService.DepthAwareLogger: Will recreate the logger with desired depth if possible.
WrappingLogger - Interface in io.jstach.rainbowgum.slf4j: A marker interface to check if it is a logger that is decorating.
write(JsonBuffer.JSONToken) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Writes a JSON token.
write(LogEvent[], int, LogEncoder) - Method in interface io.jstach.rainbowgum.LogOutput: Write a batch of events by default calls LogOutput.write(LogEvent[], int, LogEncoder, Buffer).
write(LogEvent[], int, LogEncoder, LogEncoder.Buffer) - Method in interface io.jstach.rainbowgum.LogOutput: Write a batch of events reusing the provided buffer and by default calling LogOutput.write(LogEvent, Buffer) for each event synchronously.
write(LogEvent[], int, LogEncoder, LogEncoder.Buffer) - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
write(LogEvent, byte[], int, int, LogOutput.ContentType) - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
write(LogEvent, byte[], int, int, LogOutput.ContentType) - Method in class io.jstach.rainbowgum.LogOutput.AbstractOutputStreamOutput
write(LogEvent, byte[], int, int, LogOutput.ContentType) - Method in interface io.jstach.rainbowgum.LogOutput: Analogous to OutputStream.write(byte[], int, int).
write(LogEvent, byte[], int, int, LogOutput.ContentType) - Method in class io.jstach.rainbowgum.otlp.OtlpOutput
write(LogEvent, byte[], int, int, LogOutput.ContentType) - Method in class io.jstach.rainbowgum.output.ListLogOutput
write(LogEvent, byte[], LogOutput.ContentType) - Method in interface io.jstach.rainbowgum.LogOutput: Analogous to OutputStream.write(byte[]).
write(LogEvent, LogEncoder.Buffer) - Method in interface io.jstach.rainbowgum.LogOutput: Writes a prepared buffer and by default drains the buffer to this output.
write(LogEvent, String) - Method in class io.jstach.rainbowgum.jfr.JfrLogOutput
write(LogEvent, String) - Method in interface io.jstach.rainbowgum.LogOutput: Writes a string and by default with charset StandardCharsets.UTF_8.
write(LogEvent, String) - Method in class io.jstach.rainbowgum.output.ListLogOutput
write(LogEvent, ByteBuffer, LogOutput.ContentType) - Method in interface io.jstach.rainbowgum.LogOutput: Write event with byte buffer.
write(String, String, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Writes a string field.
write(String, String, int, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Writes a string field.
writeArrayElementObjectEnd() - Method in class io.jstach.rainbowgum.json.JsonBuffer: Ends an array element object previously started with JsonBuffer.writeArrayElementObjectStart(int).
writeArrayElementObjectStart(int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Starts an anonymous JSON object as an array element (no field name), e.g. the { in [{...},{...}].
writeArrayEnd() - Method in class io.jstach.rainbowgum.json.JsonBuffer: Ends a nested JSON array previously started with JsonBuffer.writeArrayStart(String, int, int).
writeArrayStart(String, int, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Starts a nested JSON array as a field value, e.g.
writeDouble(String, double, int, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Writes a double field.
writeInt(String, int, int, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Writes a string field.
writeLineFeed() - Method in class io.jstach.rainbowgum.json.JsonBuffer: Efficiently writes a line feed.
writeLong(String, long, int, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Writes a long field.
writeMethod() - Method in interface io.jstach.rainbowgum.LogEncoder.BufferHints: The preferred write style of the output.
writeMethod() - Method in enum class io.jstach.rainbowgum.LogOutput.WriteMethod
writeObjectEnd() - Method in class io.jstach.rainbowgum.json.JsonBuffer: Ends a nested JSON object previously started with JsonBuffer.writeObjectStart(String, int, int).
writeObjectStart(String, int, int) - Method in class io.jstach.rainbowgum.json.JsonBuffer: Starts a nested JSON object as a field value, e.g.
Writing a decorator - Section in class io.jstach.rainbowgum.slf4j.spi.LoggerDecoratorService

Y

YELLOW - Enum constant in enum class io.jstach.rainbowgum.pattern.format.PatternRegistry.ColorKey: ANSI yellow color

Z

ZERO - Static variable in class io.jstach.rainbowgum.file.DataSize: Zero bytes.
zoneId() - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoder: The zone used to render @timestamp.
zoneId() - Method in interface io.jstach.rainbowgum.pattern.format.PatternConfig: Default zoneId if not specified.
zoneId(ZoneId) - Method in class io.jstach.rainbowgum.json.encoder.LogstashEncoderBuilder: Sets zoneId.
zoneId(ZoneId) - Method in class io.jstach.rainbowgum.pattern.format.PatternConfigBuilder: Sets zoneId.

_

_apply(T) - Method in interface io.jstach.rainbowgum.LogProperty.PropertyFunction: Apply that throws error.

A B C D E F G H I J K L M N O P Q R S T U V W Y Z _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form