org.apache.cxf.tracing.micrometer.AbstractObservationClientProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cxf-integration-tracing-micrometer Show documentation
Apache CXF Observability using Micrometer Observation
There is a newer version: 4.1.0
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.cxf.tracing.micrometer;

import java.util.function.Consumer;
import java.util.logging.Logger;

import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.phase.PhaseInterceptorChain;
import org.apache.cxf.tracing.AbstractTracingProvider;

import io.micrometer.common.lang.Nullable;
import io.micrometer.observation.Observation;
import io.micrometer.observation.ObservationRegistry;

public abstract class AbstractObservationClientProvider extends AbstractTracingProvider {
    protected static final Logger LOG = LogUtils.getL7dLogger(AbstractObservationClientProvider.class);
    protected static final String OBSERVATION_SCOPE = "org.apache.cxf.tracing.client.micrometer.observation";

    private final ObservationRegistry observationRegistry;

    public AbstractObservationClientProvider() {
        this(ObservationRegistry.NOOP);
    }

    public AbstractObservationClientProvider(final ObservationRegistry observationRegistry) {
        this.observationRegistry = observationRegistry;
    }

    protected TraceScopeHolder startScopedObservation(final Observation observation) {

        // In case of asynchronous client invocation, the span should be detached as JAX-RS
        // client request / response filters are going to be executed in different threads.
        Observation.Scope scope = null;
        if (!isAsyncInvocation()) {
            scope = observation.openScope();
        }

        return new TraceScopeHolder<>(new ObservationScope(observation, scope), scope == null /* detached */);
    }

    private boolean isAsyncInvocation() {
        return !PhaseInterceptorChain.getCurrentMessage().getExchange().isSynchronous();

    }

    protected void stopTraceSpan(final TraceScopeHolder holder, 
                                 @Nullable Exception ex, 
                                 Consumer addResponse) {
        if (holder == null) {
            return;
        }

        final ObservationScope observationScope = holder.getScope();
        Observation.Scope scope = null;
        if (observationScope != null) {
            try {
                // If the client invocation was asynchronous , the trace span has been created
                // in another thread and should be re-attached to the current one.
                Observation observation = observationScope.getObservation();
                observation.error(ex);
                if (holder.isDetached()) {
                    scope = observation.openScope();
                }
                if (!observation.isNoop()) {
                    addResponse.accept(observation);
                }
            } finally {
                if (scope != null) {
                    scope.close(); // if this is null then obsScope will not have a null scope and vice versa
                }
                observationScope.close(); // will close the observation
            }
        }
    }

    protected ObservationRegistry getObservationRegistry() {
        return observationRegistry;
    }
}