aboutsummaryrefslogtreecommitdiff
path: root/benchmarks/src/jmh/java/io/opencensus/trace/StartEndSpanBenchmark.java
blob: 0daa6c1d9ed8a5a7abe0dc78f0730ef28482387a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
 * 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 io.opencensus.trace;

import io.opencensus.implcore.trace.SpanImpl;
import io.opencensus.trace.samplers.Samplers;
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 SpanBuilderImpl} and {@link SpanImpl}. */
@State(Scope.Benchmark)
public class StartEndSpanBenchmark {
  private static final Tracer tracer = Tracing.getTracer();
  private static final String SPAN_NAME = "MySpanName";
  private final Span rootSpan =
      tracer
          .spanBuilderWithExplicitParent(SPAN_NAME, null)
          .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
            .spanBuilderWithExplicitParent(SPAN_NAME, null)
            .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
            .spanBuilderWithExplicitParent(SPAN_NAME, null)
            .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
            .spanBuilderWithExplicitParent(SPAN_NAME, rootSpan)
            .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
            .spanBuilderWithExplicitParent(SPAN_NAME, rootSpan)
            .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
            .spanBuilderWithExplicitParent(SPAN_NAME, rootSpan)
            .setSampler(Samplers.alwaysSample())
            .startSpan();
    span.end();
    return span;
  }
}