Track support of 128 bit X-B3-TraceId #6

codefromthecrypt · 2016-09-14T04:22:13Z

A 128-bit trace ID is when X-B3-TraceId has 32 hex characters as opposed to 16. For example, X-B3-TraceId: 463ac35c9f6413ad48485a3953bb6124.

Here are the status options for 128bit X-B3-TraceId:

unsupported: 32 character trace ids will break the library
downgrade: Read 32 character trace ids by throwing away the high bits (any characters left of 16 characters). This effectively downgrades the ID to 64 bits.
transparent: Pass X-B3-TraceId through the system without interpreting it.
supported: Can start traces with 128-bit trace IDs, propagates and reports them as 128-bits
epoch128: Can start traces with 128-bit trace IDs which are prefixed with epoch seconds

This is a list of zipkin libraries and their status in supporting 128-bit trace IDs

library	version	status	notes
zipkin-js	0.5+	supported	`new Tracer({..., traceId128Bit: true})`
pyramid_zipkin	0.16+	downgrade
brave	3.15+/4.9+	supported/epoch128	https://github.com/openzipkin/brave/tree/master/brave-core#128-bit-trace-ids
spring-cloud-sleuth	1.0.11+/1.2.6+	supported/epoch128	set `spring.sleuth.traceId128=true`
finagle	0.40+	downgrade
zipkin-ruby		unsupported	depends on twitter/finagle#565
ZipkinTracerModule	3.2+	supported	`Create128BitTraceId(true)`
zipkin-go-opentracing	0.2+	supported	https://godoc.org/github.com/openzipkin/zipkin-go-opentracing#TraceID128Bit
akka-tracing	0.5.2+	downgrade
wingtips	0.11.2+	transparent
jaeger	0.10+	downgrade
zipkin4net	0.4+	supported

epoch128

When a trace ID is 128-bits and the first 32 bits are epoch seconds, the ID can be translated into
an Amazon Web Services ID. Tracers who do this can tunnel through ELBs, for example.

Here's an example implementation

  static long nextTraceIdHigh(Random prng) {
    long epochSeconds = System.currentTimeMillis() / 1000;
    int random = prng.nextInt();
    return (epochSeconds & 0xffffffffL) << 32
        |  (random & 0xffffffffL);
  }

See openzipkin/zipkin#1754

The text was updated successfully, but these errors were encountered:

The first step of transitioning to 128bit `X-B3-TraceId` is tolerantly reading 32 character long ids by throwing away the high bits (any characters left of 16 characters). This allows the tracing system to more flexibly introduce 128bit trace id support in the future. Ex. when `X-B3-TraceId: 463ac35c9f6413ad48485a3953bb6124` is received, parse the lower 64 bits (right most 16 characters ex48485a3953bb6124) as the trace id. See openzipkin/b3-propagation#6

codefromthecrypt · 2016-09-20T10:06:03Z

ps I'm clicking "check" when a pull request is raised, and noting the version, once released.

basvanbeek · 2016-10-07T20:36:26Z

@adriancole I've updated zipkin-go-opentracing to tolerate 128bit traceID's and have sent a PR to monkit-zipkin. The other listed Go tracer go-zipkin does not have B3 propagation and uses a custom Avro encoding over Kafka so we don't have to deal with them on this issue.

codefromthecrypt · 2016-10-08T01:07:06Z

thanks for the help @basvanbeek

codefromthecrypt · 2016-10-11T01:47:27Z

Ok, this phase is nearly complete. Almost all libraries have merged code, except akka and .net (cc @levkhomich @jcarres-mdsol)

I think this is close enough to start doing other work, such as supporting server-side effort

codefromthecrypt · 2016-10-11T01:50:54Z

side-note cloud foundry gorouter doesn't seem to interpret the X-B3-TraceId header, so doesn't seem to need any work here https://github.com/cloudfoundry/gorouter/blob/4d9497354baaf103310cc7c78a3fb5ccf69e6016/common/http/headers_test.go

* Support for MySQL 5.7 with SQL_MODE=ONLY_FULL_GROUP_BY * Includes support to store 128-bit trace ID (not yet implemented here) See openzipkin/b3-propagation#6

This supports 128-bit traces via a new field traceIdHigh, which matches other zipkin implementations. In encoded form, the trace ID is simply twice as long (32 hex characters). With this change in, a 128-bit trace propagated will not be downgraded to 64-bits when sending downstream, reporting to Zipkin or adding to the logging context. This will be followed by a change to support initiating 128-bit traces. See openzipkin/b3-propagation#6

codefromthecrypt · 2016-11-21T08:31:26Z

added this to support 128-bit traces in zipkin-js openzipkin/zipkin-js#57

This adds `XRayUDPReporter` which defaults to localhost:2000 or AWS_XRAY_DAEMON_ADDRESS. This can be used in applications directly or integrated with a zipkin-server where `STORAGE_TYPE=xray` Note: this is experimental and makes assumptions about trace ID format: See openzipkin/b3-propagation#6

codefromthecrypt · 2018-09-17T10:25:13Z

Tracking moved here https://cwiki.apache.org/confluence/display/ZIPKIN/128-bit+Trace+ID

The first step of transitioning to 128bit `X-B3-TraceId` is tolerantly reading 32 character long ids by throwing away the high bits (any characters left of 16 characters). This allows the tracing system to more flexibly introduce 128bit trace id support in the future. Ex. when `X-B3-TraceId: 463ac35c9f6413ad48485a3953bb6124` is received, parse the lower 64 bits (right most 16 characters ex48485a3953bb6124) as the trace id. See openzipkin/b3-propagation#6

