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

Reduce overhead of unsampled requests #3681

Merged
merged 3 commits into from
Jul 28, 2021
Merged
Show file tree
Hide file tree
Changes from all 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 @@ -50,7 +50,9 @@ private ServerSpanNaming(Source initialSource) {
public static void updateServerSpanName(
Context context, Source source, Supplier<String> serverSpanName) {
Span serverSpan = ServerSpan.fromContextOrNull(context);
if (serverSpan == null) {
// checking isRecording() is a helpful optimization for more expensive suppliers
// (e.g. Spring MVC instrumentation's HandlerAdapterInstrumentation)
if (serverSpan == null || !serverSpan.isRecording()) {
trask marked this conversation as resolved.
Show resolved Hide resolved
return;
}
ServerSpanNaming serverSpanNaming = context.get(CONTEXT_KEY);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

package io.opentelemetry.javaagent.instrumentation.springwebmvc;

import static io.opentelemetry.instrumentation.api.servlet.ServerSpanNaming.Source.CONTROLLER;
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
import static io.opentelemetry.javaagent.instrumentation.springwebmvc.SpringWebMvcSingletons.handlerInstrumenter;
Expand All @@ -18,6 +19,7 @@
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.instrumentation.api.servlet.ServerSpanNaming;
import io.opentelemetry.instrumentation.api.tracer.ServerSpan;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
Expand Down Expand Up @@ -69,7 +71,10 @@ public static void nameResourceAndStartSpan(
// TODO (trask) is it important to check serverSpan != null here?
if (serverSpan != null) {
// Name the parent span based on the matching pattern
ServerNameUpdater.updateServerSpanName(parentContext, request);
ServerSpanNaming.updateServerSpanName(
parentContext,
CONTROLLER,
SpringWebMvcServerSpanNaming.getServerSpanNameSupplier(parentContext, request));
// Now create a span for handler/controller execution.
context = handlerInstrumenter().start(parentContext, handler);
if (context != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@

package io.opentelemetry.javaagent.instrumentation.springwebmvc;

import static io.opentelemetry.instrumentation.api.servlet.ServerSpanNaming.Source.CONTROLLER;

import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.servlet.ServerSpanNaming;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
Expand Down Expand Up @@ -38,19 +41,20 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
return;
}

Context context = Context.current();

if (handlerMappings != null) {
try {
if (findMapping((HttpServletRequest) request)) {

// Name the parent span based on the matching pattern
// Let the parent span resource name be set with the attribute set in findMapping.
ServerNameUpdater.updateServerSpanName(context, (HttpServletRequest) request);
}
} catch (Exception ignored) {
// mapping.getHandler() threw exception. Ignore
}
Context context = Context.current();
ServerSpanNaming.updateServerSpanName(
context,
CONTROLLER,
() -> {
if (findMapping((HttpServletRequest) request)) {
// Name the parent span based on the matching pattern
// Let the parent span resource name be set with the attribute set in findMapping.
return SpringWebMvcServerSpanNaming.getServerSpanName(
context, (HttpServletRequest) request);
}
return null;
});
}

filterChain.doFilter(request, response);
Expand All @@ -64,12 +68,16 @@ public void destroy() {}
* as an attribute on the request. This attribute is read by SpringWebMvcDecorator.onRequest and
* set as the resource name.
*/
private boolean findMapping(HttpServletRequest request) throws Exception {
for (HandlerMapping mapping : handlerMappings) {
HandlerExecutionChain handler = mapping.getHandler(request);
if (handler != null) {
return true;
private boolean findMapping(HttpServletRequest request) {
try {
for (HandlerMapping mapping : handlerMappings) {
HandlerExecutionChain handler = mapping.getHandler(request);
if (handler != null) {
return true;
}
}
} catch (Exception ignored) {
// mapping.getHandler() threw exception. Ignore
}
return false;
}
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.javaagent.instrumentation.springwebmvc;

import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.servlet.ServletContextPath;
import java.util.function.Supplier;
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.servlet.HandlerMapping;

public class SpringWebMvcServerSpanNaming {

public static Supplier<String> getServerSpanNameSupplier(
Context context, HttpServletRequest request) {
return () -> getServerSpanName(context, request);
}

public static String getServerSpanName(Context context, HttpServletRequest request) {
Object bestMatchingPattern =
request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);
if (bestMatchingPattern != null) {
return ServletContextPath.prepend(context, bestMatchingPattern.toString());
}
return null;
}
}