Skip to content

Commit

Permalink
Replaces fragile proto test setup with Square Wire (openzipkin#2532)
Browse files Browse the repository at this point in the history 
Square Wire is a lot simpler setup, and it doesn't require installation
of binaries to compile proto files. This helps us and also anyone who
will be doing ASF source verification.
  • Loading branch information
@adriancole @abesto
adriancole authored and abesto committed Sep 10, 2019
1 parent 3a9beaf commit 0aff76f
Show file tree
Hide file tree
Showing 4 changed files with 188 additions and 192 deletions.
43 changes: 17 additions & 26 deletions benchmarks/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@
<artifactId>guava</artifactId>
<version>${guava.version}</version>
</dependency>
<!-- for codec benchmarks -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
</dependency>

<dependency>
<groupId>com.esotericsoftware.kryo</groupId>
Expand All @@ -69,19 +74,26 @@
<artifactId>zipkin-server</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>io.zipkin.proto3</groupId>
<artifactId>zipkin-proto3</artifactId>
<groupId>com.squareup.wire</groupId>
<artifactId>wire-runtime</artifactId>
<version>${wire.version}</version>
</dependency>
<dependency>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<groupId>io.zipkin.proto3</groupId>
<artifactId>zipkin-proto3</artifactId>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-dependency-plugin</artifactId>
</plugin>
<plugin>
<groupId>com.squareup.wire</groupId>
<artifactId>wire-maven-plugin</artifactId>
</plugin>
<!-- disable retrolambda as we allow language level 1.8 benchmark classes -->
<plugin>
<groupId>net.orfjackal.retrolambda</groupId>
Expand All @@ -105,27 +117,6 @@
<skip>true</skip>
</configuration>
</plugin>
<!-- protobuf-maven-plugin cannot get proto definitions from dependencies, so we will -->
<plugin>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>unpack-proto</id>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.xolstice.maven.plugins</groupId>
<artifactId>protobuf-maven-plugin</artifactId>
<executions>
<execution>
<id>compile-proto</id>
<goals>
<goal>compile</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-shade-plugin</artifactId>
<executions>
Expand Down
100 changes: 64 additions & 36 deletions benchmarks/src/main/java/zipkin2/codec/CodecBenchmarks.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,15 @@
import org.openjdk.jmh.runner.options.OptionsBuilder;
import zipkin2.Span;

import static zipkin2.proto3.Span.parseFrom;

/**
* The {@link SpanBytesEncoder bundled java codec} aims to be both small in size (i.e. does not
* significantly increase the size of zipkin's jar), and efficient. It may not always be fastest,
* but we should try to keep it competitive.
*
* <p>Note that the wire benchmarks use their structs, not ours. This will result in more efficient
* writes as there's no hex codec of IDs, stringifying of IPs etc. A later change could do that, but
* it likely still going to be more efficient than our dependency-free codec. This means in cases
* where extra dependencies are ok (such as our server), we could consider using wire.
*/
@Measurement(iterations = 5, time = 1)
@Warmup(iterations = 10, time = 1)
Expand All @@ -56,108 +59,133 @@
@State(Scope.Thread)
@Threads(1)
public class CodecBenchmarks {
static final byte[] zipkin2Json = read("/zipkin2-client.json");
static final Span zipkin2 = SpanBytesDecoder.JSON_V2.decodeOne(zipkin2Json);
static final byte[] zipkin2Proto3 = SpanBytesEncoder.PROTO3.encode(zipkin2);
static final List<Span> tenSpan2s = Collections.nCopies(10, zipkin2);
static final byte[] tenSpan2sJson = SpanBytesEncoder.JSON_V2.encodeList(tenSpan2s);
static final byte[] clientSpanJsonV2 = read("/zipkin2-client.json");
static final Span clientSpan = SpanBytesDecoder.JSON_V2.decodeOne(clientSpanJsonV2);
static final byte[] clientSpanProto3 = SpanBytesEncoder.PROTO3.encode(clientSpan);
static final zipkin2.proto3.Span clientSpan_wire;
static final List<Span> tenClientSpans = Collections.nCopies(10, clientSpan);
static final byte[] tenClientSpansJsonV2 = SpanBytesEncoder.JSON_V2.encodeList(tenClientSpans);
static final Kryo kryo = new Kryo();
static final byte[] zipkin2Serialized;
static final byte[] clientSpanSerialized;

static {
kryo.register(Span.class, new JavaSerializer());
Output output = new Output(4096);
kryo.writeObject(output, zipkin2);
kryo.writeObject(output, clientSpan);
output.flush();
zipkin2Serialized = output.getBuffer();
clientSpanSerialized = output.getBuffer();
try {
clientSpan_wire = zipkin2.proto3.Span.ADAPTER.decode(clientSpanProto3);
} catch (IOException e) {
throw new AssertionError(e);
}
}

/** manually implemented with json so not as slow as normal java */
@Benchmark
public Span readClientSpan_java() {
return kryo.readObject(new Input(zipkin2Serialized), Span.class);
public Span readClientSpan_kryo() {
return kryo.readObject(new Input(clientSpanSerialized), Span.class);
}

@Benchmark
public byte[] writeClientSpan_java() {
Output output = new Output(zipkin2Serialized.length);
kryo.writeObject(output, zipkin2);
public byte[] writeClientSpan_kryo() {
Output output = new Output(clientSpanSerialized.length);
kryo.writeObject(output, clientSpan);
output.flush();
return output.getBuffer();
}

@Benchmark
public Span readClientSpan_json() {
return SpanBytesDecoder.JSON_V2.decodeOne(zipkin2Json);
return SpanBytesDecoder.JSON_V2.decodeOne(clientSpanJsonV2);
}

@Benchmark
public Span readClientSpan_proto3() {
return SpanBytesDecoder.PROTO3.decodeOne(zipkin2Proto3);
return SpanBytesDecoder.PROTO3.decodeOne(clientSpanProto3);
}

@Benchmark
public zipkin2.proto3.Span readClientSpan_proto3_protobuf() throws Exception {
return parseFrom(zipkin2Proto3);
public zipkin2.proto3.Span readClientSpan_proto3_wire() throws Exception {
return zipkin2.proto3.Span.ADAPTER.decode(clientSpanProto3);
}

@Benchmark
public List<Span> readTenClientSpans_json() {
return SpanBytesDecoder.JSON_V2.decodeList(tenSpan2sJson);
return SpanBytesDecoder.JSON_V2.decodeList(tenClientSpansJsonV2);
}

@Benchmark
public byte[] writeClientSpan_json() {
return SpanBytesEncoder.JSON_V2.encode(zipkin2);
return SpanBytesEncoder.JSON_V2.encode(clientSpan);
}

@Benchmark
public byte[] writeTenClientSpans_json() {
return SpanBytesEncoder.JSON_V2.encodeList(tenSpan2s);
return SpanBytesEncoder.JSON_V2.encodeList(tenClientSpans);
}

@Benchmark
public byte[] writeClientSpan_json_legacy() {
return SpanBytesEncoder.JSON_V1.encode(zipkin2);
public byte[] writeClientSpan_json_v1() {
return SpanBytesEncoder.JSON_V1.encode(clientSpan);
}

@Benchmark
public byte[] writeTenClientSpans_json_legacy() {
return SpanBytesEncoder.JSON_V1.encodeList(tenSpan2s);
public byte[] writeTenClientSpans_json_v1() {
return SpanBytesEncoder.JSON_V1.encodeList(tenClientSpans);
}

@Benchmark
public byte[] writeClientSpan_proto3() {
return SpanBytesEncoder.PROTO3.encode(zipkin2);
return SpanBytesEncoder.PROTO3.encode(clientSpan);
}

static final byte[] zipkin2JsonChinese = read("/zipkin2-chinese.json");
static final Span zipkin2Chinese = SpanBytesDecoder.JSON_V2.decodeOne(zipkin2JsonChinese);
static final byte[] zipkin2Proto3Chinese = SpanBytesEncoder.PROTO3.encode(zipkin2Chinese);
@Benchmark
public byte[] writeClientSpan_proto3_wire() {
return clientSpan_wire.encode();
}

static final byte[] chineseSpanJsonV2 = read("/zipkin2-chinese.json");
static final Span chineseSpan = SpanBytesDecoder.JSON_V2.decodeOne(chineseSpanJsonV2);
static final zipkin2.proto3.Span chineseSpan_wire;
static final byte[] chineseSpanProto3 = SpanBytesEncoder.PROTO3.encode(chineseSpan);

static {
try {
chineseSpan_wire = zipkin2.proto3.Span.ADAPTER.decode(chineseSpanProto3);
} catch (IOException e) {
throw new AssertionError(e);
}
}

@Benchmark
public Span readChineseSpan_json() {
return SpanBytesDecoder.JSON_V2.decodeOne(zipkin2JsonChinese);
return SpanBytesDecoder.JSON_V2.decodeOne(chineseSpanJsonV2);
}

@Benchmark
public Span readChineseSpan_proto3() {
return SpanBytesDecoder.PROTO3.decodeOne(zipkin2Proto3Chinese);
return SpanBytesDecoder.PROTO3.decodeOne(chineseSpanProto3);
}

@Benchmark
public zipkin2.proto3.Span readChineseSpan_proto3_protobuf() throws Exception {
return parseFrom(zipkin2Proto3Chinese);
public zipkin2.proto3.Span readChineseSpan_proto3_wire() throws Exception {
return zipkin2.proto3.Span.ADAPTER.decode(chineseSpanProto3);
}

@Benchmark
public byte[] writeChineseSpan_json() {
return SpanBytesEncoder.JSON_V2.encode(zipkin2Chinese);
return SpanBytesEncoder.JSON_V2.encode(chineseSpan);
}

@Benchmark
public byte[] writeChineseSpan_proto3() {
return SpanBytesEncoder.PROTO3.encode(zipkin2Chinese);
return SpanBytesEncoder.PROTO3.encode(chineseSpan);
}

@Benchmark
public byte[] writeChineseSpan_proto3_wire() {
return chineseSpan_wire.encode();
}

// Convenience main entry-point
Expand Down
Loading

0 comments on commit 0aff76f

Please sign in to comment.