This was referenced Sep 14, 2016

What should a trace id and span id look like? #5

Open

Transition to 128bit trace ids (still 64bit span ids) openzipkin/zipkin#1298

Closed

codefromthecrypt mentioned this issue Sep 15, 2016

Tolerate reads of 128 bit X-B3-TraceId spring-cloud/spring-cloud-sleuth#408

Merged

This was referenced Sep 15, 2016

Tolerate reads of 128 bit X-B3-TraceId openzipkin/brave#239

Merged

Tolerate reads of 128 bit X-B3-TraceId jaegertracing/jaeger-client-java#52

Merged

Tolerate reads of 128 bit X-B3-TraceId Nike-Inc/wingtips#28

Merged

codefromthecrypt mentioned this issue Sep 15, 2016

Don't break on 128bit X-B3-TraceId by tossing high bits twitter/finagle#552

Closed

codefromthecrypt mentioned this issue Sep 19, 2016

Tolerate reads of 128 bit X-B3-TraceId openzipkin/zipkin-js#42

Merged

codefromthecrypt mentioned this issue Sep 22, 2016

Tolerates reads of 128 bit X-B3-TraceId Yelp/pyramid_zipkin#61

Merged

codefromthecrypt mentioned this issue Oct 5, 2016

zipkin module sans automated tests http4s/http4s#698

Closed

This was referenced Oct 7, 2016

Tolerate 128bit trace ids by throwing out high bits openzipkin-contrib/zipkin-go-opentracing#30

Merged

Tolerate 128bit ids by throwing out high bits spacemonkeygo/monkit-zipkin#3

Closed

This was referenced Oct 11, 2016

Don't break on 128bit X-B3-TraceId by tossing high bits mdsol/Medidata.ZipkinTracerModule#96

Open

Don't break on 128bit X-B3-TraceId by tossing high bits levkhomich/akka-tracing#84

Closed

codefromthecrypt changed the title ~~Track tolerant reads of 128 bit X-B3-TraceId~~ Track support of 128 bit X-B3-TraceId Nov 2, 2016

codefromthecrypt mentioned this issue Nov 5, 2016

Updates to zipkin 1.14.4 spring-cloud/spring-cloud-sleuth#441

Merged

codefromthecrypt mentioned this issue Nov 14, 2016

[MCC-261721] Don't break on 128bit X-B3-TraceId by tossing high bits mdsol/Medidata.ZipkinTracerModule#100

Merged

This was referenced Nov 17, 2016

Propagates logs and reports 128-bit trace IDs spring-cloud/spring-cloud-sleuth#452

Merged

Reports 128-bit ids to Zipkin Nike-Inc/wingtips#34

Merged

codefromthecrypt mentioned this issue Dec 20, 2016

Updates to latest zipkin and switches to 128-bit trace IDs openzipkin/zipkin-gcp#10

Merged

codefromthecrypt mentioned this issue Jul 12, 2017

Support 128bit trace IDs openzipkin/zipkin4net#86

Closed

codefromthecrypt mentioned this issue Aug 10, 2017

default to 128-bit traceids Yelp/py_zipkin#58

Open

codefromthecrypt mentioned this issue Oct 17, 2017

Working XRayUDPReporter and STORAGE_TYPE xray openzipkin/zipkin-aws#56

Merged

codefromthecrypt mentioned this issue Jan 11, 2018

Speed up id generation Yelp/py_zipkin#65

Merged

jimschubert mentioned this issue Apr 3, 2018

Enable propagation of 128-bit TraceID twitter/finagle#651

Closed

ykitamura-mdsol mentioned this issue May 10, 2018

Support 128-bit trace IDs openzipkin/zipkin-ruby#121

Merged

codefromthecrypt mentioned this issue May 21, 2018

tracing: Support 128bit trace id with zipkin tracer envoyproxy/envoy#3386

Merged

codefromthecrypt closed this as completed Sep 17, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Track support of 128 bit X-B3-TraceId #6

Track support of 128 bit X-B3-TraceId #6

codefromthecrypt commented Sep 14, 2016 •

edited

Loading

codefromthecrypt commented Sep 20, 2016

basvanbeek commented Oct 7, 2016

codefromthecrypt commented Oct 8, 2016

codefromthecrypt commented Oct 11, 2016 •

edited

Loading

codefromthecrypt commented Oct 11, 2016

codefromthecrypt commented Nov 21, 2016 •

edited

Loading

codefromthecrypt commented Sep 17, 2018

Track support of 128 bit X-B3-TraceId #6

Track support of 128 bit X-B3-TraceId #6

Comments

codefromthecrypt commented Sep 14, 2016 • edited Loading

epoch128

codefromthecrypt commented Sep 20, 2016

basvanbeek commented Oct 7, 2016

codefromthecrypt commented Oct 8, 2016

codefromthecrypt commented Oct 11, 2016 • edited Loading

codefromthecrypt commented Oct 11, 2016

codefromthecrypt commented Nov 21, 2016 • edited Loading

codefromthecrypt commented Sep 17, 2018

codefromthecrypt commented Sep 14, 2016 •

edited

Loading

codefromthecrypt commented Oct 11, 2016 •

edited

Loading

codefromthecrypt commented Nov 21, 2016 •

edited

Loading