Top Inners Fields Constructors Methods
io.opentelemetry.api.logs

pack-priv Class DefaultLogger

extends Object
implements Logger
Class Inheritance
All Implemented Interfaces
io.opentelemetry.api.logs.Logger
Imports
io.opentelemetry.api.common.AttributeKey, .Value, io.opentelemetry.context.Context, java.time.Instant, java.util.concurrent.TimeUnit

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DefaultLogger.NoopLogRecordBuilder

Field Summary

Modifier and TypeField and Description
private static final Logger
INSTANCE

private static final LogRecordBuilder
NOOP_LOG_RECORD_BUILDER

Constructor Summary

AccessConstructor and Description
private
DefaultLogger()

Method Summary

Modifier and TypeMethod and Description
pack-priv static Logger
getInstance()

public LogRecordBuilder
logRecordBuilder()

Implements io.opentelemetry.api.logs.Logger.logRecordBuilder.

Return a LogRecordBuilder to emit a log record.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
private static final Logger INSTANCE
NOOP_LOG_RECORD_BUILDERback to summary
private static final LogRecordBuilder NOOP_LOG_RECORD_BUILDER

Constructor Detail

DefaultLoggerback to summary
private DefaultLogger()

Method Detail

getInstanceback to summary
pack-priv static Logger getInstance()
logRecordBuilderback to summary
public LogRecordBuilder logRecordBuilder()

Implements io.opentelemetry.api.logs.Logger.logRecordBuilder.

Doc from io.opentelemetry.api.logs.Logger.logRecordBuilder.

Return a LogRecordBuilder to emit a log record.

Important Note

this should be used to write appenders to bridge logs from logging frameworks (e.g. SLF4J, Log4j, JUL, Logback, etc). It is NOT a replacement for an application logging framework, and should not be used by application developers.

Build the log record using the LogRecordBuilder setters, and emit via LogRecordBuilder#emit().

Annotations
@Override
io.opentelemetry.api.logs back to summary

private final Class DefaultLogger.NoopLogRecordBuilder

extends Object
implements LogRecordBuilder
Class Inheritance
All Implemented Interfaces
io.opentelemetry.api.logs.LogRecordBuilder

Constructor Summary

AccessConstructor and Description
private
NoopLogRecordBuilder()

Method Summary

Modifier and TypeMethod and Description
public void
emit()

Implements io.opentelemetry.api.logs.LogRecordBuilder.emit.

Emit the log record.

public <T> LogRecordBuilder
setAttribute(AttributeKey<T>
the key for this attribute.
key, T
the value for this attribute.
value)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setAttribute.

Sets an attribute on the LogRecord.

public LogRecordBuilder
setBody(String body)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setBody.

Set the body string.

public LogRecordBuilder
setBody(Value<?> body)

Overrides default io.opentelemetry.api.logs.LogRecordBuilder.setBody.

Set the body Value.

public LogRecordBuilder
setContext(Context context)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setContext.

Set the context.

public LogRecordBuilder
setObservedTimestamp(long timestamp, TimeUnit unit)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setObservedTimestamp.

Set the epoch observedTimestamp, using the timestamp and unit.

public LogRecordBuilder
setObservedTimestamp(Instant instant)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setObservedTimestamp.

Set the observedTimestamp, using the instant.

public LogRecordBuilder
setSeverity(Severity severity)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setSeverity.

Set the severity.

public LogRecordBuilder
setSeverityText(String severityText)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setSeverityText.

Set the severity text.

public LogRecordBuilder
setTimestamp(long timestamp, TimeUnit unit)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setTimestamp.

Set the epoch timestamp, using the timestamp and unit.

public LogRecordBuilder
setTimestamp(Instant instant)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setTimestamp.

Set the epoch timestamp, using the instant.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

NoopLogRecordBuilderback to summary
private NoopLogRecordBuilder()

Method Detail

emitback to summary
public void emit()

Implements io.opentelemetry.api.logs.LogRecordBuilder.emit.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.emit.

Emit the log record.

Annotations
@Override
setAttributeback to summary
public <T> LogRecordBuilder setAttribute(AttributeKey<T> key, T value)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setAttribute.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setAttribute.

Sets an attribute on the LogRecord. If the LogRecord previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters
key:AttributeKey<T>

the key for this attribute.

value:T

the value for this attribute.

Returns:LogRecordBuilder

this.

Annotations
@Override
setBodyback to summary
public LogRecordBuilder setBody(String body)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setBody.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setBody.

Set the body string.

Shorthand for calling setBody(Value) with Value#of(String).

Annotations
@Override
setBodyback to summary
public LogRecordBuilder setBody(Value<?> body)

Overrides default io.opentelemetry.api.logs.LogRecordBuilder.setBody.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setBody.

Set the body Value.

Annotations
@Override
setContextback to summary
public LogRecordBuilder setContext(Context context)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setContext.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setContext.

Set the context.

Annotations
@Override
setObservedTimestampback to summary
public LogRecordBuilder setObservedTimestamp(long timestamp, TimeUnit unit)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setObservedTimestamp.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setObservedTimestamp.

Set the epoch observedTimestamp, using the timestamp and unit.

The observedTimestamp is the time at which the log record was observed. If unset, it will be set to the timestamp. observedTimestamp may be different from timestamp if logs are being processed asynchronously (e.g. from a file or on a different thread).

Annotations
@Override
setObservedTimestampback to summary
public LogRecordBuilder setObservedTimestamp(Instant instant)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setObservedTimestamp.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setObservedTimestamp.

Set the observedTimestamp, using the instant.

The observedTimestamp is the time at which the log record was observed. If unset, it will be set to the timestamp. observedTimestamp may be different from timestamp if logs are being processed asynchronously (e.g. from a file or on a different thread).

Annotations
@Override
setSeverityback to summary
public LogRecordBuilder setSeverity(Severity severity)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setSeverity.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setSeverity.

Set the severity.

Annotations
@Override
setSeverityTextback to summary
public LogRecordBuilder setSeverityText(String severityText)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setSeverityText.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setSeverityText.

Set the severity text.

Annotations
@Override
setTimestampback to summary
public LogRecordBuilder setTimestamp(long timestamp, TimeUnit unit)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setTimestamp.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setTimestamp.

Set the epoch timestamp, using the timestamp and unit.

The timestamp is the time at which the log record occurred. If unset, it will be set to the current time when emit() is called.

Annotations
@Override
setTimestampback to summary
public LogRecordBuilder setTimestamp(Instant instant)

Implements io.opentelemetry.api.logs.LogRecordBuilder.setTimestamp.

Doc from io.opentelemetry.api.logs.LogRecordBuilder.setTimestamp.

Set the epoch timestamp, using the instant.

The timestamp is the time at which the log record occurred. If unset, it will be set to the current time when emit() is called.

Annotations
@Override