Added new tags to the deployer
This commit is contained in:
Marcin Grzejszczak
@@ -1,137 +1,155 @@
|
||||
/*
|
||||
* Copyright 2018-2021 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.cloud.sleuth.instrument.deployer;
|
||||
|
||||
import java.time.Duration;
|
||||
import java.util.Arrays;
|
||||
import java.util.Map;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import reactor.core.publisher.Flux;
|
||||
import reactor.core.publisher.Mono;
|
||||
|
||||
import org.springframework.beans.factory.BeanFactory;
|
||||
import org.springframework.cloud.deployer.spi.app.AppDeployer;
|
||||
import org.springframework.cloud.deployer.spi.app.AppScaleRequest;
|
||||
import org.springframework.cloud.deployer.spi.app.AppStatus;
|
||||
import org.springframework.cloud.deployer.spi.app.DeploymentState;
|
||||
import org.springframework.cloud.deployer.spi.core.AppDeploymentRequest;
|
||||
import org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo;
|
||||
import org.springframework.cloud.sleuth.CurrentTraceContext;
|
||||
import org.springframework.cloud.sleuth.Span;
|
||||
import org.springframework.cloud.sleuth.Tracer;
|
||||
import org.springframework.cloud.sleuth.instrument.reactor.ReactorSleuth;
|
||||
import org.springframework.core.env.Environment;
|
||||
|
||||
/**
|
||||
* Trace representation of an {@link AppDeployer}.
|
||||
*
|
||||
* @author Marcin Grzejszczak
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public class TraceAppDeployer implements AppDeployer {
|
||||
|
||||
private static final Log log = LogFactory.getLog(TraceAppDeployer.class);
|
||||
|
||||
private final AppDeployer delegate;
|
||||
|
||||
private final BeanFactory beanFactory;
|
||||
|
||||
private final Environment environment;
|
||||
|
||||
private Tracer tracer;
|
||||
|
||||
private CurrentTraceContext currentTraceContext;
|
||||
|
||||
private Long pollDelay;
|
||||
|
||||
public TraceAppDeployer(AppDeployer delegate, BeanFactory beanFactory, Environment environment) {
|
||||
this.delegate = delegate;
|
||||
this.beanFactory = beanFactory;
|
||||
this.environment = environment;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String deploy(AppDeploymentRequest request) {
|
||||
Span.Builder spanBuilder = clientSpan("deploy");
|
||||
Span span = spanBuilder.start();
|
||||
// Span span = tracer().nextSpan().name("deploy");
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span)) {
|
||||
span.event("deployer.start");
|
||||
String id = this.delegate.deploy(request);
|
||||
span.tag("deployer.app.id", id);
|
||||
registerListener(span, id);
|
||||
return id;
|
||||
}
|
||||
}
|
||||
|
||||
private Span.Builder clientSpan(String name) {
|
||||
Span.Builder spanBuilder = tracer().spanBuilder();
|
||||
Span currentSpan = tracer().currentSpan();
|
||||
if (currentSpan != null) {
|
||||
spanBuilder.setParent(currentSpan.context());
|
||||
}
|
||||
return clientSpanKind(name, spanBuilder);
|
||||
}
|
||||
|
||||
private Span.Builder clientSpanKind(String name, Span.Builder spanBuilder) {
|
||||
return spanBuilder.kind(Span.Kind.CLIENT).name(name).remoteServiceName(remoteServiceName());
|
||||
}
|
||||
|
||||
private Span.Builder clientSpan(String name, Span parentSpan) {
|
||||
Span.Builder spanBuilder = tracer().spanBuilder();
|
||||
Span currentSpan = parentSpan != null ? parentSpan : tracer().currentSpan();
|
||||
if (currentSpan != null) {
|
||||
spanBuilder.setParent(currentSpan.context());
|
||||
}
|
||||
Map<String, String> platformSpecificInfo = environmentInfo().getPlatformSpecificInfo();
|
||||
addCfTags(spanBuilder, platformSpecificInfo);
|
||||
addK8sTags(spanBuilder, platformSpecificInfo);
|
||||
return clientSpanKind(name, spanBuilder);
|
||||
}
|
||||
|
||||
private void addCfTags(Span.Builder spanBuilder, Map<String, String> platformSpecificInfo) {
|
||||
if (platformSpecificInfo.containsKey("API Endpoint")) {
|
||||
spanBuilder.tag("deployer.platform.cf.url", platformSpecificInfo.get("API Endpoint"));
|
||||
}
|
||||
if (platformSpecificInfo.containsKey("Organization")) {
|
||||
spanBuilder.tag("deployer.platform.cf.org", platformSpecificInfo.get("Organization"));
|
||||
}
|
||||
if (platformSpecificInfo.containsKey("Space")) {
|
||||
spanBuilder.tag("deployer.platform.cf.space", platformSpecificInfo.get("Space"));
|
||||
}
|
||||
}
|
||||
|
||||
private void addK8sTags(Span.Builder spanBuilder, Map<String, String> platformSpecificInfo) {
|
||||
if (platformSpecificInfo.containsKey("master-url")) {
|
||||
spanBuilder.tag("deployer.platform.k8s.url", platformSpecificInfo.get("master-url"));
|
||||
}
|
||||
if (platformSpecificInfo.containsKey("namespace")) {
|
||||
spanBuilder.tag("deployer.platform.k8s.namespace", platformSpecificInfo.get("namespace"));
|
||||
}
|
||||
}
|
||||
|
||||
private String remoteServiceName() {
|
||||
return environmentInfo().getPlatformType();
|
||||
}
|
||||
|
||||
private void registerListener(Span span, String id) {
|
||||
PreviousAndCurrentStatus previousAndCurrentStatus = new PreviousAndCurrentStatus(span);
|
||||
/*
|
||||
* Copyright 2018-2021 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.cloud.sleuth.instrument.deployer;
|
||||
|
||||
import java.time.Duration;
|
||||
import java.util.Arrays;
|
||||
import java.util.Map;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import reactor.core.publisher.Flux;
|
||||
import reactor.core.publisher.Mono;
|
||||
|
||||
import org.springframework.beans.factory.BeanFactory;
|
||||
import org.springframework.cloud.deployer.spi.app.AppDeployer;
|
||||
import org.springframework.cloud.deployer.spi.app.AppScaleRequest;
|
||||
import org.springframework.cloud.deployer.spi.app.AppStatus;
|
||||
import org.springframework.cloud.deployer.spi.app.DeploymentState;
|
||||
import org.springframework.cloud.deployer.spi.core.AppDeploymentRequest;
|
||||
import org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo;
|
||||
import org.springframework.cloud.sleuth.CurrentTraceContext;
|
||||
import org.springframework.cloud.sleuth.Span;
|
||||
import org.springframework.cloud.sleuth.Tracer;
|
||||
import org.springframework.cloud.sleuth.instrument.reactor.ReactorSleuth;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.lang.Nullable;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
/**
|
||||
* Trace representation of an {@link AppDeployer}.
|
||||
*
|
||||
* @author Marcin Grzejszczak
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public class TraceAppDeployer implements AppDeployer {
|
||||
|
||||
private static final Log log = LogFactory.getLog(TraceAppDeployer.class);
|
||||
|
||||
private final AppDeployer delegate;
|
||||
|
||||
private final BeanFactory beanFactory;
|
||||
|
||||
private final Environment environment;
|
||||
|
||||
private Tracer tracer;
|
||||
|
||||
private CurrentTraceContext currentTraceContext;
|
||||
|
||||
private Long pollDelay;
|
||||
|
||||
public TraceAppDeployer(AppDeployer delegate, BeanFactory beanFactory, Environment environment) {
|
||||
this.delegate = delegate;
|
||||
this.beanFactory = beanFactory;
|
||||
this.environment = environment;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String deploy(AppDeploymentRequest request) {
|
||||
Span.Builder spanBuilder = clientSpan("deploy", request);
|
||||
Span span = spanBuilder.start();
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span)) {
|
||||
span.event("deployer.start");
|
||||
String id = this.delegate.deploy(request);
|
||||
span.tag("deployer.app.id", id);
|
||||
registerListener(span, id);
|
||||
return id;
|
||||
}
|
||||
}
|
||||
|
||||
private Span.Builder clientSpan(String name) {
|
||||
return clientSpan(name, null, null);
|
||||
}
|
||||
|
||||
private Span.Builder clientSpan(String name, @Nullable AppDeploymentRequest request) {
|
||||
return clientSpan(name, null, request);
|
||||
}
|
||||
|
||||
private Span.Builder clientSpanKind(String name, Span.Builder spanBuilder) {
|
||||
return spanBuilder.kind(Span.Kind.CLIENT).name(name).remoteServiceName(remoteServiceName());
|
||||
}
|
||||
|
||||
private Span.Builder clientSpan(String name, Span parentSpan) {
|
||||
return clientSpan(name, parentSpan, null);
|
||||
}
|
||||
|
||||
private Span.Builder clientSpan(String name, @Nullable Span parentSpan, @Nullable AppDeploymentRequest request) {
|
||||
Span.Builder spanBuilder = tracer().spanBuilder();
|
||||
Span currentSpan = parentSpan != null ? parentSpan : tracer().currentSpan();
|
||||
if (currentSpan != null) {
|
||||
spanBuilder.setParent(currentSpan.context());
|
||||
}
|
||||
Map<String, String> platformSpecificInfo = environmentInfo().getPlatformSpecificInfo();
|
||||
if (request != null) {
|
||||
String platformName = request.getDeploymentProperties().get("spring.cloud.deployer.platformName");
|
||||
if (StringUtils.hasText(platformName)) {
|
||||
spanBuilder.tag("deployer.platform.name", platformName);
|
||||
}
|
||||
String appName = request.getDeploymentProperties().get("spring.cloud.deployer.appName");
|
||||
if (StringUtils.hasText(appName)) {
|
||||
spanBuilder.tag("deployer.app.name", appName);
|
||||
}
|
||||
String group = request.getDeploymentProperties().get("spring.cloud.deployer.group");
|
||||
if (StringUtils.hasText(group)) {
|
||||
spanBuilder.tag("deployer.app.name", group);
|
||||
}
|
||||
}
|
||||
addCfTags(spanBuilder, platformSpecificInfo);
|
||||
addK8sTags(spanBuilder, platformSpecificInfo);
|
||||
return clientSpanKind(name, spanBuilder);
|
||||
}
|
||||
|
||||
private void addCfTags(Span.Builder spanBuilder, Map<String, String> platformSpecificInfo) {
|
||||
if (platformSpecificInfo.containsKey("API Endpoint")) {
|
||||
spanBuilder.tag("deployer.platform.cf.url", platformSpecificInfo.get("API Endpoint"));
|
||||
}
|
||||
if (platformSpecificInfo.containsKey("Organization")) {
|
||||
spanBuilder.tag("deployer.platform.cf.org", platformSpecificInfo.get("Organization"));
|
||||
}
|
||||
if (platformSpecificInfo.containsKey("Space")) {
|
||||
spanBuilder.tag("deployer.platform.cf.space", platformSpecificInfo.get("Space"));
|
||||
}
|
||||
}
|
||||
|
||||
private void addK8sTags(Span.Builder spanBuilder, Map<String, String> platformSpecificInfo) {
|
||||
if (platformSpecificInfo.containsKey("master-url")) {
|
||||
spanBuilder.tag("deployer.platform.k8s.url", platformSpecificInfo.get("master-url"));
|
||||
}
|
||||
if (platformSpecificInfo.containsKey("namespace")) {
|
||||
spanBuilder.tag("deployer.platform.k8s.namespace", platformSpecificInfo.get("namespace"));
|
||||
}
|
||||
}
|
||||
|
||||
private String remoteServiceName() {
|
||||
return environmentInfo().getPlatformType();
|
||||
}
|
||||
|
||||
private void registerListener(Span span, String id) {
|
||||
PreviousAndCurrentStatus previousAndCurrentStatus = new PreviousAndCurrentStatus(span);
|
||||
// @formatter:off
|
||||
this.delegate.statusReactive(id)
|
||||
.map(previousAndCurrentStatus::updateCurrent)
|
||||
@@ -142,173 +160,173 @@ public class TraceAppDeployer implements AppDeployer {
|
||||
.doOnError(span::error)
|
||||
// we will close the span in the reactive part
|
||||
.doFinally(signalType -> span.end()).subscribe();
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Override
|
||||
public void undeploy(String id) {
|
||||
Span.Builder spanBuilder = clientSpan("undeploy");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.app.id", id);
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span)) {
|
||||
span.event("deployer.start");
|
||||
this.delegate.undeploy(id);
|
||||
registerListener(span, id);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public AppStatus status(String id) {
|
||||
Span.Builder spanBuilder = clientSpan("status");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.app.id", id);
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span.start())) {
|
||||
return this.delegate.status(id);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public Mono<AppStatus> statusReactive(String id) {
|
||||
return ReactorSleuth.tracedMono(tracer(), currentTraceContext(), "status",
|
||||
() -> this.delegate.statusReactive(id), (o, span) -> span.tag("deployer.app.id", id),
|
||||
span -> clientSpan("status", span).start());
|
||||
}
|
||||
|
||||
@Override
|
||||
public Flux<AppStatus> statusesReactive(String... ids) {
|
||||
return ReactorSleuth.tracedFlux(tracer(), currentTraceContext(), "statuses",
|
||||
() -> this.delegate.statusesReactive(ids),
|
||||
(o, span) -> span.tag("deployer.app.ids", Arrays.toString(ids)),
|
||||
span -> clientSpan("statuses", span).start());
|
||||
}
|
||||
|
||||
@Override
|
||||
public RuntimeEnvironmentInfo environmentInfo() {
|
||||
return this.delegate.environmentInfo();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getLog(String id) {
|
||||
Span.Builder spanBuilder = clientSpan("getLog");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.app.id", id);
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span)) {
|
||||
return this.delegate.getLog(id);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void scale(AppScaleRequest appScaleRequest) {
|
||||
Span.Builder spanBuilder = clientSpan("scale");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.scale.deploymentId", appScaleRequest.getDeploymentId());
|
||||
span.tag("deployer.scale.count", String.valueOf(appScaleRequest.getCount()));
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span.start())) {
|
||||
this.delegate.scale(appScaleRequest);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
private Tracer tracer() {
|
||||
if (this.tracer == null) {
|
||||
this.tracer = this.beanFactory.getBean(Tracer.class);
|
||||
}
|
||||
return this.tracer;
|
||||
}
|
||||
|
||||
private CurrentTraceContext currentTraceContext() {
|
||||
if (this.currentTraceContext == null) {
|
||||
this.currentTraceContext = this.beanFactory.getBean(CurrentTraceContext.class);
|
||||
}
|
||||
return this.currentTraceContext;
|
||||
}
|
||||
|
||||
private long pollDelay() {
|
||||
if (this.pollDelay == null) {
|
||||
this.pollDelay = this.environment.getProperty("spring.sleuth.deployer.status-poll-delay", Long.class, 500L);
|
||||
}
|
||||
return this.pollDelay;
|
||||
}
|
||||
|
||||
private static final class PreviousAndCurrentStatus {
|
||||
|
||||
private final Span span;
|
||||
|
||||
private AppStatus current;
|
||||
|
||||
private AppStatus previous;
|
||||
|
||||
private PreviousAndCurrentStatus(Span span) {
|
||||
this.span = span;
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Current span is [" + span + "]");
|
||||
}
|
||||
}
|
||||
|
||||
private PreviousAndCurrentStatus updateCurrent(AppStatus current) {
|
||||
if (log.isTraceEnabled()) {
|
||||
log.trace("State before change: current [" + this.current + "], previous [" + this.previous + "]");
|
||||
}
|
||||
this.previous = this.current;
|
||||
this.current = current;
|
||||
if (log.isTraceEnabled()) {
|
||||
log.trace("State after change: current [" + this.current + "], previous [" + this.previous + "]");
|
||||
}
|
||||
if (statusChanged()) {
|
||||
annotateSpan();
|
||||
}
|
||||
else if (log.isTraceEnabled()) {
|
||||
log.trace("State has not changed, will not annotate the span");
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
private void annotateSpan() {
|
||||
String name = this.current.getState().name();
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Will annotate its state with [" + name + "]");
|
||||
}
|
||||
this.span.event(name);
|
||||
}
|
||||
|
||||
private boolean statusChanged() {
|
||||
if (this.previous == null && this.current != null) {
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Previous is null, current is not null");
|
||||
}
|
||||
return true;
|
||||
}
|
||||
else if (this.current == null) {
|
||||
throw new IllegalStateException("Current state can't be null");
|
||||
}
|
||||
DeploymentState currentState = this.current.getState();
|
||||
DeploymentState previousState = this.previous.getState();
|
||||
return currentState != previousState;
|
||||
}
|
||||
|
||||
private boolean isFinished() {
|
||||
boolean finished = this.current.getState() == DeploymentState.deployed
|
||||
|| this.current.getState() == DeploymentState.undeployed
|
||||
|| this.current.getState() == DeploymentState.failed
|
||||
|| this.current.getState() == DeploymentState.error
|
||||
|| this.current.getState() == DeploymentState.unknown;
|
||||
if (log.isTraceEnabled()) {
|
||||
log.trace("Status is finished [" + finished + "]");
|
||||
}
|
||||
return finished;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Override
|
||||
public void undeploy(String id) {
|
||||
Span.Builder spanBuilder = clientSpan("undeploy");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.app.id", id);
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span)) {
|
||||
span.event("deployer.start");
|
||||
this.delegate.undeploy(id);
|
||||
registerListener(span, id);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public AppStatus status(String id) {
|
||||
Span.Builder spanBuilder = clientSpan("status");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.app.id", id);
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span.start())) {
|
||||
return this.delegate.status(id);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public Mono<AppStatus> statusReactive(String id) {
|
||||
return ReactorSleuth.tracedMono(tracer(), currentTraceContext(), "status",
|
||||
() -> this.delegate.statusReactive(id), (o, span) -> span.tag("deployer.app.id", id),
|
||||
span -> clientSpan("status", span).start());
|
||||
}
|
||||
|
||||
@Override
|
||||
public Flux<AppStatus> statusesReactive(String... ids) {
|
||||
return ReactorSleuth.tracedFlux(tracer(), currentTraceContext(), "statuses",
|
||||
() -> this.delegate.statusesReactive(ids),
|
||||
(o, span) -> span.tag("deployer.app.ids", Arrays.toString(ids)),
|
||||
span -> clientSpan("statuses", span).start());
|
||||
}
|
||||
|
||||
@Override
|
||||
public RuntimeEnvironmentInfo environmentInfo() {
|
||||
return this.delegate.environmentInfo();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getLog(String id) {
|
||||
Span.Builder spanBuilder = clientSpan("getLog");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.app.id", id);
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span)) {
|
||||
return this.delegate.getLog(id);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void scale(AppScaleRequest appScaleRequest) {
|
||||
Span.Builder spanBuilder = clientSpan("scale");
|
||||
Span span = spanBuilder.start();
|
||||
span.tag("deployer.scale.deploymentId", appScaleRequest.getDeploymentId());
|
||||
span.tag("deployer.scale.count", String.valueOf(appScaleRequest.getCount()));
|
||||
try (Tracer.SpanInScope spanInScope = tracer().withSpan(span.start())) {
|
||||
this.delegate.scale(appScaleRequest);
|
||||
}
|
||||
finally {
|
||||
span.end();
|
||||
}
|
||||
}
|
||||
|
||||
private Tracer tracer() {
|
||||
if (this.tracer == null) {
|
||||
this.tracer = this.beanFactory.getBean(Tracer.class);
|
||||
}
|
||||
return this.tracer;
|
||||
}
|
||||
|
||||
private CurrentTraceContext currentTraceContext() {
|
||||
if (this.currentTraceContext == null) {
|
||||
this.currentTraceContext = this.beanFactory.getBean(CurrentTraceContext.class);
|
||||
}
|
||||
return this.currentTraceContext;
|
||||
}
|
||||
|
||||
private long pollDelay() {
|
||||
if (this.pollDelay == null) {
|
||||
this.pollDelay = this.environment.getProperty("spring.sleuth.deployer.status-poll-delay", Long.class, 500L);
|
||||
}
|
||||
return this.pollDelay;
|
||||
}
|
||||
|
||||
private static final class PreviousAndCurrentStatus {
|
||||
|
||||
private final Span span;
|
||||
|
||||
private AppStatus current;
|
||||
|
||||
private AppStatus previous;
|
||||
|
||||
private PreviousAndCurrentStatus(Span span) {
|
||||
this.span = span;
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Current span is [" + span + "]");
|
||||
}
|
||||
}
|
||||
|
||||
private PreviousAndCurrentStatus updateCurrent(AppStatus current) {
|
||||
if (log.isTraceEnabled()) {
|
||||
log.trace("State before change: current [" + this.current + "], previous [" + this.previous + "]");
|
||||
}
|
||||
this.previous = this.current;
|
||||
this.current = current;
|
||||
if (log.isTraceEnabled()) {
|
||||
log.trace("State after change: current [" + this.current + "], previous [" + this.previous + "]");
|
||||
}
|
||||
if (statusChanged()) {
|
||||
annotateSpan();
|
||||
}
|
||||
else if (log.isTraceEnabled()) {
|
||||
log.trace("State has not changed, will not annotate the span");
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
private void annotateSpan() {
|
||||
String name = this.current.getState().name();
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Will annotate its state with [" + name + "]");
|
||||
}
|
||||
this.span.event(name);
|
||||
}
|
||||
|
||||
private boolean statusChanged() {
|
||||
if (this.previous == null && this.current != null) {
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Previous is null, current is not null");
|
||||
}
|
||||
return true;
|
||||
}
|
||||
else if (this.current == null) {
|
||||
throw new IllegalStateException("Current state can't be null");
|
||||
}
|
||||
DeploymentState currentState = this.current.getState();
|
||||
DeploymentState previousState = this.previous.getState();
|
||||
return currentState != previousState;
|
||||
}
|
||||
|
||||
private boolean isFinished() {
|
||||
boolean finished = this.current.getState() == DeploymentState.deployed
|
||||
|| this.current.getState() == DeploymentState.undeployed
|
||||
|| this.current.getState() == DeploymentState.failed
|
||||
|| this.current.getState() == DeploymentState.error
|
||||
|| this.current.getState() == DeploymentState.unknown;
|
||||
if (log.isTraceEnabled()) {
|
||||
log.trace("Status is finished [" + finished + "]");
|
||||
}
|
||||
return finished;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1,141 +1,143 @@
|
||||
/*
|
||||
* Copyright 2013-2021 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.cloud.sleuth.instrument.r2dbc;
|
||||
|
||||
import java.util.concurrent.atomic.AtomicReference;
|
||||
|
||||
import io.r2dbc.proxy.core.QueryExecutionInfo;
|
||||
import io.r2dbc.proxy.core.ValueStore;
|
||||
import io.r2dbc.proxy.test.MockQueryExecutionInfo;
|
||||
import io.r2dbc.spi.Connection;
|
||||
import io.r2dbc.spi.ConnectionFactory;
|
||||
import io.r2dbc.spi.ConnectionFactoryMetadata;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.reactivestreams.Publisher;
|
||||
|
||||
import org.springframework.beans.factory.BeanFactory;
|
||||
import org.springframework.beans.factory.support.StaticListableBeanFactory;
|
||||
import org.springframework.cloud.sleuth.Span;
|
||||
import org.springframework.cloud.sleuth.tracer.SimpleSpan;
|
||||
import org.springframework.cloud.sleuth.tracer.SimpleTracer;
|
||||
|
||||
import static org.assertj.core.api.BDDAssertions.then;
|
||||
|
||||
class TraceProxyExecutionListenerTests {
|
||||
|
||||
SimpleTracer simpleTracer = new SimpleTracer();
|
||||
|
||||
ConnectionFactory connectionFactory = connectionFactory();
|
||||
|
||||
TraceProxyExecutionListener listener = new TraceProxyExecutionListener(beanFactory(), connectionFactory);
|
||||
|
||||
@Test
|
||||
void should_do_nothing_on_before_query_when_there_was_no_previous_span() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
|
||||
listener.beforeQuery(queryExecutionInfo);
|
||||
|
||||
then(this.simpleTracer.spans).isEmpty();
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_do_nothing_on_after_query_when_there_was_no_previous_span() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
|
||||
listener.afterQuery(queryExecutionInfo);
|
||||
|
||||
then(this.simpleTracer.spans).isEmpty();
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_do_nothing_on_each_query_when_there_was_no_previous_span() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
|
||||
listener.eachQueryResult(queryExecutionInfo);
|
||||
|
||||
then(this.simpleTracer.spans).isEmpty();
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_put_a_child_span_in_value_store_when_a_span_was_already_in_context() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
this.simpleTracer.nextSpan().start();
|
||||
AtomicReference<Span> clientSpan = new AtomicReference<>();
|
||||
listener = new TraceProxyExecutionListener(beanFactory(), connectionFactory) {
|
||||
@Override
|
||||
Span clientSpan(QueryExecutionInfo executionInfo, String name) {
|
||||
Span span = super.clientSpan(executionInfo, name);
|
||||
clientSpan.set(span);
|
||||
return span;
|
||||
}
|
||||
};
|
||||
|
||||
listener.beforeQuery(queryExecutionInfo);
|
||||
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isSameAs(clientSpan.get());
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_annotate_a_span_on_query_result() {
|
||||
SimpleSpan span = new SimpleSpan();
|
||||
ValueStore valueStore = ValueStore.create();
|
||||
valueStore.put(Span.class, span);
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.builder().valueStore(valueStore).build();
|
||||
|
||||
listener.eachQueryResult(queryExecutionInfo);
|
||||
|
||||
then(span.events).isNotEmpty();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_end_span_on_after_query() {
|
||||
SimpleSpan span = new SimpleSpan().start();
|
||||
ValueStore valueStore = ValueStore.create();
|
||||
valueStore.put(Span.class, span);
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.builder().throwable(new RuntimeException())
|
||||
.valueStore(valueStore).build();
|
||||
|
||||
listener.afterQuery(queryExecutionInfo);
|
||||
|
||||
then(span.throwable).isNotNull();
|
||||
then(span.ended).isTrue();
|
||||
}
|
||||
|
||||
private ConnectionFactory connectionFactory() {
|
||||
return new ConnectionFactory() {
|
||||
@Override
|
||||
public Publisher<? extends Connection> create() {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ConnectionFactoryMetadata getMetadata() {
|
||||
return () -> "my-name";
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private BeanFactory beanFactory() {
|
||||
StaticListableBeanFactory beanFactory = new StaticListableBeanFactory();
|
||||
beanFactory.addBean("tracer", this.simpleTracer);
|
||||
return beanFactory;
|
||||
}
|
||||
|
||||
}
|
||||
/*
|
||||
* Copyright 2013-2021 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.cloud.sleuth.instrument.r2dbc;
|
||||
|
||||
import java.util.concurrent.atomic.AtomicReference;
|
||||
|
||||
import io.r2dbc.proxy.core.QueryExecutionInfo;
|
||||
import io.r2dbc.proxy.core.ValueStore;
|
||||
import io.r2dbc.proxy.test.MockQueryExecutionInfo;
|
||||
import io.r2dbc.spi.Connection;
|
||||
import io.r2dbc.spi.ConnectionFactory;
|
||||
import io.r2dbc.spi.ConnectionFactoryMetadata;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.reactivestreams.Publisher;
|
||||
|
||||
import org.springframework.beans.factory.BeanFactory;
|
||||
import org.springframework.beans.factory.support.StaticListableBeanFactory;
|
||||
import org.springframework.boot.autoconfigure.r2dbc.R2dbcProperties;
|
||||
import org.springframework.cloud.sleuth.Span;
|
||||
import org.springframework.cloud.sleuth.tracer.SimpleSpan;
|
||||
import org.springframework.cloud.sleuth.tracer.SimpleTracer;
|
||||
|
||||
import static org.assertj.core.api.BDDAssertions.then;
|
||||
|
||||
class TraceProxyExecutionListenerTests {
|
||||
|
||||
SimpleTracer simpleTracer = new SimpleTracer();
|
||||
|
||||
ConnectionFactory connectionFactory = connectionFactory();
|
||||
|
||||
TraceProxyExecutionListener listener = new TraceProxyExecutionListener(beanFactory(), connectionFactory);
|
||||
|
||||
@Test
|
||||
void should_do_nothing_on_before_query_when_there_was_no_previous_span() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
|
||||
listener.beforeQuery(queryExecutionInfo);
|
||||
|
||||
then(this.simpleTracer.spans).isEmpty();
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_do_nothing_on_after_query_when_there_was_no_previous_span() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
|
||||
listener.afterQuery(queryExecutionInfo);
|
||||
|
||||
then(this.simpleTracer.spans).isEmpty();
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_do_nothing_on_each_query_when_there_was_no_previous_span() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
|
||||
listener.eachQueryResult(queryExecutionInfo);
|
||||
|
||||
then(this.simpleTracer.spans).isEmpty();
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_put_a_child_span_in_value_store_when_a_span_was_already_in_context() {
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.empty();
|
||||
this.simpleTracer.nextSpan().start();
|
||||
AtomicReference<Span> clientSpan = new AtomicReference<>();
|
||||
listener = new TraceProxyExecutionListener(beanFactory(), connectionFactory) {
|
||||
@Override
|
||||
Span clientSpan(QueryExecutionInfo executionInfo, String name) {
|
||||
Span span = super.clientSpan(executionInfo, name);
|
||||
clientSpan.set(span);
|
||||
return span;
|
||||
}
|
||||
};
|
||||
|
||||
listener.beforeQuery(queryExecutionInfo);
|
||||
|
||||
then(queryExecutionInfo.getValueStore().get(Span.class)).isSameAs(clientSpan.get());
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_annotate_a_span_on_query_result() {
|
||||
SimpleSpan span = new SimpleSpan();
|
||||
ValueStore valueStore = ValueStore.create();
|
||||
valueStore.put(Span.class, span);
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.builder().valueStore(valueStore).build();
|
||||
|
||||
listener.eachQueryResult(queryExecutionInfo);
|
||||
|
||||
then(span.events).isNotEmpty();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_end_span_on_after_query() {
|
||||
SimpleSpan span = new SimpleSpan().start();
|
||||
ValueStore valueStore = ValueStore.create();
|
||||
valueStore.put(Span.class, span);
|
||||
MockQueryExecutionInfo queryExecutionInfo = MockQueryExecutionInfo.builder().throwable(new RuntimeException())
|
||||
.valueStore(valueStore).build();
|
||||
|
||||
listener.afterQuery(queryExecutionInfo);
|
||||
|
||||
then(span.throwable).isNotNull();
|
||||
then(span.ended).isTrue();
|
||||
}
|
||||
|
||||
private ConnectionFactory connectionFactory() {
|
||||
return new ConnectionFactory() {
|
||||
@Override
|
||||
public Publisher<? extends Connection> create() {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ConnectionFactoryMetadata getMetadata() {
|
||||
return () -> "my-name";
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private BeanFactory beanFactory() {
|
||||
StaticListableBeanFactory beanFactory = new StaticListableBeanFactory();
|
||||
beanFactory.addBean("tracer", this.simpleTracer);
|
||||
beanFactory.addBean("r2dbcProperties", new R2dbcProperties());
|
||||
return beanFactory;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user