CAMEL-9759: camel-zipkin - Instrument Camel. Work in progress.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/3a4087cd Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3a4087cd Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3a4087cd Branch: refs/heads/master Commit: 3a4087cd80b85e8e3c610c1e9b1a88ab5600d518 Parents: d1c3bbf Author: Claus Ibsen <davscl...@apache.org> Authored: Fri Mar 25 15:47:48 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Mar 29 14:41:54 2016 +0200 ---------------------------------------------------------------------- components/camel-zipkin/pom.xml | 70 ++++++ .../zipkin/ZipkinClientRequestAdapter.java | 70 ++++++ .../zipkin/ZipkinClientResponseAdaptor.java | 45 ++++ .../camel/zipkin/ZipkinEventNotifier.java | 246 +++++++++++++++++++ .../org/apache/camel/zipkin/ZipkinHelper.java | 34 +++ .../zipkin/ZipkinLoggingSpanCollector.java | 67 +++++ .../zipkin/ZipkinServerRequestAdapter.java | 69 ++++++ .../zipkin/ZipkinServerResponseAdapter.java | 45 ++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../camel/zipkin/ZipkinRouteScribeTest.java | 73 ++++++ .../apache/camel/zipkin/ZipkinRouteTest.java | 72 ++++++ .../src/test/resources/log4j.properties | 41 ++++ components/pom.xml | 1 + 14 files changed, 1047 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/pom.xml ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/pom.xml b/components/camel-zipkin/pom.xml new file mode 100644 index 0000000..567626a --- /dev/null +++ b/components/camel-zipkin/pom.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + 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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <artifactId>components</artifactId> + <groupId>org.apache.camel</groupId> + <version>2.18-SNAPSHOT</version> + </parent> + + <artifactId>camel-zipkin</artifactId> + <packaging>bundle</packaging> + <name>Camel :: Zookeeper</name> + <description>Camel Zipkin Support</description> + + <properties> + <camel.osgi.export.pkg>org.apache.camel.zipkin.*</camel.osgi.export.pkg> + </properties> + + <dependencies> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-core</artifactId> + </dependency> + + <!-- brave/zkpkin --> + <dependency> + <groupId>com.github.kristofa</groupId> + <artifactId>brave-core</artifactId> + <version>3.5.0</version> + </dependency> + <dependency> + <groupId>com.github.kristofa</groupId> + <artifactId>brave-spancollector-scribe</artifactId> + <version>3.5.0</version> + </dependency> + + <!-- test dependencies --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + <scope>test</scope> + </dependency> + + </dependencies> + +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientRequestAdapter.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientRequestAdapter.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientRequestAdapter.java new file mode 100644 index 0000000..5254578 --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientRequestAdapter.java @@ -0,0 +1,70 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.Collection; +import java.util.Collections; +import java.util.Locale; + +import com.github.kristofa.brave.ClientRequestAdapter; +import com.github.kristofa.brave.IdConversion; +import com.github.kristofa.brave.KeyValueAnnotation; +import com.github.kristofa.brave.SpanId; +import com.github.kristofa.brave.internal.Nullable; +import org.apache.camel.Endpoint; +import org.apache.camel.Exchange; +import org.apache.camel.util.URISupport; + +public final class ZipkinClientRequestAdapter implements ClientRequestAdapter { + + private final String serviceName; + private final Exchange exchange; + private final Endpoint endpoint; + private final String spanName; + + public ZipkinClientRequestAdapter(String serviceName, Exchange exchange, Endpoint endpoint) { + this.serviceName = serviceName; + this.exchange = exchange; + this.endpoint = endpoint; + this.spanName = URISupport.sanitizeUri(endpoint.getEndpointKey()).toLowerCase(Locale.US); + } + + @Override + public String getSpanName() { + return spanName; + } + + @Override + public void addSpanIdToRequest(@Nullable SpanId spanId) { + exchange.getIn().setHeader("CamelZipkinTraceId", IdConversion.convertToString(spanId.getTraceId())); + exchange.getIn().setHeader("CamelZipkinSpanId", IdConversion.convertToString(spanId.getSpanId())); + if (spanId.getParentSpanId() != null) { + exchange.getIn().setHeader("CamelZipkinParentSpanId", IdConversion.convertToString(spanId.getParentSpanId())); + } + } + + @Override + public String getClientServiceName() { + return serviceName; + } + + @Override + public Collection<KeyValueAnnotation> requestAnnotations() { + String msgId = exchange.getIn().getMessageId(); + return Collections.singletonList(KeyValueAnnotation.create("CamelMessageId", msgId)); + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientResponseAdaptor.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientResponseAdaptor.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientResponseAdaptor.java new file mode 100644 index 0000000..daddeff --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinClientResponseAdaptor.java @@ -0,0 +1,45 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.Collection; +import java.util.Collections; + +import com.github.kristofa.brave.ClientResponseAdapter; +import com.github.kristofa.brave.KeyValueAnnotation; +import org.apache.camel.Endpoint; +import org.apache.camel.Exchange; + +public class ZipkinClientResponseAdaptor implements ClientResponseAdapter { + + private final Exchange exchange; + private final Endpoint endpoint; + + public ZipkinClientResponseAdaptor(Exchange exchange, Endpoint endpoint) { + this.exchange = exchange; + this.endpoint = endpoint; + } + + @Override + public Collection<KeyValueAnnotation> responseAnnotations() { + if (exchange.getException() != null) { + return Collections.singletonList(KeyValueAnnotation.create("CamelZipkinFailed", exchange.getException().getMessage())); + } else { + return Collections.emptyList(); + } + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinEventNotifier.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinEventNotifier.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinEventNotifier.java new file mode 100644 index 0000000..30b8ca1 --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinEventNotifier.java @@ -0,0 +1,246 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.EventObject; +import java.util.HashMap; +import java.util.Map; + +import com.github.kristofa.brave.Brave; +import com.github.kristofa.brave.ClientSpanThreadBinder; +import com.github.kristofa.brave.Sampler; +import com.github.kristofa.brave.SpanCollector; +import com.twitter.zipkin.gen.Span; +import org.apache.camel.Endpoint; +import org.apache.camel.Exchange; +import org.apache.camel.management.event.ExchangeCompletedEvent; +import org.apache.camel.management.event.ExchangeCreatedEvent; +import org.apache.camel.management.event.ExchangeFailedEvent; +import org.apache.camel.management.event.ExchangeSendingEvent; +import org.apache.camel.management.event.ExchangeSentEvent; +import org.apache.camel.support.EventNotifierSupport; +import org.apache.camel.util.EndpointHelper; + +import static org.apache.camel.builder.ExpressionBuilder.routeIdExpression; + +public class ZipkinEventNotifier extends EventNotifierSupport { + + private float rate = 1.0f; + private SpanCollector spanCollector; + private Map<String, String> serviceMappings = new HashMap<>(); + private Map<String, Brave> braves = new HashMap<>(); + + public ZipkinEventNotifier() { + } + + public float getRate() { + return rate; + } + + public void setRate(float rate) { + this.rate = rate; + } + + public SpanCollector getSpanCollector() { + return spanCollector; + } + + public void setSpanCollector(SpanCollector spanCollector) { + this.spanCollector = spanCollector; + } + + public String getServiceName() { + return serviceMappings.get("*"); + } + + public void setServiceName(String serviceName) { + serviceMappings.put("*", serviceName); + } + + public Map<String, String> getServiceMappings() { + return serviceMappings; + } + + public void setServiceMappings(Map<String, String> serviceMappings) { + this.serviceMappings = serviceMappings; + } + + public void addServiceMapping(String routeId, String serviceName) { + serviceMappings.put(routeId, serviceName); + } + + @Override + protected void doStart() throws Exception { + super.doStart(); + + if (serviceMappings.isEmpty()) { + throw new IllegalStateException("At least one service name must be configured"); + } + + // create braves mapped per service name + for (Map.Entry<String, String> entry : serviceMappings.entrySet()) { + String pattern = entry.getKey(); + String serviceName = entry.getValue(); + Brave brave = braves.get(pattern); + if (brave == null) { + Brave.Builder builder = new Brave.Builder(serviceName); + builder = builder.traceSampler(Sampler.create(rate)); + if (spanCollector != null) { + builder = builder.spanCollector(spanCollector); + } + brave = builder.build(); + braves.put(serviceName, brave); + } + } + } + + @Override + public boolean isEnabled(EventObject event) { + return event instanceof ExchangeSendingEvent || event instanceof ExchangeSentEvent + || event instanceof ExchangeCreatedEvent || event instanceof ExchangeCompletedEvent || event instanceof ExchangeFailedEvent; + } + + private String getServiceName(Exchange exchange, Endpoint endpoint) { + String answer = null; + + String id = routeIdExpression().evaluate(exchange, String.class); + for (Map.Entry<String, String> entry : serviceMappings.entrySet()) { + String pattern = entry.getKey(); + if (EndpointHelper.matchPattern(pattern, id)) { + answer = entry.getValue(); + break; + } + } + + if (answer == null) { + id = exchange.getFromRouteId(); + for (Map.Entry<String, String> entry : serviceMappings.entrySet()) { + String pattern = entry.getKey(); + if (EndpointHelper.matchPattern(pattern, id)) { + answer = entry.getValue(); + break; + } + } + } + + if (answer == null && endpoint != null) { + String url = endpoint.getEndpointUri(); + for (Map.Entry<String, String> entry : serviceMappings.entrySet()) { + String pattern = entry.getKey(); + if (EndpointHelper.matchEndpoint(exchange.getContext(), url, pattern)) { + answer = entry.getValue(); + break; + } + } + } + + if (answer == null && exchange.getFromEndpoint() != null) { + String url = exchange.getFromEndpoint().getEndpointUri(); + for (Map.Entry<String, String> entry : serviceMappings.entrySet()) { + String pattern = entry.getKey(); + if (EndpointHelper.matchEndpoint(exchange.getContext(), url, pattern)) { + answer = entry.getValue(); + break; + } + } + } + + return answer; + } + + private Brave getBrave(String serviceName) { + if (serviceName != null) { + return braves.get(serviceName); + } else { + return null; + } + } + + @Override + public void notify(EventObject event) throws Exception { + if (event instanceof ExchangeSendingEvent) { + clientRequest((ExchangeSendingEvent) event); + } else if (event instanceof ExchangeSentEvent) { + clientResponse((ExchangeSentEvent) event); + } else if (event instanceof ExchangeCreatedEvent) { + serverRequest((ExchangeCreatedEvent) event); + } else if (event instanceof ExchangeCompletedEvent) { + serverResponse((ExchangeCompletedEvent) event); + } else if (event instanceof ExchangeFailedEvent) { + serverResponse((ExchangeFailedEvent) event); + } + } + + private void clientRequest(ExchangeSendingEvent event) { + String serviceName = getServiceName(event.getExchange(), event.getEndpoint()); + Brave brave = getBrave(serviceName); + if (brave != null) { + ClientSpanThreadBinder binder = brave.clientSpanThreadBinder(); + brave.clientRequestInterceptor().handle(new ZipkinClientRequestAdapter(serviceName, event.getExchange(), event.getEndpoint())); + Span span = binder.getCurrentClientSpan(); + event.getExchange().setProperty("CamelZipkinSpan", span); + } + } + + private void clientResponse(ExchangeSentEvent event) { + String serviceName = getServiceName(event.getExchange(), event.getEndpoint()); + Brave brave = getBrave(serviceName); + if (brave != null) { + ClientSpanThreadBinder binder = brave.clientSpanThreadBinder(); + Span span = event.getExchange().getProperty("CamelZipkinSpan", Span.class); + binder.setCurrentSpan(span); + brave.clientResponseInterceptor().handle(new ZipkinClientResponseAdaptor(event.getExchange(), event.getEndpoint())); + binder.setCurrentSpan(null); + } + } + + private void serverRequest(ExchangeCreatedEvent event) { + String serviceName = getServiceName(event.getExchange(), null); + Brave brave = getBrave(serviceName); + if (brave != null) { + ClientSpanThreadBinder binder = brave.clientSpanThreadBinder(); + brave.serverRequestInterceptor().handle(new ZipkinServerRequestAdapter(event.getExchange())); + Span span = binder.getCurrentClientSpan(); + event.getExchange().setProperty("CamelZipkinSpan", span); + } + } + + private void serverResponse(ExchangeCompletedEvent event) { + String serviceName = getServiceName(event.getExchange(), null); + Brave brave = getBrave(serviceName); + if (brave != null) { + ClientSpanThreadBinder binder = brave.clientSpanThreadBinder(); + Span span = event.getExchange().getProperty("CamelZipkinSpan", Span.class); + binder.setCurrentSpan(span); + brave.serverResponseInterceptor().handle(new ZipkinServerResponseAdapter(event.getExchange())); + binder.setCurrentSpan(null); + } + } + + private void serverResponse(ExchangeFailedEvent event) { + String serviceName = getServiceName(event.getExchange(), null); + Brave brave = getBrave(serviceName); + if (brave != null) { + ClientSpanThreadBinder binder = brave.clientSpanThreadBinder(); + Span span = event.getExchange().getProperty("CamelZipkinSpan", Span.class); + binder.setCurrentSpan(span); + brave.serverResponseInterceptor().handle(new ZipkinServerResponseAdapter(event.getExchange())); + binder.setCurrentSpan(null); + } + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinHelper.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinHelper.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinHelper.java new file mode 100644 index 0000000..d5c8c57 --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinHelper.java @@ -0,0 +1,34 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import com.github.kristofa.brave.IdConversion; +import com.github.kristofa.brave.SpanId; + +public final class ZipkinHelper { + + private ZipkinHelper() { + } + + public static SpanId getSpanId(String traceId, String spanId, String parentSpanId) { + if (parentSpanId != null) { + return SpanId.create(IdConversion.convertToLong(traceId), IdConversion.convertToLong(spanId), IdConversion.convertToLong(parentSpanId)); + } + return SpanId.create(IdConversion.convertToLong(traceId), IdConversion.convertToLong(spanId), null); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinLoggingSpanCollector.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinLoggingSpanCollector.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinLoggingSpanCollector.java new file mode 100644 index 0000000..71d551a --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinLoggingSpanCollector.java @@ -0,0 +1,67 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.LinkedHashSet; +import java.util.Set; + +import com.github.kristofa.brave.IdConversion; +import com.github.kristofa.brave.SpanCollector; +import com.twitter.zipkin.gen.BinaryAnnotation; +import com.twitter.zipkin.gen.Span; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class ZipkinLoggingSpanCollector implements SpanCollector { + + private final Set<BinaryAnnotation> defaultAnnotations = new LinkedHashSet<BinaryAnnotation>(); + private final String name; + private final Logger logger; + + public ZipkinLoggingSpanCollector() { + this(ZipkinLoggingSpanCollector.class.getName()); + } + + public ZipkinLoggingSpanCollector(String name) { + this.name = name; + this.logger = LoggerFactory.getLogger(name); + } + + @Override + public void collect(Span span) { + if (!defaultAnnotations.isEmpty()) { + for (BinaryAnnotation ba : defaultAnnotations) { + span.addToBinary_annotations(ba); + } + } + + if (logger.isInfoEnabled()) { + long ms = span.getDuration() != null ? span.getDuration() / 1000 : -1; + String id = IdConversion.convertToString(span.getId()); + String line = String.format("%s(%s) - %s ms", span.getName(), id, ms); + logger.info(line); + } + } + + @Override + public void addDefaultAnnotation(String key, String value) { + defaultAnnotations.add(BinaryAnnotation.create(key, value, null)); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerRequestAdapter.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerRequestAdapter.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerRequestAdapter.java new file mode 100644 index 0000000..c6ec850 --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerRequestAdapter.java @@ -0,0 +1,69 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.Collection; +import java.util.Collections; +import java.util.Locale; + +import com.github.kristofa.brave.KeyValueAnnotation; +import com.github.kristofa.brave.ServerRequestAdapter; +import com.github.kristofa.brave.SpanId; +import com.github.kristofa.brave.TraceData; +import org.apache.camel.Endpoint; +import org.apache.camel.Exchange; +import org.apache.camel.util.URISupport; + +import static org.apache.camel.zipkin.ZipkinHelper.getSpanId; + +public class ZipkinServerRequestAdapter implements ServerRequestAdapter { + + private final Exchange exchange; + private final Endpoint endpoint; + private final String spanName; + + public ZipkinServerRequestAdapter(Exchange exchange) { + this.exchange = exchange; + this.endpoint = exchange.getFromEndpoint(); + this.spanName = URISupport.sanitizeUri(endpoint.getEndpointKey()).toLowerCase(Locale.US); + } + + @Override + public TraceData getTraceData() { + String traceId = exchange.getIn().getHeader("CamelZipkinTraceId", String.class); + String spanId = exchange.getIn().getHeader("CamelZipkinSpanId", String.class); + String parentSpanId = exchange.getIn().getHeader("CamelZipkinParentSpanId", String.class); + if (traceId != null && spanId != null) { + SpanId span = getSpanId(traceId, spanId, parentSpanId); + return TraceData.builder().sample(true).spanId(span).build(); + } else { + return TraceData.builder().build(); + } + } + + @Override + public String getSpanName() { + return spanName; + } + + @Override + public Collection<KeyValueAnnotation> requestAnnotations() { + String msgId = exchange.getIn().getMessageId(); + return Collections.singletonList(KeyValueAnnotation.create("CamelMessageId", msgId)); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerResponseAdapter.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerResponseAdapter.java b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerResponseAdapter.java new file mode 100644 index 0000000..8cb5b67 --- /dev/null +++ b/components/camel-zipkin/src/main/java/org/apache/camel/zipkin/ZipkinServerResponseAdapter.java @@ -0,0 +1,45 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.Collection; +import java.util.Collections; + +import com.github.kristofa.brave.KeyValueAnnotation; +import com.github.kristofa.brave.ServerResponseAdapter; +import org.apache.camel.Endpoint; +import org.apache.camel.Exchange; + +public class ZipkinServerResponseAdapter implements ServerResponseAdapter { + + private final Exchange exchange; + private final Endpoint endpoint; + + public ZipkinServerResponseAdapter(Exchange exchange) { + this.exchange = exchange; + this.endpoint = exchange.getFromEndpoint(); + } + + @Override + public Collection<KeyValueAnnotation> responseAnnotations() { + if (exchange.getException() != null) { + return Collections.singletonList(KeyValueAnnotation.create("failure", exchange.getException().getMessage())); + } else { + return Collections.emptyList(); + } + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/resources/META-INF/LICENSE.txt b/components/camel-zipkin/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/components/camel-zipkin/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + 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. + http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/main/resources/META-INF/NOTICE.txt b/components/camel-zipkin/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/components/camel-zipkin/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteScribeTest.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteScribeTest.java b/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteScribeTest.java new file mode 100644 index 0000000..94d2ca4 --- /dev/null +++ b/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteScribeTest.java @@ -0,0 +1,73 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.concurrent.TimeUnit; + +import com.github.kristofa.brave.scribe.ScribeSpanCollector; +import org.apache.camel.CamelContext; +import org.apache.camel.RoutesBuilder; +import org.apache.camel.builder.NotifyBuilder; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.test.junit4.CamelTestSupport; +import org.junit.Test; + +public class ZipkinRouteScribeTest extends CamelTestSupport { + + private ZipkinEventNotifier zipkin; + + @Override + protected CamelContext createCamelContext() throws Exception { + CamelContext context = super.createCamelContext(); + + zipkin = new ZipkinEventNotifier(); + zipkin.addServiceMapping("seda:foo", "foo"); + zipkin.addServiceMapping("seda:bar", "bar"); + zipkin.setSpanCollector(new ScribeSpanCollector("192.168.99.101", 9410)); + context.getManagementStrategy().addEventNotifier(zipkin); + + return context; + } + + @Test + public void testZipkinRoute() throws Exception { + NotifyBuilder notify = new NotifyBuilder(context).whenDone(10).create(); + + for (int i = 0; i < 5; i++) { + template.sendBody("seda:foo", "Hello World"); + } + + assertTrue(notify.matches(60, TimeUnit.SECONDS)); + } + + @Override + protected RoutesBuilder createRouteBuilder() throws Exception { + return new RouteBuilder() { + @Override + public void configure() throws Exception { + from("seda:foo").routeId("foo") + .log("routing at ${routeId}") + .delay(simple("${random(1000,2000)}")) + .to("seda:bar"); + + from("seda:bar").routeId("bar") + .log("routing at ${routeId}") + .delay(simple("${random(0,500)}")); + } + }; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteTest.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteTest.java b/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteTest.java new file mode 100644 index 0000000..15a4a41 --- /dev/null +++ b/components/camel-zipkin/src/test/java/org/apache/camel/zipkin/ZipkinRouteTest.java @@ -0,0 +1,72 @@ +/** + * 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 + * <p/> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p/> + * 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.camel.zipkin; + +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.RoutesBuilder; +import org.apache.camel.builder.NotifyBuilder; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.test.junit4.CamelTestSupport; +import org.junit.Test; + +public class ZipkinRouteTest extends CamelTestSupport { + + private ZipkinEventNotifier zipkin; + + @Override + protected CamelContext createCamelContext() throws Exception { + CamelContext context = super.createCamelContext(); + + zipkin = new ZipkinEventNotifier(); + zipkin.addServiceMapping("seda:foo", "foo"); + zipkin.addServiceMapping("seda:bar", "bar"); + zipkin.setSpanCollector(new ZipkinLoggingSpanCollector()); + context.getManagementStrategy().addEventNotifier(zipkin); + + return context; + } + + @Test + public void testZipkinRoute() throws Exception { + NotifyBuilder notify = new NotifyBuilder(context).whenDone(10).create(); + + for (int i = 0; i < 5; i++) { + template.sendBody("seda:foo", "Hello World"); + } + + assertTrue(notify.matches(30, TimeUnit.SECONDS)); + } + + @Override + protected RoutesBuilder createRouteBuilder() throws Exception { + return new RouteBuilder() { + @Override + public void configure() throws Exception { + from("seda:foo?concurrentConsumers=5").routeId("foo") + .log("routing at ${routeId}") + .delay(simple("${random(1000,2000)}")) + .to("seda:bar"); + + from("seda:bar?concurrentConsumers=5").routeId("bar") + .log("routing at ${routeId}") + .delay(simple("${random(0,500)}")); + } + }; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/camel-zipkin/src/test/resources/log4j.properties ---------------------------------------------------------------------- diff --git a/components/camel-zipkin/src/test/resources/log4j.properties b/components/camel-zipkin/src/test/resources/log4j.properties new file mode 100644 index 0000000..69b028b --- /dev/null +++ b/components/camel-zipkin/src/test/resources/log4j.properties @@ -0,0 +1,41 @@ +# +# 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. +# + +# +# The logging properties used +# +log4j.rootLogger=INFO, out + +#log4j.logger.org.apache.camel=DEBUG +#log4j.logger.org.apache.camel.zipkin=DEBUG +log4j.logger.com.github.kristofa.brave=DEBUG + +# CONSOLE appender not used by default +log4j.appender.out=org.apache.log4j.ConsoleAppender +log4j.appender.out.layout=org.apache.log4j.PatternLayout +#log4j.appender.out.layout.ConversionPattern=[%30.30t] %-30.30c{1} %-5p %m%n +log4j.appender.out.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n +# MDC +#log4j.appender.out.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %-10.10X{camel.breadcrumbId} - %-10.10X{camel.exchangeId} - %-10.10X{camel.correlationId} - %-10.10X{camel.routeId} - %m%n + +# File appender +log4j.appender.file=org.apache.log4j.FileAppender +log4j.appender.file.layout=org.apache.log4j.PatternLayout +log4j.appender.file.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n +log4j.appender.file.file=target/camel-zipkin-test.log +# MDC +#log4j.appender.file.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %-10.10X{camel.breadcrumbId} - %-10.10X{camel.exchangeId} - %-10.10X{camel.correlationId} - %-10.10X{camel.routeId} - %m%n http://git-wip-us.apache.org/repos/asf/camel/blob/3a4087cd/components/pom.xml ---------------------------------------------------------------------- diff --git a/components/pom.xml b/components/pom.xml index 1e86994..2624e0c 100644 --- a/components/pom.xml +++ b/components/pom.xml @@ -263,6 +263,7 @@ <module>camel-xstream</module> <module>camel-yammer</module> <module>camel-zipfile</module> + <module>camel-zipkin</module> <module>camel-zookeeper</module> </modules>
