README
1
2Money trace plugin
3 This is a remap plugin that allows ATS to participate in a distributed tracing system based upon
4 the Comcast "Money" distributed tracing and monitoring library. The Comcast "Money" library has
5 its roots in Google's Dapper and Twitters Zipkin systems. A money trace header or session id, is
6 attached to transaction and allows an operator with the appropriate logging systems in place,
7 to determine where errors and/or latency may exit.
8
9 Use of the library enables the tracing of a transaction through all systems that participate in
10 handling the request. See the documentation on this open source library at
11 https://github.com/Comcast/money/wiki.
12
13 This plugin checks incoming requests for the "X-MoneyTrace" header. If the header is not present
14 no further processing takes place. However if the header is present, the plugin will check to
15 to see if the request has been cached. If so, the plugin will add the "X-Moneytrace" header from the
16 incoming request to the cached response returned to the client as required by the money_trace
17 protocol. If the request has not been cached, the plugin will extends the trace context by creating a new
18 "X-MoneyTrace" header for inclusion in the outgoing request to a parent cache or origin server.
19 The extended header includes the 'trace-id' from the incoming request, the incoming span-id
20 becomes the outgoing parent-id and the plugin generates a new random long span id for the outgoing request.
21 See the documentation at the link above for a complete description on the "X-MoneyTrace" header and how
22 to use and extend it in a distributed tracing system.
23
24 To configure and use this plugin, simply add it in the remap.config file where needed. EXAMPLE:
25
26 map http://vod.foobar.com http://origin.vod.foobar.com @plugin=money_trace.so
27
28
29Plugin Author: John J. Rushford, jrushford@apache.org
30