Interface LogClient
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
BatchingLogClient
Sends log records to the service in the background. Implemented by
BatchingLogClient.-
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Flushes and shuts down; idempotent.Asynchronousclose().voidflush()Exports everything queued now, waiting at most the export timeout.voidExports everything queued now.flushAsync(Duration timeout) Asynchronousflush(Duration).default Loggerlogger()Returns a logger facade without a name.default LoggerReturns a named logger facade.default LoggerReturns a named logger facade with fixed attributes.voidEnqueues one record or input.voidsendBatch(Collection<? extends LogEntry> entries) Enqueues several records or inputs.stats()Current counters.
-
Method Details
-
send
Enqueues one record or input. Applies redaction and defaults (timestamp = now, resource from the client, trace correlation for inputs when a span is active). Never throws for a full queue or a closed client; the record is dropped and counted instead. -
sendBatch
Enqueues several records or inputs.- Parameters:
entries- records or inputs
-
flush
void flush()Exports everything queued now, waiting at most the export timeout. -
flush
Exports everything queued now.- Parameters:
timeout- maximum wait
-
flushAsync
Asynchronousflush(Duration).- Parameters:
timeout- maximum wait- Returns:
- completes when the queued records were exported
-
close
void close()Flushes and shuts down; idempotent.- Specified by:
closein interfaceAutoCloseable
-
closeAsync
CompletableFuture<Void> closeAsync()Asynchronousclose().- Returns:
- completes when the client is closed
-
stats
BatchStats stats()Current counters.- Returns:
- stats
-
logger
Returns a logger facade without a name.- Returns:
- logger (minimum severity INFO)
-
logger
Returns a named logger facade.- Parameters:
name- logger name (attributelogger.name)- Returns:
- logger (minimum severity INFO)
-
logger
Returns a named logger facade with fixed attributes.- Parameters:
name- logger name (attributelogger.name; empty for none)attributes- attributes added to every record- Returns:
- logger (minimum severity INFO)
-