GitHunt
SI

singram/openzipkin-demo

Experiments with the open zipkin framework

openzipkin-demo

Experiments with the open zipkin framework & pinpoint.

Goals

  • Explore opensource trace offerings applicable to micro services
  • Develop framework service the combines both internal and external services and apply both openzipkin and pinpoint to it.

Clone project

git clone git@github.com:singram/openzipkin-demo.git
git submodule init
git submodule update

Setup

Pre-requisites

  • Java 1.8
  • Docker
  • Docker-compose

Installation (debian base)

Install Docker

apt-get install apparmor lxc cgroup-lite
wget -qO- https://get.docker.com/ | sh
sudo usermod -aG docker YourUserNameHere
sudo service docker restart

Install Docker-compose (1.6+)

MAKE SURE YOU HAVE AN UP TO DATE VERSION OF DOCKER COMPOSE

To check the version:

docker-compose --version

To install the 1.6.0:

sudo su
curl -L https://github.com/docker/compose/releases/download/1.6.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
exit

Install supporting tools

sudo apt-get install jq

To build

Execute the following to run the services.

./ms build

Gradle daemon

To accelerate local development, it is recommended to run gradle daemonized. This is as simple as running the following

echo "org.gradle.daemon=true" >> ~/.gradle/gradle.properties

To run

With open-zipkin

./ms run_zipkin

With pinpoint

./ms run_zipkin

To access management portals

./ms portals

Note. While this will open all relevant webpages not all will be populated depending on whether zipkin or pinpoint instrumentation is running.

Overview

There are 3 key services

  • swapi-proxy
    -- A simple Spring Boot Java proxy service to the StarWars API which will cache returned data in Redis.
    -- e.g. curl localhost:8083/character/2 | jq .
  • quote-service
    -- A simple Sinatra Ruby application which randomly returns a quote loaded from a local file. For each call it also makes a call to www.google.com as an equivalent external dependancy to the swapi-proxy service
    -- e.g. curl localhost:4567/ | jq .
  • mashup-service
    -- A SpringBoot Java application which calls both swapi-proxy and quote-services blending the data together in a payload.
    -- e.g. curl localhost:8083/person/2 | jq .

To generate trace data execute

curl localhost:8083/person/2 | jq .

In the docker compose files the sample rate for both zipkin and pinpoint is set to 100%.

Debuging

Mysql

mysql -h 127.0.0.1 -u zipkin -pzipkin -D zipkin
SELECT HEX(trace_id), HEX(id), HEX(parent_id), name, debug, duration, start_ts FROM zipkin_spans where trace_id = <trace id of interest> order by start_ts;

References

Quote source

Open Zipkin

Pinpoint

Feign

Other

Java Annotations

Languages

Java60.7%Shell32.1%Ruby7.2%

Contributors

SI
GNU General Public License v3.0
Created May 23, 2016
Updated November 27, 2017
singram/openzipkin-demo | GitHunt