Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply exception type and message #3148

Merged
merged 12 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public CompletableResultCode export(Collection<LogRecordData> logs) {
itemCount = Math.round(100.0 / samplingPercentage);
}

TelemetryItem telemetryItem = mapper.map(log, stack, itemCount);
heyams marked this conversation as resolved.
Show resolved Hide resolved
TelemetryItem telemetryItem = mapper.map(log, itemCount, stack);
telemetryItemConsumer.accept(telemetryItem);

exportingLogLogger.recordSuccess();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public CompletableResultCode export(Collection<LogRecordData> logs) {
LOGGER.verbose("exporting log: {}", log);
try {
String stack = log.getAttributes().get(SemanticAttributes.EXCEPTION_STACKTRACE);
telemetryItems.add(mapper.map(log, stack, null));
telemetryItems.add(mapper.map(log, null, stack));
OPERATION_LOGGER.recordSuccess();
} catch (Throwable t) {
OPERATION_LOGGER.recordFailure(t.getMessage(), t, EXPORTER_MAPPING_ERROR);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

import com.azure.core.util.logging.ClientLogger;
import com.azure.monitor.opentelemetry.exporter.implementation.builders.AbstractTelemetryBuilder;
import com.azure.monitor.opentelemetry.exporter.implementation.builders.ExceptionDetailBuilder;
import com.azure.monitor.opentelemetry.exporter.implementation.builders.ExceptionTelemetryBuilder;
import com.azure.monitor.opentelemetry.exporter.implementation.builders.Exceptions;
import com.azure.monitor.opentelemetry.exporter.implementation.builders.MessageTelemetryBuilder;
Expand Down Expand Up @@ -100,7 +101,7 @@ public LogDataMapper(
this.telemetryInitializer = telemetryInitializer;
}

public TelemetryItem map(LogRecordData log, @Nullable String stack, @Nullable Long itemCount) {
public TelemetryItem map(LogRecordData log, @Nullable Long itemCount, @Nullable String stack) {
if (stack == null) {
return createMessageTelemetryItem(log, itemCount);
} else {
Expand Down Expand Up @@ -138,7 +139,7 @@ private TelemetryItem createMessageTelemetryItem(LogRecordData log, @Nullable Lo
}

private TelemetryItem createExceptionTelemetryItem(
LogRecordData log, @Nullable Long itemCount, String stack) {
LogRecordData log, @Nullable Long itemCount, @Nullable String stack) {
ExceptionTelemetryBuilder telemetryBuilder = ExceptionTelemetryBuilder.create();
telemetryInitializer.accept(telemetryBuilder, log.getResource());

Expand All @@ -151,7 +152,17 @@ private TelemetryItem createExceptionTelemetryItem(
Attributes attributes = log.getAttributes();
MAPPINGS.map(attributes, telemetryBuilder);

telemetryBuilder.setExceptions(Exceptions.minimalParse(stack));
List<ExceptionDetailBuilder> builders = Exceptions.minimalParse(stack);
ExceptionDetailBuilder exceptionDetailBuilder = builders.get(0);
String type = log.getAttributes().get(SemanticAttributes.EXCEPTION_TYPE);
if (type != null && !type.isEmpty()) {
exceptionDetailBuilder.setTypeName(type);
}
String message = log.getAttributes().get(SemanticAttributes.EXCEPTION_MESSAGE);
if (message != null && !message.isEmpty()) {
exceptionDetailBuilder.setMessage(message);
}
telemetryBuilder.setExceptions(builders);
telemetryBuilder.setSeverityLevel(toSeverityLevel(log.getSeverity()));

// set exception-specific properties
Expand Down
2 changes: 1 addition & 1 deletion settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ hideFromDependabot(":smoke-tests:apps:Micrometer")
hideFromDependabot(":smoke-tests:apps:MongoDB")
hideFromDependabot(":smoke-tests:apps:NonDaemonThreads")
hideFromDependabot(":smoke-tests:apps:OpenTelemetryApiSupport")
hideFromDependabot(":smoke-tests:apps:OpenTelemetryApiLogBridge")
hideFromDependabot(":smoke-tests:apps:OpenTelemetryMetric")
hideFromDependabot(":smoke-tests:apps:PreAggMetricsWithRoleNameOverridesAndSampling")
hideFromDependabot(":smoke-tests:apps:PreferForwardedUrlScheme")
Expand All @@ -133,7 +134,6 @@ hideFromDependabot(":smoke-tests:apps:RoleNameOverrides")
hideFromDependabot(":smoke-tests:apps:RuntimeAttach")
hideFromDependabot(":smoke-tests:apps:RuntimeAttachWithDelayedConnectionString")
hideFromDependabot(":smoke-tests:apps:Sampling")

hideFromDependabot(":smoke-tests:apps:SamplingOverrides")
hideFromDependabot(":smoke-tests:apps:SamplingOverridesBackCompat")
hideFromDependabot(":smoke-tests:apps:SpringBoot")
Expand Down
11 changes: 11 additions & 0 deletions smoke-tests/apps/OpenTelemetryApiLogBridge/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
plugins {
id("ai.smoke-test-war")
}

dependencies {
implementation("org.springframework.boot:spring-boot-starter-web:2.5.12") {
exclude("org.springframework.boot", "spring-boot-starter-tomcat")
}
implementation("io.opentelemetry:opentelemetry-api:1.27.0")
implementation("io.opentelemetry:opentelemetry-semconv:1.27.0-alpha")
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.applicationinsights.smoketestapp;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication
public class SpringBootApp extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder applicationBuilder) {
return applicationBuilder.sources(SpringBootApp.class);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.applicationinsights.smoketestapp;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
import java.io.PrintWriter;
import java.io.StringWriter;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

@GetMapping("/")
public String root() {
return "OK";
}

@GetMapping("/test-custom-exception-type-and-message")
public String testCustomExceptionTypeAndMessage() {
StringWriter sw = new StringWriter();
new Exception().printStackTrace(new PrintWriter(sw, true));

GlobalOpenTelemetry.get()
.getLogsBridge()
.get("my logger")
.logRecordBuilder()
.setSeverity(Severity.INFO)
.setAttribute(SemanticAttributes.EXCEPTION_TYPE, "my exception type")
.setAttribute(
SemanticAttributes.EXCEPTION_MESSAGE,
"This is an custom exception with custom exception type")
.setAttribute(SemanticAttributes.EXCEPTION_STACKTRACE, sw.toString())
.emit();
return "OK!";
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.applicationinsights.smoketest;

import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_11;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_11_OPENJ9;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_17;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_19;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_20;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_8;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_8_OPENJ9;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.WILDFLY_13_JAVA_8;
import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.WILDFLY_13_JAVA_8_OPENJ9;
import static org.assertj.core.api.Assertions.assertThat;

import com.microsoft.applicationinsights.smoketest.schemav2.Data;
import com.microsoft.applicationinsights.smoketest.schemav2.Envelope;
import com.microsoft.applicationinsights.smoketest.schemav2.ExceptionData;
import com.microsoft.applicationinsights.smoketest.schemav2.RequestData;
import java.util.List;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

@UseAgent
abstract class OpenTelemetryApiLogBridgeTest {

@RegisterExtension static final SmokeTestExtension testing = SmokeTestExtension.create();

@Test
@TargetUri("/test-custom-exception-type-and-message")
void testCustomExceptionTypeAndMessage() throws Exception {
List<Envelope> rdList = testing.mockedIngestion.waitForItems("RequestData", 1);
Envelope rdEnvelope = rdList.get(0);

RequestData rd = (RequestData) ((Data<?>) rdEnvelope.getData()).getBaseData();
assertThat(rd.getUrl())
.matches(
"http://localhost:[0-9]+/OpenTelemetryApiLogBridge/test-custom-exception-type-and-message");
assertThat(rd.getResponseCode()).isEqualTo("200");
assertThat(rd.getSuccess()).isTrue();
assertThat(rd.getSource()).isNull();
assertThat(rd.getProperties()).hasSize(1);
assertThat(rd.getProperties()).containsEntry("_MS.ProcessedByMetricExtractors", "True");

assertThat(rdEnvelope.getIKey()).isEqualTo("00000000-0000-0000-0000-0FEEDDADBEEF");
assertThat(rdEnvelope.getTags())
.hasEntrySatisfying("ai.internal.sdkVersion", v -> assertThat(v).startsWith("java:3."));

String operationId = rdEnvelope.getTags().get("ai.operation.id");
List<Envelope> edList =
testing.mockedIngestion.waitForItemsInOperation("ExceptionData", 1, operationId);
assertThat(edList.size()).isNotZero();
trask marked this conversation as resolved.
Show resolved Hide resolved
ExceptionData ed = (ExceptionData) ((Data<?>) edList.get(0).getData()).getBaseData();
assertThat(ed.getExceptions().get(0).getTypeName()).isEqualTo("my exception type");
assertThat(ed.getExceptions().get(0).getMessage())
.isEqualTo("This is an custom exception with custom exception type");
}

@Environment(TOMCAT_8_JAVA_8)
static class Tomcat8Java8Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(TOMCAT_8_JAVA_8_OPENJ9)
static class Tomcat8Java8OpenJ9Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(TOMCAT_8_JAVA_11)
static class Tomcat8Java11Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(TOMCAT_8_JAVA_11_OPENJ9)
static class Tomcat8Java11OpenJ9Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(TOMCAT_8_JAVA_17)
static class Tomcat8Java17Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(TOMCAT_8_JAVA_19)
static class Tomcat8Java19Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(TOMCAT_8_JAVA_20)
static class Tomcat8Java20Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(WILDFLY_13_JAVA_8)
static class Wildfly13Java8Test extends OpenTelemetryApiLogBridgeTest {}

@Environment(WILDFLY_13_JAVA_8_OPENJ9)
static class Wildfly13Java8OpenJ9Test extends OpenTelemetryApiLogBridgeTest {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="warn">
<appender-ref ref="CONSOLE"/>
</root>
</configuration>