Remove log name field (#4263)

This commit is contained in:
jack-berg 2022-03-14 18:06:52 -05:00 committed by GitHub
parent 59a6061dc5
commit ac884b12e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 0 additions and 98 deletions

View File

@ -36,10 +36,8 @@ class OtlpJsonLoggingLogExporterTest {
private static final Resource RESOURCE =
Resource.create(Attributes.builder().put("key", "value").build());
@SuppressWarnings("deprecation") // test deprecated setName method
private static final LogData LOG1 =
LogDataBuilder.create(RESOURCE, InstrumentationScopeInfo.create("instrumentation", "1", null))
.setName("testLog1")
.setBody("body1")
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
@ -53,11 +51,9 @@ class OtlpJsonLoggingLogExporterTest {
TraceState.getDefault()))
.build();
@SuppressWarnings("deprecation") // test deprecated setName method
private static final LogData LOG2 =
LogDataBuilder.create(
RESOURCE, InstrumentationScopeInfo.create("instrumentation2", "2", null))
.setName("testLog2")
.setBody("body2")
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
@ -112,7 +108,6 @@ class OtlpJsonLoggingLogExporterTest {
+ " \"timeUnixNano\":\"1631533710000000\",\n"
+ " \"severityNumber\":\"SEVERITY_NUMBER_INFO\",\n"
+ " \"severityText\":\"INFO\",\n"
+ " \"name\":\"testLog2\",\n"
+ " \"body\":{\n"
+ " \"stringValue\":\"body2\"\n"
+ " },\n"
@ -139,7 +134,6 @@ class OtlpJsonLoggingLogExporterTest {
+ " \"timeUnixNano\":\"1631533710000000\",\n"
+ " \"severityNumber\":\"SEVERITY_NUMBER_INFO\",\n"
+ " \"severityText\":\"INFO\",\n"
+ " \"name\":\"testLog1\",\n"
+ " \"body\":{\n"
+ " \"stringValue\":\"body1\"\n"
+ " },\n"

View File

@ -330,11 +330,9 @@ class OtlpHttpLogExporterTest {
return HttpResponse.of(httpStatus, APPLICATION_PROTOBUF, message.toByteArray());
}
@SuppressWarnings("deprecation") // test deprecated setName method
private static LogData generateFakeLog() {
return LogDataBuilder.create(
Resource.getDefault(), InstrumentationScopeInfo.create("testLib", "1.0", "http://url"))
.setName("log-name")
.setBody("log body")
.setAttributes(Attributes.builder().put("key", "value").build())
.setSeverity(Severity.INFO)

View File

@ -28,7 +28,6 @@ final class LogMarshaler extends MarshalerWithSize {
private final long timeUnixNano;
private final ProtoEnumInfo severityNumber;
private final byte[] severityText;
private final byte[] nameUtf8;
private final MarshalerWithSize anyValueMarshaler;
private final KeyValueMarshaler[] attributeMarshalers;
private final int droppedAttributesCount;
@ -36,7 +35,6 @@ final class LogMarshaler extends MarshalerWithSize {
@Nullable private final String traceId;
@Nullable private final String spanId;
@SuppressWarnings("deprecation") // name field to be removed
static LogMarshaler create(io.opentelemetry.sdk.logs.data.LogData logData) {
KeyValueMarshaler[] attributeMarshalers =
KeyValueMarshaler.createRepeated(logData.getAttributes());
@ -50,7 +48,6 @@ final class LogMarshaler extends MarshalerWithSize {
logData.getEpochNanos(),
toProtoSeverityNumber(logData.getSeverity()),
MarshalerUtil.toBytes(logData.getSeverityText()),
MarshalerUtil.toBytes(logData.getName()),
anyValueMarshaler,
attributeMarshalers,
// TODO (trask) implement droppedAttributesCount in LogRecord
@ -64,7 +61,6 @@ final class LogMarshaler extends MarshalerWithSize {
long timeUnixNano,
ProtoEnumInfo severityNumber,
byte[] severityText,
byte[] nameUtf8,
MarshalerWithSize anyValueMarshaler,
KeyValueMarshaler[] attributeMarshalers,
int droppedAttributesCount,
@ -76,7 +72,6 @@ final class LogMarshaler extends MarshalerWithSize {
timeUnixNano,
severityNumber,
severityText,
nameUtf8,
anyValueMarshaler,
attributeMarshalers,
droppedAttributesCount,
@ -89,7 +84,6 @@ final class LogMarshaler extends MarshalerWithSize {
this.traceFlags = traceFlags;
this.severityNumber = severityNumber;
this.severityText = severityText;
this.nameUtf8 = nameUtf8;
this.anyValueMarshaler = anyValueMarshaler;
this.attributeMarshalers = attributeMarshalers;
this.droppedAttributesCount = droppedAttributesCount;
@ -103,8 +97,6 @@ final class LogMarshaler extends MarshalerWithSize {
output.serializeString(LogRecord.SEVERITY_TEXT, severityText);
output.serializeString(LogRecord.NAME, nameUtf8);
output.serializeMessage(LogRecord.BODY, anyValueMarshaler);
output.serializeRepeatedMessage(LogRecord.ATTRIBUTES, attributeMarshalers);
@ -119,7 +111,6 @@ final class LogMarshaler extends MarshalerWithSize {
long timeUnixNano,
ProtoEnumInfo severityNumber,
byte[] severityText,
byte[] nameUtf8,
MarshalerWithSize anyValueMarshaler,
KeyValueMarshaler[] attributeMarshalers,
int droppedAttributesCount,
@ -133,8 +124,6 @@ final class LogMarshaler extends MarshalerWithSize {
size += MarshalerUtil.sizeBytes(LogRecord.SEVERITY_TEXT, severityText);
size += MarshalerUtil.sizeBytes(LogRecord.NAME, nameUtf8);
size += MarshalerUtil.sizeMessage(LogRecord.BODY, anyValueMarshaler);
size += MarshalerUtil.sizeRepeatedMessage(LogRecord.ATTRIBUTES, attributeMarshalers);

View File

@ -46,11 +46,9 @@ class LogsRequestMarshalerTest {
private static final String TRACE_ID = TraceId.fromBytes(TRACE_ID_BYTES);
private static final byte[] SPAN_ID_BYTES = new byte[] {0, 0, 0, 0, 4, 3, 2, 1};
private static final String SPAN_ID = SpanId.fromBytes(SPAN_ID_BYTES);
private static final String NAME = "GET /api/endpoint";
private static final String BODY = "Hello world from this log...";
@Test
@SuppressWarnings("deprecation") // test deprecated setName method
void toProtoResourceLogs() {
ResourceLogsMarshaler[] resourceLogsMarshalers =
ResourceLogsMarshaler.create(
@ -58,7 +56,6 @@ class LogsRequestMarshalerTest {
LogDataBuilder.create(
Resource.builder().put("one", 1).setSchemaUrl("http://url").build(),
InstrumentationScopeInfo.create("testLib", "1.0", "http://url"))
.setName(NAME)
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
@ -84,7 +81,6 @@ class LogsRequestMarshalerTest {
}
@Test
@SuppressWarnings("deprecation") // test deprecated setName method
void toProtoLogRecord() {
LogRecord logRecord =
parse(
@ -93,7 +89,6 @@ class LogsRequestMarshalerTest {
LogDataBuilder.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationScopeInfo.create("instrumentation", "1", null))
.setName(NAME)
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
@ -106,7 +101,6 @@ class LogsRequestMarshalerTest {
assertThat(logRecord.getTraceId().toByteArray()).isEqualTo(TRACE_ID_BYTES);
assertThat(logRecord.getSpanId().toByteArray()).isEqualTo(SPAN_ID_BYTES);
assertThat(logRecord.getName()).isEqualTo(NAME);
assertThat(logRecord.getSeverityText()).isEqualTo("INFO");
assertThat(logRecord.getBody()).isEqualTo(AnyValue.newBuilder().setStringValue(BODY).build());
assertThat(logRecord.getAttributesList())
@ -118,7 +112,6 @@ class LogsRequestMarshalerTest {
assertThat(logRecord.getTimeUnixNano()).isEqualTo(12345);
}
@SuppressWarnings("deprecation") // name field has been deprecated
@Test
void toProtoLogRecord_MinimalFields() {
LogRecord logRecord =
@ -133,7 +126,6 @@ class LogsRequestMarshalerTest {
assertThat(logRecord.getTraceId()).isEmpty();
assertThat(logRecord.getSpanId()).isEmpty();
assertThat(logRecord.getName()).isBlank();
assertThat(logRecord.getSeverityText()).isBlank();
assertThat(logRecord.getSeverityNumber().getNumber())
.isEqualTo(Severity.UNDEFINED_SEVERITY_NUMBER.getSeverityNumber());

View File

@ -104,7 +104,6 @@ class OtlpGrpcLogExporterTest extends AbstractGrpcTelemetryExporterTest<LogData,
}
@Override
@SuppressWarnings("deprecation") // test deprecated setName method
protected LogData generateFakeTelemetry() {
return LogDataBuilder.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
@ -112,7 +111,6 @@ class OtlpGrpcLogExporterTest extends AbstractGrpcTelemetryExporterTest<LogData,
.setEpoch(Instant.now())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build();

View File

@ -105,7 +105,6 @@ class OtlpGrpcNettyLogExporterTest
}
@Override
@SuppressWarnings("deprecation") // test deprecated setName method
protected LogData generateFakeTelemetry() {
return LogDataBuilder.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
@ -113,7 +112,6 @@ class OtlpGrpcNettyLogExporterTest
.setEpoch(Instant.now())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build();

View File

@ -94,7 +94,6 @@ class OtlpGrpcNettyShadedLogExporterTest
}
@Override
@SuppressWarnings("deprecation") // test deprecated setName method
protected LogData generateFakeTelemetry() {
return LogDataBuilder.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
@ -102,7 +101,6 @@ class OtlpGrpcNettyShadedLogExporterTest
.setEpoch(Instant.now())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build();

View File

@ -94,7 +94,6 @@ class OtlpGrpcNettyOkHttpLogExporterTest
}
@Override
@SuppressWarnings("deprecation") // test deprecated setName method
protected LogData generateFakeTelemetry() {
return LogDataBuilder.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
@ -102,7 +101,6 @@ class OtlpGrpcNettyOkHttpLogExporterTest
.setEpoch(Instant.now())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build();

View File

@ -373,13 +373,11 @@ abstract class OtlpExporterIntegrationTest {
testLogExporter(otlpHttpLogExporter);
}
@SuppressWarnings("deprecation") // test deprecated setName method
private static void testLogExporter(LogExporter logExporter) {
LogData logData =
LogDataBuilder.create(
RESOURCE,
InstrumentationScopeInfo.create(OtlpExporterIntegrationTest.class.getName()))
.setName("log-name")
.setBody("log body")
.setAttributes(Attributes.builder().put("key", "value").build())
.setSeverity(Severity.DEBUG)
@ -417,7 +415,6 @@ abstract class OtlpExporterIntegrationTest {
assertThat(ilLogs.getLogRecordsCount()).isEqualTo(1);
io.opentelemetry.proto.logs.v1.LogRecord protoLog = ilLogs.getLogRecords(0);
assertThat(protoLog.getName()).isEqualTo("log-name");
assertThat(protoLog.getBody().getStringValue()).isEqualTo("log body");
assertThat(protoLog.getAttributesList())
.isEqualTo(

View File

@ -111,21 +111,6 @@ public class LogDataAssert extends AbstractAssert<LogDataAssert, LogData> {
return this;
}
/** Asserts the log has the given name. */
@Deprecated
public LogDataAssert hasName(String name) {
isNotNull();
if (!name.equals(actual.getName())) {
failWithActualExpectedAndMessage(
actual.getName(),
name,
"Expected log to have name <%s> but was <%s>",
name,
actual.getName());
}
return this;
}
/** Asserts the log has the given body. */
public LogDataAssert hasBody(String body) {
isNotNull();

View File

@ -43,7 +43,6 @@ public class LogAssertionsTest {
.put("coins", 0.01, 0.05, 0.1)
.build();
@SuppressWarnings("deprecation") // test deprecated setName method
private static final LogData LOG_DATA =
LogDataBuilder.create(RESOURCE, INSTRUMENTATION_SCOPE_INFO)
.setEpoch(100, TimeUnit.NANOSECONDS)
@ -52,13 +51,11 @@ public class LogAssertionsTest {
TRACE_ID, SPAN_ID, TraceFlags.getDefault(), TraceState.getDefault()))
.setSeverity(Severity.INFO)
.setSeverityText("info")
.setName("name")
.setBody("message")
.setAttributes(ATTRIBUTES)
.build();
@Test
@SuppressWarnings("deprecation") // test deprecated hasName method
void passing() {
assertThat(LOG_DATA)
.hasResource(RESOURCE)
@ -68,7 +65,6 @@ public class LogAssertionsTest {
SpanContext.create(TRACE_ID, SPAN_ID, TraceFlags.getDefault(), TraceState.getDefault()))
.hasSeverity(Severity.INFO)
.hasSeverityText("info")
.hasName("name")
.hasBody("message")
.hasAttributes(ATTRIBUTES)
.hasAttributes(
@ -115,7 +111,6 @@ public class LogAssertionsTest {
}
@Test
@SuppressWarnings("deprecation") // test deprecated hasName method
void failure() {
assertThatThrownBy(() -> assertThat(LOG_DATA).hasResource(Resource.empty()));
assertThatThrownBy(
@ -132,7 +127,6 @@ public class LogAssertionsTest {
TraceState.getDefault())));
assertThatThrownBy(() -> assertThat(LOG_DATA).hasSeverity(Severity.DEBUG));
assertThatThrownBy(() -> assertThat(LOG_DATA).hasSeverityText("warning"));
assertThatThrownBy(() -> assertThat(LOG_DATA).hasName("foo"));
assertThatThrownBy(() -> assertThat(LOG_DATA).hasBody("bar"));
assertThatThrownBy(() -> assertThat(LOG_DATA).hasAttributes(Attributes.empty()))
.isInstanceOf(AssertionError.class);

View File

@ -34,9 +34,6 @@ public interface LogBuilder {
/** Set the severity text. */
LogBuilder setSeverityText(String severityText);
/** Set the name. */
LogBuilder setName(String name);
/** Set the body string. */
LogBuilder setBody(String body);

View File

@ -56,13 +56,6 @@ final class SdkLogBuilder implements LogBuilder {
return this;
}
@Override
@Deprecated
public LogBuilder setName(String name) {
logDataBuilder.setName(name);
return this;
}
@Override
public LogBuilder setBody(String body) {
logDataBuilder.setBody(body);

View File

@ -50,15 +50,6 @@ public interface LogData {
@Nullable
String getSeverityText();
/**
* Returns the name for this log, or null if unset.
*
* @deprecated will be removed without replacement.
*/
@Deprecated
@Nullable
String getName();
/** Returns the body for this log, or {@link Body#empty()} if unset. */
Body getBody();

View File

@ -27,7 +27,6 @@ public final class LogDataBuilder {
private SpanContext spanContext = SpanContext.getInvalid();
private Severity severity = Severity.UNDEFINED_SEVERITY_NUMBER;
@Nullable private String severityText;
@Nullable private String name;
private Body body = Body.empty();
private final Clock clock;
private Attributes attributes = Attributes.empty();
@ -117,17 +116,6 @@ public final class LogDataBuilder {
return this;
}
/**
* Set the name.
*
* @deprecated will be removed without replacement.
*/
@Deprecated
public LogDataBuilder setName(String name) {
this.name = name;
return this;
}
/** Set the body string. */
public LogDataBuilder setBody(String body) {
this.body = Body.string(body);
@ -152,7 +140,6 @@ public final class LogDataBuilder {
spanContext,
severity,
severityText,
name,
body,
attributes);
}

View File

@ -16,7 +16,6 @@ import javax.annotation.concurrent.Immutable;
@AutoValue
@AutoValue.CopyAnnotations
@Immutable
@SuppressWarnings("deprecation") // name field to be removed
abstract class LogDataImpl implements LogData {
LogDataImpl() {}
@ -28,7 +27,6 @@ abstract class LogDataImpl implements LogData {
SpanContext spanContext,
Severity severity,
@Nullable String severityText,
@Nullable String name,
Body body,
Attributes attributes) {
return new AutoValue_LogDataImpl(
@ -38,7 +36,6 @@ abstract class LogDataImpl implements LogData {
spanContext,
severity,
severityText,
name,
body,
attributes);
}

View File

@ -25,10 +25,8 @@ import org.junit.jupiter.api.Test;
class SdkLogBuilderTest {
@Test
@SuppressWarnings("deprecation") // test deprecated setName method
void buildAndEmit() {
Instant now = Instant.now();
String name = "skippy";
String bodyStr = "body";
String sevText = "sevText";
Severity severity = Severity.DEBUG3;
@ -56,8 +54,6 @@ class SdkLogBuilderTest {
verify(delegate).setAttributes(attrs);
builder.setContext(context);
verify(delegate).setContext(context);
builder.setName(name);
verify(delegate).setName(name);
builder.setSeverity(severity);
verify(delegate).setSeverity(severity);
builder.setSeverityText(sevText);