Package io.opentelemetry.sdk.logs.data

Interface LogRecordData

@Immutable public interface LogRecordData
Log definition as described in OpenTelemetry Log Data Model.
Since:
1.27.0

  • Method Summary

    Modifier and Type
    Method
    Description
    io.opentelemetry.api.common.Attributes
    getAttributes()
    Returns the attributes for this log, or Attributes.empty() if unset.
    Body
    getBody()
    Deprecated.
    Use getBodyValue() instead.
    default io.opentelemetry.api.common.Value<?>
    getBodyValue()
    Returns the Value representation of the log body, of null if unset.
    default String
    getEventName()
    Returns the event name, or null if none is set.
    io.opentelemetry.sdk.common.InstrumentationScopeInfo
    getInstrumentationScopeInfo()
    Returns the instrumentation scope that generated this log.
    long
    getObservedTimestampEpochNanos()
    Returns the timestamp at which the log record was observed, in epoch nanos.
    io.opentelemetry.sdk.resources.Resource
    getResource()
    Returns the resource of this log.
    io.opentelemetry.api.logs.Severity
    getSeverity()
    Returns the severity for this log, or Severity.UNDEFINED_SEVERITY_NUMBER if unset.
    String
    getSeverityText()
    Returns the severity text for this log, or null if unset.
    io.opentelemetry.api.trace.SpanContext
    getSpanContext()
    Return the span context for this log, or SpanContext.getInvalid() if unset.
    long
    getTimestampEpochNanos()
    Returns the timestamp at which the log record occurred, in epoch nanos.
    int
    getTotalAttributeCount()
    Returns the total number of attributes that were recorded on this log.

  • Method Details

    • getResource

      io.opentelemetry.sdk.resources.Resource getResource()
      Returns the resource of this log.

    • getInstrumentationScopeInfo

      io.opentelemetry.sdk.common.InstrumentationScopeInfo getInstrumentationScopeInfo()
      Returns the instrumentation scope that generated this log.

    • getTimestampEpochNanos

      long getTimestampEpochNanos()
      Returns the timestamp at which the log record occurred, in epoch nanos.

    • getObservedTimestampEpochNanos

      long getObservedTimestampEpochNanos()
      Returns the timestamp at which the log record was observed, in epoch nanos.

    • getSpanContext

      io.opentelemetry.api.trace.SpanContext getSpanContext()
      Return the span context for this log, or SpanContext.getInvalid() if unset.

    • getSeverity

      io.opentelemetry.api.logs.Severity getSeverity()
      Returns the severity for this log, or Severity.UNDEFINED_SEVERITY_NUMBER if unset.

    • getSeverityText

      @Nullable String getSeverityText()
      Returns the severity text for this log, or null if unset.

    • getBody

      @Deprecated Body getBody()
      Deprecated.
      Use getBodyValue() instead.
      Returns the body for this log, or Body.empty() if unset.

      If the body has been set to some ValueType other than ValueType.STRING, this will return a Body with a string representation of the Value.

    • getBodyValue

      @Nullable default io.opentelemetry.api.common.Value<?> getBodyValue()
      Returns the Value representation of the log body, of null if unset.
      Since:
      1.42.0

    • getAttributes

      io.opentelemetry.api.common.Attributes getAttributes()
      Returns the attributes for this log, or Attributes.empty() if unset.

    • getTotalAttributeCount

      int getTotalAttributeCount()
      Returns the total number of attributes that were recorded on this log.

      This number may be larger than the number of attributes that are attached to this log, if the total number recorded was greater than the configured maximum value. See LogLimits.getMaxNumberOfAttributes().

    • getEventName

      @Nullable default String getEventName()
      Returns the event name, or null if none is set.
      Since:
      1.50.0