├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── client
├── client.js
├── css
│ └── styles.css
├── img
│ ├── donut-choc.jpg
│ ├── donut-cinn.jpg
│ ├── donut-glazed.png
│ ├── donut-jelly.jpg
│ ├── donut-old-fash.jpg
│ ├── donut-sprinkles.png
│ └── donuts.png
├── index.html
├── js
│ └── jquery-3.2.0.min.js
└── order.js
└── microdonuts
├── Makefile
├── config.properties
├── ls_tracer.properties
├── pom.xml
└── src
└── main
└── java
└── com
└── otsample
└── api
├── ApiContextHandler.java
├── App.java
├── KitchenConsumer.java
├── KitchenContextHandler.java
├── KitchenService.java
├── Utils.java
└── resources
├── Donut.java
├── DonutAddRequest.java
├── DonutRequest.java
├── Status.java
├── StatusReq.java
└── StatusRes.java
/.gitignore:
--------------------------------------------------------------------------------
1 | *.class
2 | *.log
3 |
4 | *.jar
5 | *.war
6 | *.ear
7 | *.zip
8 | *.tar.gz
9 | *.rar
10 | *.iml
11 |
12 | target/
13 | .idea
14 | pom.xml.tag
15 | pom.xml.releaseBackup
16 | pom.xml.versionsBackup
17 | pom.xml.next
18 | release.properties
19 | dependency-reduced-pom.xml
20 | buildNumber.properties
21 | .mvn/timing.properties
22 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | sudo: false
2 | dist: trusty
3 |
4 | cache:
5 | directories:
6 | - $HOME/.m2
7 |
8 | language: java
9 |
10 | jdk:
11 | - oraclejdk8
12 |
13 | addons:
14 | apt:
15 | packages:
16 | - oracle-java8-installer
17 |
18 | script:
19 | - cd microdonuts && make build
20 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # MicroDonuts: An OpenTracing SpecialAgent Demo
2 |
3 | [](https://travis-ci.org/opentracing-contrib/java-specialagent-demo)
4 |
5 | Welcome to MicroDonuts! This is a [SpecialAgent](https://github.com/opentracing-contrib/java-specialagent)
6 | demo application, written in Java, based on the original [OpenTracing walkthrough](https://github.com/opentracing-contrib/java-opentracing-walkthrough).
7 |
8 | OpenTracing is a vendor-neutral, open standard for distributed tracing. To
9 | learn more, check out [opentracing.io](http://opentracing.io), and try the
10 | demo application below!
11 |
12 | ## Step 0: Setup MicroDonuts
13 |
14 | ### Getting it
15 | Clone this repository and build the jar file (for this, Maven must be
16 | installed):
17 |
18 | ```bash
19 | git clone git@github.com:opentracing-contrib/java-specialagent-demo.git
20 | cd java-specialagent-demo/microdonuts
21 | make
22 | ```
23 |
24 | ### Running
25 |
26 | MicroDonuts has two server components, `API` and `Kitchen`, which
27 | communicate each other over HTTP - they are, however, part of
28 | the same process:
29 |
30 | ```bash
31 | cd java-specialagent-demo/microdonuts
32 | make run-no-agent
33 | ```
34 |
35 | In your web broswer, navigate to http://127.0.0.1:10001 and order yourself some
36 | µ-donuts.
37 |
38 | ### Run with the SpecialAgent and a Tracer
39 |
40 | First, please download the latest [SpecialAgent JAR](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=io.opentracing.contrib.specialagent&a=opentracing-specialagent&v=LATEST)
41 | and move it to the microdonuts directory:
42 |
43 | ```bash
44 | mv opentracing-specialagent-*.jar microdonuts/
45 | ```
46 |
47 | #### Jaeger
48 |
49 | To run Jaeger locally ([via Docker](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one)):
50 |
51 | ```bash
52 | $ docker run -d --name jaeger \
53 | -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
54 | -p 5775:5775/udp \
55 | -p 6831:6831/udp \
56 | -p 6832:6832/udp \
57 | -p 5778:5778 \
58 | -p 16686:16686 \
59 | -p 14268:14268 \
60 | -p 14250:14250 \
61 | -p 9411:9411 \
62 | jaegertracing/all-in-one::latest
63 | ```
64 |
65 | To run MicroDonuts with Jaegger, configuration has to be specified through
66 | [environment variables](https://github.com/jaegertracing/jaeger-client-java/blob/master/jaeger-core/README.md):
67 |
68 | ```bash
69 | cd microdonuts
70 | make run-with-jaeger
71 | ```
72 |
73 | Note that the all-in-one docker image presents the Jaeger UI at [localhost:16686](http://localhost:16686/).
74 |
75 | #### LightStep
76 |
77 | If you have access to [LightStep](https://go.lightstep.com/tracing.html), you will need your access token. Add the following to `ls_tracer.properties`:
78 |
79 | ```properties
80 | ls.accessToken=XXXXXXXXXXXXXXX // TODO: replace with your token
81 | ```
82 |
83 | To run MicroDonuts with LightStep:
84 |
85 | ```bash
86 | cd microdonuts
87 | make run-with-lightstep
88 | ```
89 |
90 | ### Provide your own Tracer
91 |
92 | A provided jar containing any `TracerFactory` provider can be used to run MicroDonuts too:
93 |
94 | ```bash
95 | cd microdonuts
96 | env TRACER_JAR=MyOwnTracer.jar make run-with-tracer-jar
97 | ```
98 |
99 | Now that we're all hooked up, try ordering some donuts in the browser. You
100 | should see the traces appear in your tracer.
101 |
102 | Search for traces starting belonging to the `MicroDonuts` component to see the
103 | patterns of requests that occur when you click the order button.
104 |
105 | ## Thanks for playing, and welcome to OpenTracing!
106 |
107 | Thanks for joining us in this walkthrough! Hope you enjoyed it. If you did, let
108 | us know, and consider spreading the love!
109 |
110 | A great way to get the feel for OpenTracing is to try your hand at
111 | instrumenting the OSS servers, frameworks, and client libraries that we all
112 | share. If you make one, consider adding it to the growing ecosystem at
113 | http://github.com/opentracing-contrib. If you maintain a library yourself,
114 | plase consider adding built-in OT support.
115 |
116 | We also need walkthroughs for languages other than Golang. Feel free to reuse
117 | the client, protobufs, and other assets from here if you'd like to make one.
118 |
119 | For a more detailed explanation of OSS Instrumentation, check out the Turnkey
120 | Tracing proposal at http://bit.ly/turnkey-tracing.
121 |
122 | _Aloha!_
--------------------------------------------------------------------------------
/client/client.js:
--------------------------------------------------------------------------------
1 | $(function() {
2 | var order = new Order();
3 |
4 | $(".donut-btn").click(function(e){
5 | order.addDonut($(e.target).data("flavor"));
6 | render(order);
7 | });
8 |
9 | $("#order-btn").click(function(e){
10 | orderDonuts(order);
11 | });
12 | });
13 |
14 | function orderDonuts(order){
15 | order.activate()
16 | render(order)
17 | console.log("order")
18 | $.ajax('/order', {
19 | data: JSON.stringify({
20 | donuts: order.items(),
21 | }),
22 | method: 'POST',
23 | success: function(order_status) {
24 | console.log(order_status)
25 | order.setStatus(JSON.parse(order_status))
26 | render(order)
27 | pollStatus(order)
28 | },
29 | });
30 | }
31 |
32 | function pollStatus(order){
33 | if(!order.isActive()){
34 | return
35 | }
36 | setTimeout(function(){
37 | console.log("status");
38 | $.ajax('/status', {
39 | data: JSON.stringify({
40 | order_id: order.orderID(),
41 | }),
42 | method: 'POST',
43 | success: function(order_status) {
44 | console.log(order_status);
45 | order.setStatus(JSON.parse(order_status));
46 |
47 | if(!order.isDelivered()) {
48 | render(order);
49 | pollStatus(order);
50 | return
51 | }
52 |
53 | order.complete();
54 | render(order);
55 | },
56 | });
57 | },1000);
58 | }
59 |
60 | function render(order){
61 | renderCart(order);
62 | renderStatus(order);
63 | }
64 |
65 | function renderCart(order){
66 | if(!order.isOpen()){
67 | $("#shopping-cart").css("display","none");
68 | return;
69 | }
70 |
71 | var $items = $("#shopping-cart-items").empty();
72 | $.each(order.items(),function(i,item){
73 | $('