Added instructions on how to use the Zipkin Development Vagrant Box
Bas van Beek
8 years ago
| 13 | 13 | hot spots, and diagnosing errors. All microservice infrastructures will |
| 14 | 14 | benefit from request tracing; sufficiently large infrastructures will require |
| 15 | 15 | it. |
| 16 | ||
| 17 | ## Test Setup | |
| 18 | ||
| 19 | Setting up [Zipkin] is not an easy thing to do. It will also demand quite some | |
| 20 | resources. To help you get started with development and testing we've made a | |
| 21 | [VirtualBox] image available through [Vagrant] (*The box will require about 6GB | |
| 22 | internal memory*). | |
| 23 | ||
| 24 | First make sure you've installed [Vagrant] on your machine. Then you can | |
| 25 | download and run the [Vagrant] image like this from the command line: | |
| 26 | ||
| 27 | ``` | |
| 28 | # create a new directory to store your vagrant configuration and image files | |
| 29 | mkdir zipkin | |
| 30 | cd zipkin | |
| 31 | vagrant init bas303/zipkin | |
| 32 | vagrant-up --provider virtualbox | |
| 33 | ``` | |
| 34 | ||
| 35 | [Zipkin]: http://zipkin.io/ | |
| 36 | [VirtualBox]: https://www.virtualbox.org/ | |
| 37 | [Vagrant]: https://www.vagrantup.com/ | |
| 38 | ||
| 39 | You probably need to adjust the `Vagrantfile` configuration to meet your | |
| 40 | networking needs. The file itself is documented so should not be hard to get | |
| 41 | configured. After the change you can reload your box with the updated settings | |
| 42 | like this: | |
| 43 | ||
| 44 | ``` | |
| 45 | vagrant reload | |
| 46 | ``` | |
| 47 | ||
| 48 | As mentioned the box is quite heavy and may take a few minutes to fully boot up. | |
| 49 | To get into the box connect through ssh and use `vagrant` for both username and | |
| 50 | password. | |
| 51 | ||
| 52 | The following services have been set-up to run: | |
| 53 | - Apache ZooKeeper (port: 2181) | |
| 54 | - Apache Kafka (port: 9092) | |
| 55 | - MySQL Server 5.5 (port: 3306) | |
| 56 | - Zipkin Collector (Kafka, MySQL) | |
| 57 | - Zipkin Query (MySQL) | |
| 58 | - Zipkin Web (port: 8080, 9990) | |
| 59 | ||
| 60 | To inspect if everything booted up properly check the log files in these | |
| 61 | directories: | |
| 62 | ``` | |
| 63 | /var/log/zookeeper | |
| 64 | /var/log/kafka | |
| 65 | /var/log/mysql | |
| 66 | /var/log/zipkin | |
| 67 | ``` | |
| 68 | ||
| 69 | The individual services can be managed with the `service` command: | |
| 70 | - zookeeper | |
| 71 | - kafka | |
| 72 | - mysql | |
| 73 | - collector | |
| 74 | - query | |
| 75 | - web | |
| 16 | 76 | |
| 17 | 77 | ## Usage |
| 18 | 78 |