isabella232 / pcf-metrics-trace-example-golang

PCF Metrics Go Tracer Example

This is a Go repository with three apps: shopping-cart, orders, and payments. These apps use custom middleware that carries X-B3-TraceId and X-B3-SpanId headers that the CF router injects to trace the calls between them. The traces can then be viewed in PCF-Metrics.

Creating your own tracer apps

To add tracing the following is necessary:

• Every subsequent request should have X-B3-TraceId and X-B3-SpanId headers with the values from the current request headers (see /middlewares/proxy_middleware)

Using the example apps

SET UP

Make sure GOPATH is set up. (e.g. export GOPATH=$HOME/go)

go get github.com/pivotal-cf/pcf-metrics-trace-example-golang

DEPLOY

To use the script, you must login as a user that has the ability to assign space permissions and make spaces. It will create a shopping-cart, orders, and payments app that can be used to preview an example trace. You will also need to set the SUFFIX environment variable to a unique identifier for your tracer applications.

For example

cf login
cd $GOPATH/src/github.com/pivotal-cf/pcf-metrics-trace-example-golang
./scripts/deploy.sh

CURL APPS

Curl the /checkout endpoint for the given shopping cart app.

For example

curl shopping-cart-test.cfapps.io/checkout

Viewing in PCF-Metrics

To view the trace in PCF-Metrics, go to the shopping-cart app in PCF-Metrics. Find the log corresponding to the /checkout endpoint and click the 'View in Trace Explorer' icon.

For example