Cloud Native Distributing Tracing for Node.js

Table of Contents

• Run the App
• Jaeger using Docker
• Jaeger using Docker Compose
• Jaeger using Kubernetes
• Installing Istio on Minikube
• Jaeger with Istio on Kubernetes
• Istio Bookinfo Sample
• Contributing to this repository

Run the App

Git clone this repo

git clone --depth 1 https://.../cloudnative-tracing cloudnative-tracing

Install nodejs 12.x, I recommend using nvm

nvm install 12.1.0
nvm use 12.1.0

Try the app with VSCode Run Debug "Launch via NPM" task, it specifies runtimeVersion 12.1.0, for more information on Debug with NodeJS and runtime version see here https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_multi-version-support Make sure you have nvm or nvs install and install the node version for example node v12.1.0

Try the app locally

pushd app-rates
npm install
npm start

App starts and listens on port http://localhost:8080 Do Ctrl+C to close App

Build docker image

docker build app-rates -t app-rates

Run docker image and expose port 8080

docker run --rm -p 8080:8080 app-rates

Test rates API

curl http://localhost:8080/rates

Jaeger using Docker

Using Jaeger locally with Docker

Will launch the two containers in docker, since they will share the same subnet the jaeger data should will be transported using the Jaeger Client using UDP (jaeger:6832)

Start Jaeger container

docker run --rm --name jaeger \
  -p 16686:16686 \
  jaegertracing/all-in-one:1.11 \
  --log-level=debug

Start the node.js app container with --link jaeger to link the hostname jaeger to the IP Address of the jaeger container, and pass the env variable JAEGER_AGENT_HOST to pass the hostname to the tracer

docker run --rm --name app-rates -it \
--link jaeger \
--env JAEGER_AGENT_HOST="jaeger" \
-p 8080:8080 \
app-rates

Jaeger using Docker Compose

Instead of running each docker seperately you can bring all containers at once using docker-compose

To start all containers

docker-compose up -d

To stop and remove containers

docker-compose down

Trace the Application

Open the browser for the nodejs.app http://localhost:8080

Try the calling the API http://localhost:8080/rates a couple of times to report some traces

Now open a Browser to load the Frontend UI on http://localhost:16686 click search button

In the drop down select the Service rates-services

Click Find Traces at the bottom to find the traces

Select one of the traces to inspect the spans

Tracing client libraries

There are many client libraries for opentracing, jaeger, and zipkin pickig the corrent ones can be a challenge

• OpenTracing
  • https://github.com/opentracing/opentracing-javascript (on npm opentracing)
  • https://opentracing.io/guides/javascript/
• Jaeger
  • https://github.com/jaegertracing/jaeger-client-node (on npm jaeger-client)
  • https://www.jaegertracing.io/docs/1.11/client-features/
• OpenTracing Contrib
  • https://github.com/opentracing-contrib/javascript-express (on npm express-opentracing)
  • We are not going to this library an instead use our own custom version of it in app-rates/lib/tracing-middleware.js

Resources

• Repo for the book Mastering Distributed Tracing by Yuri Shkuro https://github.com/PacktPublishing/Mastering-Distributed-Tracing
• OpenTracing Tutorial https://github.com/yurishkuro/opentracing-tutorial
• OpenTracing API Documentation https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/identifiers.html