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

CUSTCOM-70 Fixed jersey-client issues with embedded distros of Payara #4443

Merged
merged 1 commit into from
Jan 22, 2020
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
@@ -1,7 +1,7 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2017-2019 Payara Foundation and/or its affiliates. All rights reserved.
* Copyright (c) 2017-2020 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
Expand Down Expand Up @@ -42,7 +42,6 @@
import fish.payara.notification.requesttracing.RequestTraceSpan;
import fish.payara.nucleus.requesttracing.RequestTracingService;
import fish.payara.nucleus.requesttracing.domain.PropagationHeaders;
import fish.payara.opentracing.OpenTracingService;
import io.opentracing.Scope;
import io.opentracing.Span;
import io.opentracing.SpanContext;
Expand All @@ -51,11 +50,6 @@
import io.opentracing.propagation.Format;
import io.opentracing.propagation.TextMap;
import io.opentracing.tag.Tags;
import org.glassfish.api.invocation.InvocationManager;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.Globals;

import javax.annotation.PostConstruct;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.client.ClientResponseContext;
Expand All @@ -80,30 +74,13 @@
* @author Andrew Pielage
*/
public class JaxrsClientRequestTracingFilter implements ClientRequestFilter, ClientResponseFilter {
public static String REQUEST_CONTEXT_TRACING_PREDICATE = "fish.payara.requesttracing.jaxrs.client.TracingPredicate";

private ServiceLocator serviceLocator;
private RequestTracingService requestTracing;
private OpenTracingService openTracing;
public static final String REQUEST_CONTEXT_TRACING_PREDICATE = "fish.payara.requesttracing.jaxrs.client.TracingPredicate";

/**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part caused problems with embedded.

* Initialises the service variables.
*/
@PostConstruct
public void postConstruct() {
// Get the default Payara service locator - injecting a service locator will give you the one used by Jersey
serviceLocator = Globals.getDefaultBaseServiceLocator();

// Initialise service variables
if (serviceLocator != null) {
requestTracing = serviceLocator.getService(RequestTracingService.class);
openTracing = serviceLocator.getService(OpenTracingService.class);
}
}

// Before method invocation
@Override
public void filter(ClientRequestContext requestContext) throws IOException {
final PayaraTracingServices payaraTracingServices = new PayaraTracingServices();
final RequestTracingService requestTracing = payaraTracingServices.getRequestTracingService();
if (requestTracing != null && requestTracing.isRequestTracingEnabled()) {
// ***** Request Tracing Service Instrumentation *****
// If there is a trace in progress, add the propagation headers with the relevant details
Expand Down Expand Up @@ -131,13 +108,12 @@ public void filter(ClientRequestContext requestContext) throws IOException {
}
}
}

// ***** OpenTracing Instrumentation *****
// Check if we should trace this client call
if (shouldTrace(requestContext)) {
// Get or create the tracer instance for this application
Tracer tracer = openTracing.getTracer(openTracing.getApplicationName(
Globals.getDefaultBaseServiceLocator().getService(InvocationManager.class)));
final Tracer tracer = payaraTracingServices.getActiveTracer();

// Build a span with the required MicroProfile Opentracing tags
SpanBuilder spanBuilder = tracer.buildSpan(requestContext.getMethod())
Expand Down Expand Up @@ -181,24 +157,22 @@ public void filter(ClientRequestContext requestContext) throws IOException {
// After method invocation
@Override
public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
final PayaraTracingServices payaraTracingServices = new PayaraTracingServices();
final RequestTracingService requestTracing = payaraTracingServices.getRequestTracingService();
// If request tracing is enabled, and there's a trace actually in progress, add info about method
if (requestTracing != null && requestTracing.isRequestTracingEnabled()
&& shouldTrace(requestContext)) {
if (requestTracing != null && requestTracing.isRequestTracingEnabled() && shouldTrace(requestContext)) {
// Get the active span from the application's tracer instance
try (Scope activeScope = openTracing.getTracer(openTracing.getApplicationName(
serviceLocator.getService(InvocationManager.class)))
.scopeManager().active()) {

try (Scope activeScope = payaraTracingServices.getActiveTracer().scopeManager().active()) {
if (activeScope == null) {
// This should really only occur when enabling request tracing due to the nature of the
// This should really only occur when enabling request tracing due to the nature of the
// service not being enabled when making the request to enable it, and then
// obviously being enabled on the return. Any other entrance into here is likely a bug
// caused by a tracing context not being propagated.
Logger.getLogger(JaxrsClientRequestTracingFilter.class.getName()).log(Level.FINE,
"activeScope in opentracing request tracing filter was null for {0}", responseContext);
return;
}

Span activeSpan = activeScope.span();
// Get the response status and add it to the active span
StatusType statusInfo = responseContext.getStatusInfo();
Expand All @@ -215,15 +189,11 @@ && shouldTrace(requestContext)) {
}

private boolean shouldTrace(ClientRequestContext requestContext) {
boolean shouldTrace = true;

Object traceFilter = requestContext.getConfiguration().getProperty(REQUEST_CONTEXT_TRACING_PREDICATE);

if (traceFilter instanceof Predicate) {
return ((Predicate<ClientRequestContext>) traceFilter).test(requestContext);
} else {
return true;
}
return true;
}

/**
Expand All @@ -235,7 +205,7 @@ private class MultivaluedMapToTextMap implements TextMap {

/**
* Initialises this object with the MultivaluedMap to wrap.
*
*
* @param map The MultivaluedMap to convert to a TextMap
*/
public MultivaluedMapToTextMap(MultivaluedMap<String, Object> map) {
Expand All @@ -245,7 +215,7 @@ public MultivaluedMapToTextMap(MultivaluedMap<String, Object> map) {
@Override
public Iterator<Map.Entry<String, String>> iterator() {
return new MultiValuedMapStringIterator(map.entrySet());

}

@Override
Expand All @@ -254,18 +224,18 @@ public void put(String key, String value) {
}

}

private class MultiValuedMapStringIterator implements Iterator<Map.Entry<String, String>> {

private final Iterator<Map.Entry<String, List<Object>>> mapIterator;

private Map.Entry<String, List<Object>> mapEntry;
private Iterator<Object> mapEntryIterator;

public MultiValuedMapStringIterator(Set<Map.Entry<String, List<Object>>> entrySet){
mapIterator = entrySet.iterator();
}

@Override
public boolean hasNext() {
// True if the MapEntry (value) is not equal to null and has another value, or if there is another key
Expand All @@ -282,12 +252,11 @@ public Map.Entry<String, String> next() {
// Return either the next map entry with toString, or an entry with no value if there isn't one
if (mapEntryIterator.hasNext()) {
return new AbstractMap.SimpleImmutableEntry<>(mapEntry.getKey(), mapEntryIterator.next().toString());
} else {
return new AbstractMap.SimpleImmutableEntry<>(mapEntry.getKey(), null);
}
return new AbstractMap.SimpleImmutableEntry<>(mapEntry.getKey(), null);
}


}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2020 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/

package fish.payara.requesttracing.jaxrs.client;

import fish.payara.nucleus.requesttracing.RequestTracingService;
import fish.payara.opentracing.OpenTracingService;

import io.opentracing.Tracer;

import org.glassfish.api.invocation.InvocationManager;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.Globals;

/**
* This is a class hiding internal mechanism of lookup of HK2 services.
* The lookup is lazy, done with first request, but this may be simply changed later.
* <p>
* The lazy lookup prevents problems with embedded distributions, when jersey lookups
* may detect filters in this package and try to use them before Payara started, which
* is not supported use case.
*
* @author David Matejcek
*/
public final class PayaraTracingServices {

private static volatile boolean initialized;

private static ServiceLocator basicServiceLocator;
private static RequestTracingService requestTracingService;
private static OpenTracingService openTracingService;


private static void checkInitialized() {
if (initialized) {
return;
}
synchronized (PayaraTracingServices.class) {
if (initialized) {
return;
}
basicServiceLocator = Globals.getStaticBaseServiceLocator();
requestTracingService = basicServiceLocator.getService(RequestTracingService.class);
openTracingService = basicServiceLocator.getService(OpenTracingService.class);
initialized = true;
}
}


/**
* @return default service locator, same as {@link Globals#getStaticBaseServiceLocator()}.
*/
public ServiceLocator getBasicServiceLocator() {
checkInitialized();
return basicServiceLocator;
}


/**
* @return {@link RequestTracingService}
*/
public RequestTracingService getRequestTracingService() {
checkInitialized();
return requestTracingService;
}


/**
* @return {@link OpenTracingService}
*/
public OpenTracingService getOpenTracingService() {
checkInitialized();
return openTracingService;
}


/**
* @return {@link InvocationManager}
*/
public InvocationManager getInvocationManager() {
checkInitialized();
return basicServiceLocator.getService(InvocationManager.class);
}


/**
* @return application name known to the actual {@link InvocationManager}.
*/
public String getApplicationName() {
final InvocationManager invocationManager = getInvocationManager();
if (invocationManager == null) {
return null;
}
final OpenTracingService otService = getOpenTracingService();
return otService == null ? null : otService.getApplicationName(invocationManager);
}


/**
* @return actually active {@link Tracer} for the current application.
*/
public Tracer getActiveTracer() {
final String applicationName = getApplicationName();
if (applicationName == null) {
return null;
}
final OpenTracingService otService = getOpenTracingService();
if (otService == null) {
return null;
}
return otService.getTracer(applicationName);
}
}
Loading