From 8ec67cf9c391101bdf3c5e1de49794e2ccde9d68 Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Mon, 15 May 2017 14:54:01 -0700 Subject: Add benchmarks for start/end span and record trace events. (#297) --- benchmarks/build.gradle | 9 ++ .../RecordTraceEventsNonSampledSpanBenchmark.java | 83 ++++++++++++++ .../RecordTraceEventsSampledSpanBenchmark.java | 83 ++++++++++++++ .../trace/StartEndSpanBenchmark.java | 127 +++++++++++++++++++++ 4 files changed, 302 insertions(+) create mode 100644 benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsNonSampledSpanBenchmark.java create mode 100644 benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsSampledSpanBenchmark.java create mode 100644 benchmarks/src/jmh/java/com/google/instrumentation/trace/StartEndSpanBenchmark.java (limited to 'benchmarks') diff --git a/benchmarks/build.gradle b/benchmarks/build.gradle index 8b58bbf5..3c20fd0c 100644 --- a/benchmarks/build.gradle +++ b/benchmarks/build.gradle @@ -32,5 +32,14 @@ compileJmhJava { options.compilerArgs = compileJava.options.compilerArgs } + +// Generate html report for findbugsJmh. +findbugsJmh { + reports { + xml.enabled = false + html.enabled = true + } +} + // Disable checkstyle if not java8. checkstyleJmh.enabled = JavaVersion.current().isJava8Compatible() \ No newline at end of file diff --git a/benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsNonSampledSpanBenchmark.java b/benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsNonSampledSpanBenchmark.java new file mode 100644 index 00000000..ad9a66b5 --- /dev/null +++ b/benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsNonSampledSpanBenchmark.java @@ -0,0 +1,83 @@ +/* + * Copyright 2017, Google Inc. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.instrumentation.trace; + +import java.util.HashMap; +import java.util.concurrent.TimeUnit; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.OutputTimeUnit; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; + +/** Benchmarks for {@link SpanImpl} to record trace events. */ +@State(Scope.Benchmark) +public class RecordTraceEventsNonSampledSpanBenchmark { + private static final Tracer tracer = Tracing.getTracer(); + private static final String SPAN_NAME = "MySpanName"; + private static final String ANNOTATION_DESCRIPTION = "MyAnnotation"; + private static final String ATTRIBUTE_KEY = "MyAttributeKey"; + private static final String ATTRIBUTE_VALUE = "MyAttributeValue"; + private Span linkedSpan = + tracer.spanBuilder(SPAN_NAME).becomeRoot().setSampler(Samplers.neverSample()).startSpan(); + private Span span = + tracer.spanBuilder(SPAN_NAME).becomeRoot().setSampler(Samplers.neverSample()).startSpan(); + + /** TearDown method. */ + @TearDown + public void doTearDown() { + span.end(); + linkedSpan.end(); + } + + /** This benchmark attempts to measure performance of adding an attribute to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addAttributes() { + HashMap attributes = new HashMap(); + attributes.put(ATTRIBUTE_KEY, AttributeValue.stringAttributeValue(ATTRIBUTE_VALUE)); + span.addAttributes(attributes); + return span; + } + + /** This benchmark attempts to measure performance of adding an annotation to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addAnnotation() { + span.addAnnotation(ANNOTATION_DESCRIPTION); + return span; + } + + /** This benchmark attempts to measure performance of adding a network event to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addNetworkEvent() { + span.addNetworkEvent(NetworkEvent.builder(NetworkEvent.Type.RECV, 1).setMessageSize(3).build()); + return span; + } + + /** This benchmark attempts to measure performance of adding a link to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addLink() { + span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Link.Type.PARENT)); + return span; + } +} diff --git a/benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsSampledSpanBenchmark.java b/benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsSampledSpanBenchmark.java new file mode 100644 index 00000000..e20af6ea --- /dev/null +++ b/benchmarks/src/jmh/java/com/google/instrumentation/trace/RecordTraceEventsSampledSpanBenchmark.java @@ -0,0 +1,83 @@ +/* + * Copyright 2017, Google Inc. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.instrumentation.trace; + +import java.util.HashMap; +import java.util.concurrent.TimeUnit; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.OutputTimeUnit; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; + +/** Benchmarks for {@link SpanImpl} to record trace events. */ +@State(Scope.Benchmark) +public class RecordTraceEventsSampledSpanBenchmark { + private static final Tracer tracer = Tracing.getTracer(); + private static final String SPAN_NAME = "MySpanName"; + private static final String ANNOTATION_DESCRIPTION = "MyAnnotation"; + private static final String ATTRIBUTE_KEY = "MyAttributeKey"; + private static final String ATTRIBUTE_VALUE = "MyAttributeValue"; + private Span linkedSpan = + tracer.spanBuilder(SPAN_NAME).becomeRoot().setSampler(Samplers.alwaysSample()).startSpan(); + private Span span = + tracer.spanBuilder(SPAN_NAME).becomeRoot().setSampler(Samplers.alwaysSample()).startSpan(); + + /** TearDown method. */ + @TearDown + public void doTearDown() { + span.end(); + linkedSpan.end(); + } + + /** This benchmark attempts to measure performance of adding an attribute to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addAttributes() { + HashMap attributes = new HashMap(); + attributes.put(ATTRIBUTE_KEY, AttributeValue.stringAttributeValue(ATTRIBUTE_VALUE)); + span.addAttributes(attributes); + return span; + } + + /** This benchmark attempts to measure performance of adding an annotation to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addAnnotation() { + span.addAnnotation(ANNOTATION_DESCRIPTION); + return span; + } + + /** This benchmark attempts to measure performance of adding a network event to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addNetworkEvent() { + span.addNetworkEvent(NetworkEvent.builder(NetworkEvent.Type.RECV, 1).setMessageSize(3).build()); + return span; + } + + /** This benchmark attempts to measure performance of adding a link to the span. */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span addLink() { + span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Link.Type.PARENT)); + return span; + } +} diff --git a/benchmarks/src/jmh/java/com/google/instrumentation/trace/StartEndSpanBenchmark.java b/benchmarks/src/jmh/java/com/google/instrumentation/trace/StartEndSpanBenchmark.java new file mode 100644 index 00000000..ee15ad01 --- /dev/null +++ b/benchmarks/src/jmh/java/com/google/instrumentation/trace/StartEndSpanBenchmark.java @@ -0,0 +1,127 @@ +/* + * Copyright 2017, Google Inc. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.instrumentation.trace; + +import java.util.concurrent.TimeUnit; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.OutputTimeUnit; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; + +/** Benchmarks for {@link SpanFactoryImpl} and {@link SpanImpl}. */ +@State(Scope.Benchmark) +public class StartEndSpanBenchmark { + private static final Tracer tracer = Tracing.getTracer(); + private static final String SPAN_NAME = "MySpanName"; + private Span rootSpan = + tracer.spanBuilder(SPAN_NAME).becomeRoot().setSampler(Samplers.neverSample()).startSpan(); + + @TearDown + public void doTearDown() { + rootSpan.end(); + } + + /** + * This benchmark attempts to measure performance of start/end for a non-sampled root {@code + * Span}. + */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span startEndNonSampledRootSpan() { + Span span = + tracer.spanBuilder(SPAN_NAME).becomeRoot().setSampler(Samplers.neverSample()).startSpan(); + span.end(); + return span; + } + + /** + * This benchmark attempts to measure performance of start/end for a root {@code Span} with record + * events option. + */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span startEndRecordEventsRootSpan() { + Span span = + tracer + .spanBuilder(SPAN_NAME) + .becomeRoot() + .setSampler(Samplers.neverSample()) + .setRecordEvents(true) + .startSpan(); + span.end(); + return span; + } + + /** + * This benchmark attempts to measure performance of start/end for a sampled root {@code Span}. + */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span startEndSampledRootSpan() { + Span span = tracer.spanBuilder(SPAN_NAME).setSampler(Samplers.alwaysSample()).startSpan(); + span.end(); + return span; + } + + /** + * This benchmark attempts to measure performance of start/end for a non-sampled child {@code + * Span}. + */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span startEndNonSampledChildSpan() { + Span span = + tracer.spanBuilder(rootSpan, SPAN_NAME).setSampler(Samplers.neverSample()).startSpan(); + span.end(); + return span; + } + + /** + * This benchmark attempts to measure performance of start/end for a child {@code Span} with + * record events option. + */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span startEndRecordEventsChildSpan() { + Span span = + tracer + .spanBuilder(rootSpan, SPAN_NAME) + .setSampler(Samplers.neverSample()) + .setRecordEvents(true) + .startSpan(); + span.end(); + return span; + } + + /** + * This benchmark attempts to measure performance of start/end for a sampled child {@code Span}. + */ + @Benchmark + @BenchmarkMode(Mode.SampleTime) + @OutputTimeUnit(TimeUnit.NANOSECONDS) + public Span startEndSampledChildSpan() { + Span span = + tracer.spanBuilder(rootSpan, SPAN_NAME).setSampler(Samplers.alwaysSample()).startSpan(); + span.end(); + return span; + } +} -- cgit v1.2.3