io.opentelemetry.sdk.logs.data.LogRecordData Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.logs.data;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.Value;
import io.opentelemetry.api.common.ValueType;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
import io.opentelemetry.sdk.logs.LogLimits;
import io.opentelemetry.sdk.resources.Resource;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* Log definition as described in OpenTelemetry
* Log Data Model.
*
* @since 1.27.0
*/
@Immutable
public interface LogRecordData {
/** Returns the resource of this log. */
Resource getResource();
/** Returns the instrumentation scope that generated this log. */
InstrumentationScopeInfo getInstrumentationScopeInfo();
/** Returns the timestamp at which the log record occurred, in epoch nanos. */
long getTimestampEpochNanos();
/** Returns the timestamp at which the log record was observed, in epoch nanos. */
long getObservedTimestampEpochNanos();
/** Return the span context for this log, or {@link SpanContext#getInvalid()} if unset. */
SpanContext getSpanContext();
/** Returns the severity for this log, or {@link Severity#UNDEFINED_SEVERITY_NUMBER} if unset. */
Severity getSeverity();
/** Returns the severity text for this log, or null if unset. */
@Nullable
String getSeverityText();
/**
* Returns the body for this log, or {@link Body#empty()} if unset.
*
* If the body has been set to some {@link ValueType} other than {@link ValueType#STRING}, this
* will return a {@link Body} with a string representation of the {@link Value}.
*
* @deprecated Use {@link #getBodyValue()} instead.
*/
@Deprecated
Body getBody();
/**
* Returns the {@link Value} representation of the log body, of null if unset.
*
* @since 1.42.0
*/
@Nullable
@SuppressWarnings("deprecation") // Default impl uses deprecated code for backwards compatibility
default Value getBodyValue() {
Body body = getBody();
return body.getType() == Body.Type.EMPTY ? null : Value.of(body.asString());
}
/** Returns the attributes for this log, or {@link Attributes#empty()} if unset. */
Attributes getAttributes();
/**
* 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 {@link
* LogLimits#getMaxNumberOfAttributes()}.
*/
int getTotalAttributeCount();
}