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/70633c41 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/70633c41 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/70633c41 Branch: refs/heads/master Commit: 70633c413bb4176f87a20c7ad22e6adb6fd22f5a Parents: e4ae4fb Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Mar 29 21:39:38 2016 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Wed Mar 30 11:12:28 2016 +0200 ---------------------------------------------------------------------- apache-camel/pom.xml | 4 + .../src/main/descriptors/common-bin.xml | 1 + components/camel-zipkin-starter/pom.xml | 60 ++++++ .../camel/zipkin/starter/CamelZipkin.java | 34 ++++ .../zipkin/starter/ZipkinAutoConfiguration.java | 51 +++++ .../starter/ZipkinConfigurationProperties.java | 90 ++++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../main/resources/META-INF/spring.factories | 19 ++ .../camel/zipkin/ZipkinEventNotifier.java | 52 ++++- .../zipkin/ZipkinServerRequestAdapter.java | 2 +- examples/camel-example-zipkin/pom.xml | 102 ++++++++++ .../src/main/java/sample/camel/HelloBean.java | 38 ++++ .../java/sample/camel/HelloCamelRouter.java | 37 ++++ .../sample/camel/ZipkinCamelApplication.java | 39 ++++ .../src/main/resources/application.properties | 35 ++++ .../camel/ZipkinCamelApplicationTest.java | 47 +++++ examples/pom.xml | 3 +- parent/pom.xml | 5 + 19 files changed, 820 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/apache-camel/pom.xml ---------------------------------------------------------------------- diff --git a/apache-camel/pom.xml b/apache-camel/pom.xml index 264f2fe..454232c 100644 --- a/apache-camel/pom.xml +++ b/apache-camel/pom.xml @@ -952,6 +952,10 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> + <artifactId>camel-zipkin-starter</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> <artifactId>camel-zookeeper</artifactId> </dependency> http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/apache-camel/src/main/descriptors/common-bin.xml ---------------------------------------------------------------------- diff --git a/apache-camel/src/main/descriptors/common-bin.xml b/apache-camel/src/main/descriptors/common-bin.xml index fcbc250..a70adc6 100644 --- a/apache-camel/src/main/descriptors/common-bin.xml +++ b/apache-camel/src/main/descriptors/common-bin.xml @@ -248,6 +248,7 @@ <include>org.apache.camel:camel-yammer</include> <include>org.apache.camel:camel-zipfile</include> <include>org.apache.camel:camel-zipkin</include> + <include>org.apache.camel:camel-zipkin-starter</include> <include>org.apache.camel:camel-zookeeper</include> <include>org.apache.camel:camel-catalog</include> <include>org.apache.camel:camel-catalog-lucene</include> http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/components/camel-zipkin-starter/pom.xml ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/pom.xml b/components/camel-zipkin-starter/pom.xml new file mode 100644 index 0000000..42239b5 --- /dev/null +++ b/components/camel-zipkin-starter/pom.xml @@ -0,0 +1,60 @@ +<?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> + <groupId>org.apache.camel</groupId> + <artifactId>components</artifactId> + <version>2.18-SNAPSHOT</version> + </parent> + + <artifactId>camel-zipkin-starter</artifactId> + <name>Camel :: Zipkin :: Starter</name> + <description>Camel Zipkin Spring Boot Starter</description> + + <dependencies> + + <!-- spring-boot --> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <optional>true</optional> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-configuration-processor</artifactId> + <optional>true</optional> + <version>${spring-boot-version}</version> + </dependency> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-spring-boot-starter</artifactId> + </dependency> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-zipkin</artifactId> + </dependency> + + </dependencies> + +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/CamelZipkin.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/CamelZipkin.java b/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/CamelZipkin.java new file mode 100644 index 0000000..823c889 --- /dev/null +++ b/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/CamelZipkin.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.starter; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Inherited; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.springframework.context.annotation.Import; + +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@Documented +@Inherited +@Import(ZipkinAutoConfiguration.class) +public @interface CamelZipkin { +} http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinAutoConfiguration.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinAutoConfiguration.java b/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinAutoConfiguration.java new file mode 100644 index 0000000..c640068 --- /dev/null +++ b/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinAutoConfiguration.java @@ -0,0 +1,51 @@ +/** + * 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.starter; + +import org.apache.camel.CamelContext; +import org.apache.camel.zipkin.ZipkinEventNotifier; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableConfigurationProperties(ZipkinConfigurationProperties.class) +@ConditionalOnProperty(value = "camel.zipkin.enabled", matchIfMissing = true) +public class ZipkinAutoConfiguration { + + @Bean(initMethod = "", destroyMethod = "") + // Camel handles the lifecycle of this bean + @ConditionalOnMissingBean(ZipkinEventNotifier.class) + ZipkinEventNotifier zipkinEventNotifier(CamelContext camelContext, + ZipkinConfigurationProperties configurationProperties) { + + ZipkinEventNotifier notifier = new ZipkinEventNotifier(); + notifier.setHostName(configurationProperties.getHostName()); + notifier.setPort(configurationProperties.getPort()); + notifier.setRate(configurationProperties.getRate()); + notifier.setServiceName(configurationProperties.getServiceName()); + notifier.setIncludeMessageBody(configurationProperties.isIncludeMessageBody()); + + // register the bean into CamelContext + camelContext.getManagementStrategy().addEventNotifier(notifier); + + return notifier; + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinConfigurationProperties.java ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinConfigurationProperties.java b/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinConfigurationProperties.java new file mode 100644 index 0000000..0714819 --- /dev/null +++ b/components/camel-zipkin-starter/src/main/java/org/apache/camel/zipkin/starter/ZipkinConfigurationProperties.java @@ -0,0 +1,90 @@ +/** + * 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.starter; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +@ConfigurationProperties(prefix = "camel.zipkin") +public class ZipkinConfigurationProperties { + + private String hostName; + private int port; + private float rate = 1.0f; + private boolean includeMessageBody; + private String serviceName; + + public String getHostName() { + return hostName; + } + + /** + * Sets a hostname for the remote zipkin server to use. + */ + public void setHostName(String hostName) { + this.hostName = hostName; + } + + public int getPort() { + return port; + } + + /** + * Sets the port number for the remote zipkin server to use. + */ + public void setPort(int port) { + this.port = port; + } + + public float getRate() { + return rate; + } + + /** + * Configures a rate that decides how many events should be traced by zipkin. + * The rate is expressed as a percentage (1.0f = 100%, 0.5f is 50%, 0.1f is 10%). + * + * @param rate minimum sample rate is 0.0001, or 0.01% of traces + */ + public void setRate(float rate) { + this.rate = rate; + } + + public boolean isIncludeMessageBody() { + return includeMessageBody; + } + + /** + * Whether to include the Camel message body in the zipkin traces. + * <p/> + * This is not recommended for production usage, or when having big payloads. You can limit the size by + * configuring the <a href="http://camel.apache.org/how-do-i-set-the-max-chars-when-debug-logging-messages-in-camel.html">max debug log size</a>. + */ + public void setIncludeMessageBody(boolean includeMessageBody) { + this.includeMessageBody = includeMessageBody; + } + + public String getServiceName() { + return serviceName; + } + + /** + * To use a global service name that matches all Camel events + */ + public void setServiceName(String serviceName) { + this.serviceName = serviceName; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/components/camel-zipkin-starter/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/src/main/resources/META-INF/LICENSE.txt b/components/camel-zipkin-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100755 index 0000000..6b0b127 --- /dev/null +++ b/components/camel-zipkin-starter/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/70633c41/components/camel-zipkin-starter/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/src/main/resources/META-INF/NOTICE.txt b/components/camel-zipkin-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/components/camel-zipkin-starter/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/70633c41/components/camel-zipkin-starter/src/main/resources/META-INF/spring.factories ---------------------------------------------------------------------- diff --git a/components/camel-zipkin-starter/src/main/resources/META-INF/spring.factories b/components/camel-zipkin-starter/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000..de0afda --- /dev/null +++ b/components/camel-zipkin-starter/src/main/resources/META-INF/spring.factories @@ -0,0 +1,19 @@ +# +# 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. +# + +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.apache.camel.zipkin.starter.ZipkinAutoConfiguration \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/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 index 9c78d34..27286fa 100644 --- 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 @@ -38,6 +38,8 @@ import org.apache.camel.Exchange; import org.apache.camel.StatefulService; import org.apache.camel.api.management.ManagedAttribute; import org.apache.camel.api.management.ManagedResource; +import org.apache.camel.component.properties.ServiceHostPropertiesFunction; +import org.apache.camel.component.properties.ServicePortPropertiesFunction; import org.apache.camel.management.event.ExchangeCompletedEvent; import org.apache.camel.management.event.ExchangeCreatedEvent; import org.apache.camel.management.event.ExchangeFailedEvent; @@ -70,7 +72,7 @@ import static org.apache.camel.builder.ExpressionBuilder.routeIdExpression; * However its recommended to configure service mappings so you can use human logic names instead of Camel * endpoint uris in the names. * <p/> - * Camel will auto-configure a {@link ScribeSpanCollector} if no SpanCollector has explict been configured, and + * Camel will auto-configure a {@link ScribeSpanCollector} if no SpanCollector explicit has been configured, and * if the hostname and port has been configured as environment variables * <ul> * <li>ZIPKIN_SERVICE_HOST - The hostname</li> @@ -81,6 +83,8 @@ import static org.apache.camel.builder.ExpressionBuilder.routeIdExpression; public class ZipkinEventNotifier extends EventNotifierSupport implements StatefulService, CamelContextAware { private CamelContext camelContext; + private String hostName; + private int port; private float rate = 1.0f; private SpanCollector spanCollector; private Map<String, String> serviceMappings = new HashMap<>(); @@ -100,12 +104,34 @@ public class ZipkinEventNotifier extends EventNotifierSupport implements Statefu this.camelContext = camelContext; } + public String getHostName() { + return hostName; + } + + /** + * Sets a hostname for the remote zipkin server to use. + */ + public void setHostName(String hostName) { + this.hostName = hostName; + } + + public int getPort() { + return port; + } + + /** + * Sets the port number for the remote zipkin server to use. + */ + public void setPort(int port) { + this.port = port; + } + public float getRate() { return rate; } /** - * Configures a rate that decides how many events should be traced by zpkin. + * Configures a rate that decides how many events should be traced by zipkin. * The rate is expressed as a percentage (1.0f = 100%, 0.5f is 50%, 0.1f is 10%). * * @param rate minimum sample rate is 0.0001, or 0.01% of traces @@ -145,7 +171,7 @@ public class ZipkinEventNotifier extends EventNotifierSupport implements Statefu } /** - * Adds a service mapping that matches Camel events to the given zipkin serivce name. + * Adds a service mapping that matches Camel events to the given zipkin service name. * See more details at the class javadoc. * * @param pattern the pattern such as route id, endpoint url @@ -195,14 +221,18 @@ public class ZipkinEventNotifier extends EventNotifierSupport implements Statefu ObjectHelper.notNull(camelContext, "CamelContext", this); if (spanCollector == null) { - // is there a zipkin service setup as ENV variable to auto register a scribe span collector - // use the {{service:name}} function that resolves this for us - String host = camelContext.resolvePropertyPlaceholders("{{service.host:zipkin}}"); - String port = camelContext.resolvePropertyPlaceholders("{{service.port:zipkin}}"); - if (ObjectHelper.isNotEmpty(host) && ObjectHelper.isNotEmpty(port)) { - log.info("Auto-configuring Zipkin ScribeSpanCollector using host: {} and port: {}", host, port); - int num = camelContext.getTypeConverter().mandatoryConvertTo(Integer.class, port); - spanCollector = new ScribeSpanCollector(host, num); + if (hostName != null && port > 0) { + log.info("Configuring Zipkin ScribeSpanCollector using host: {} and port: {}", hostName, port); + spanCollector = new ScribeSpanCollector(hostName, port); + } else { + // is there a zipkin service setup as ENV variable to auto register a scribe span collector + String host = new ServiceHostPropertiesFunction().apply("zipkin"); + String port = new ServicePortPropertiesFunction().apply("zipkin"); + if (ObjectHelper.isNotEmpty(host) && ObjectHelper.isNotEmpty(port)) { + log.info("Auto-configuring Zipkin ScribeSpanCollector using host: {} and port: {}", host, port); + int num = camelContext.getTypeConverter().mandatoryConvertTo(Integer.class, port); + spanCollector = new ScribeSpanCollector(host, num); + } } } http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/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 index 8a6b787..0d7605d 100644 --- 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 @@ -50,7 +50,7 @@ public class ZipkinServerRequestAdapter implements ServerRequestAdapter { @Override public TraceData getTraceData() { - String sampled = exchange.getIn().getHeader(ZipkinConstants.SAMPLED, String.class); + String sampled = exchange.getIn().getHeader(ZipkinConstants.SAMPLED, "0", String.class); if (sampled.equals("0") || sampled.toLowerCase().equals("false")) { return TraceData.builder().sample(false).build(); } else { http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/camel-example-zipkin/pom.xml ---------------------------------------------------------------------- diff --git a/examples/camel-example-zipkin/pom.xml b/examples/camel-example-zipkin/pom.xml new file mode 100644 index 0000000..618d346 --- /dev/null +++ b/examples/camel-example-zipkin/pom.xml @@ -0,0 +1,102 @@ +<?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> + <groupId>org.apache.camel</groupId> + <artifactId>examples</artifactId> + <version>2.18-SNAPSHOT</version> + </parent> + + <artifactId>camel-example-zipkin</artifactId> + <name>Camel :: Example :: Zipkin</name> + <description>An example showing how to trace incoming and outgoing messages from Camel with Zipkin</description> + + <properties> + <spring.boot-version>${spring-boot-version}</spring.boot-version> + </properties> + + <!-- import Spring-Boot and Camel BOM --> + <dependencyManagement> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-dependencies</artifactId> + <version>${spring.boot-version}</version> + <type>pom</type> + <scope>import</scope> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-parent</artifactId> + <version>${project.version}</version> + <type>pom</type> + <scope>import</scope> + </dependency> + </dependencies> + </dependencyManagement> + + <dependencies> + + <!-- spring-web --> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-web</artifactId> + </dependency> + + <!-- camel --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-spring-boot-starter</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-zipkin-starter</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-stream</artifactId> + </dependency> + + <!-- test --> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-test</artifactId> + <scope>test</scope> + </dependency> + + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-maven-plugin</artifactId> + <version>${spring-boot-version}</version> + </plugin> + </plugins> + </build> + +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/camel-example-zipkin/src/main/java/sample/camel/HelloBean.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-zipkin/src/main/java/sample/camel/HelloBean.java b/examples/camel-example-zipkin/src/main/java/sample/camel/HelloBean.java new file mode 100644 index 0000000..88a8fcc --- /dev/null +++ b/examples/camel-example-zipkin/src/main/java/sample/camel/HelloBean.java @@ -0,0 +1,38 @@ +/** + * 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 sample.camel; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; + +/** + * A bean that returns a message when you call the {@link #saySomething()} method. + * <p/> + * Uses <tt>@Component("myBean")</tt> to register this bean with the name <tt>myBean</tt> + * that we use in the Camel route to lookup this bean. + */ +@Component("myBean") +public class HelloBean { + + @Value("${greeting}") + private String say; + + public String saySomething() { + return say; + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/camel-example-zipkin/src/main/java/sample/camel/HelloCamelRouter.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-zipkin/src/main/java/sample/camel/HelloCamelRouter.java b/examples/camel-example-zipkin/src/main/java/sample/camel/HelloCamelRouter.java new file mode 100644 index 0000000..e1a82fa --- /dev/null +++ b/examples/camel-example-zipkin/src/main/java/sample/camel/HelloCamelRouter.java @@ -0,0 +1,37 @@ +/** + * 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 sample.camel; + +import org.apache.camel.builder.RouteBuilder; +import org.springframework.stereotype.Component; + +/** + * A simple Camel route that triggers from a timer and calls a bean and prints to system out. + * <p/> + * Use <tt>@Component</tt> to make Camel auto detect this route when starting. + */ +@Component +public class HelloCamelRouter extends RouteBuilder { + + @Override + public void configure() throws Exception { + from("timer:hello?period={{timer.period}}") + .transform(method("myBean", "saySomething")) + .to("stream:out"); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/camel-example-zipkin/src/main/java/sample/camel/ZipkinCamelApplication.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-zipkin/src/main/java/sample/camel/ZipkinCamelApplication.java b/examples/camel-example-zipkin/src/main/java/sample/camel/ZipkinCamelApplication.java new file mode 100644 index 0000000..89be8fc --- /dev/null +++ b/examples/camel-example-zipkin/src/main/java/sample/camel/ZipkinCamelApplication.java @@ -0,0 +1,39 @@ +/** + * 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 sample.camel; + +import org.apache.camel.zipkin.starter.CamelZipkin; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +//CHECKSTYLE:OFF +/** + * A sample Spring Boot application that starts the Camel routes. + */ +@SpringBootApplication +@CamelZipkin +public class ZipkinCamelApplication { + + /** + * A main method to start this application. + */ + public static void main(String[] args) { + SpringApplication.run(ZipkinCamelApplication.class, args); + } + +} +//CHECKSTYLE:ON http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/camel-example-zipkin/src/main/resources/application.properties ---------------------------------------------------------------------- diff --git a/examples/camel-example-zipkin/src/main/resources/application.properties b/examples/camel-example-zipkin/src/main/resources/application.properties new file mode 100644 index 0000000..6d46306 --- /dev/null +++ b/examples/camel-example-zipkin/src/main/resources/application.properties @@ -0,0 +1,35 @@ +# +# 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 name of Camel +camel.springboot.name = ZipkinCamel + +# configure zipkin +camel.zipkin.host-name=192.168.99.100 +camel.zipkin.port=9410 + +camel.zipkin.service-name=hello +camel.zipkin.include-message-body=true + +# properties used in the Camel route and beans +# -------------------------------------------- + +# what to say +greeting = Hello World + +# how often to trigger the timer +timer.period = 2000 http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/camel-example-zipkin/src/test/java/sample/camel/ZipkinCamelApplicationTest.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-zipkin/src/test/java/sample/camel/ZipkinCamelApplicationTest.java b/examples/camel-example-zipkin/src/test/java/sample/camel/ZipkinCamelApplicationTest.java new file mode 100644 index 0000000..4f01694 --- /dev/null +++ b/examples/camel-example-zipkin/src/test/java/sample/camel/ZipkinCamelApplicationTest.java @@ -0,0 +1,47 @@ +/** + * 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 sample.camel; + +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.builder.NotifyBuilder; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.SpringApplicationConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +import static org.junit.Assert.assertTrue; + +@RunWith(SpringJUnit4ClassRunner.class) +@SpringApplicationConfiguration(ZipkinCamelApplication.class) +public class ZipkinCamelApplicationTest { + + @Autowired + private CamelContext camelContext; + + @Test + public void shouldProduceMessages() throws Exception { + // we expect that one or more messages is automatic done by the Camel + // route as it uses a timer to trigger + NotifyBuilder notify = new NotifyBuilder(camelContext).whenDone(1).create(); + + assertTrue(notify.matches(10, TimeUnit.SECONDS)); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/examples/pom.xml ---------------------------------------------------------------------- diff --git a/examples/pom.xml b/examples/pom.xml index d45926a..a8a08a9 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -94,7 +94,8 @@ <module>camel-example-twitter-websocket-blueprint</module> <module>camel-example-widget-gadget-cdi</module> <module>camel-example-widget-gadget-java</module> - <module>camel-example-widget-gadget-xml</module> + <module>camel-example-widget-gadget-xml</module> + <module>camel-example-zipkin</module> </modules> <properties> http://git-wip-us.apache.org/repos/asf/camel/blob/70633c41/parent/pom.xml ---------------------------------------------------------------------- diff --git a/parent/pom.xml b/parent/pom.xml index ccd520e..4b7aea0 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -1810,6 +1810,11 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> + <artifactId>camel-zipkin-starter</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> <artifactId>camel-zookeeper</artifactId> <version>${project.version}</version> </dependency>