Skip to content

Commit a71f905

Browse files
bogdandrutubogdandrutu
authored
Rename [Batch|Simple]SpansProcessor to [Batch|Simple]SpanProcessor (open-telemetry#1241)
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
1 parent 49f271f commit a71f905

12 files changed

Lines changed: 99 additions & 101 deletions

File tree

‎QUICKSTART.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ TracerSdkProvider tracerProvider = OpenTelemetrySdk.getTracerProvider();
317317

318318
// Set to export the traces to a logging stream
319319
tracerProvider.addSpanProcessor(
320-
SimpleSpansProcessor.newBuilder(
320+
SimpleSpanProcessor.newBuilder(
321321
new LoggingSpanExporter()
322322
).build());
323323
```
@@ -355,20 +355,20 @@ tracerProvider.updateActiveTraceConfig(
355355
### Span Processor
356356

357357
Different Span processors are offered by OpenTelemetry. The `SimpleSpanProcessor` immediately
358-
forwards ended spans to the exporter, while the `BatchSpansProcessor` batches them and sends them
358+
forwards ended spans to the exporter, while the `BatchSpanProcessor` batches them and sends them
359359
in bulk. Multiple Span processors can be configured to be active at the same time using the
360360
`MultiSpanProcessor`.
361361

362362
```java
363363
tracerProvider.addSpanProcessor(
364-
SimpleSpansProcessor.newBuilder(new LoggingSpanExporter()).build()
364+
SimpleSpanProcessor.newBuilder(new LoggingSpanExporter()).build()
365365
);
366366
tracerProvider.addSpanProcessor(
367-
BatchSpansProcessor.newBuilder(new LoggingSpanExporter()).build()
367+
BatchSpanProcessor.newBuilder(new LoggingSpanExporter()).build()
368368
);
369369
tracerProvider.addSpanProcessor(MultiSpanProcessor.create(Arrays.asList(
370-
SimpleSpansProcessor.newBuilder(new LoggingSpanExporter()).build(),
371-
BatchSpansProcessor.newBuilder(new LoggingSpanExporter()).build()
370+
SimpleSpanProcessor.newBuilder(new LoggingSpanExporter()).build(),
371+
BatchSpanProcessor.newBuilder(new LoggingSpanExporter()).build()
372372
)));
373373
```
374374

@@ -386,16 +386,16 @@ Other exporters can be found in the [OpenTelemetry Registry].
386386

387387
```java
388388
tracerProvider.addSpanProcessor(
389-
SimpleSpansProcessor.newBuilder(InMemorySpanExporter.create()).build());
389+
SimpleSpanProcessor.newBuilder(InMemorySpanExporter.create()).build());
390390
tracerProvider.addSpanProcessor(
391-
SimpleSpansProcessor.newBuilder(new LoggingSpanExporter()).build());
391+
SimpleSpanProcessor.newBuilder(new LoggingSpanExporter()).build());
392392

393393
ManagedChannel jaegerChannel =
394394
ManagedChannelBuilder.forAddress([ip:String], [port:int]).usePlaintext().build();
395395
JaegerGrpcSpanExporter jaegerExporter = JaegerGrpcSpanExporter.newBuilder()
396396
.setServiceName("example").setChannel(jaegerChannel).setDeadline(30000)
397397
.build();
398-
tracerProvider.addSpanProcessor(BatchSpansProcessor.newBuilder(
398+
tracerProvider.addSpanProcessor(BatchSpanProcessor.newBuilder(
399399
jaegerExporter
400400
).build());
401401
```

‎exporters/inmemory/src/main/java/io/opentelemetry/exporters/inmemory/InMemoryTracing.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818

1919
import com.google.auto.value.AutoValue;
2020
import io.opentelemetry.sdk.trace.TracerSdkProvider;
21-
import io.opentelemetry.sdk.trace.export.SimpleSpansProcessor;
21+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
2222
import javax.annotation.concurrent.Immutable;
2323

2424
/**
25-
* InMemoryTracing is an utility class that helps installing the {@link SimpleSpansProcessor} and an
25+
* InMemoryTracing is an utility class that helps installing the {@link SimpleSpanProcessor} and an
2626
* instance of the {@link InMemorySpanExporter} to a given {@link TracerSdkProvider}. Can be used to
2727
* test OpenTelemetry integration.
2828
*
@@ -96,7 +96,7 @@ public abstract static class Builder {
9696
*/
9797
public final InMemoryTracing build() {
9898
InMemorySpanExporter exporter = InMemorySpanExporter.create();
99-
getTracerProvider().addSpanProcessor(SimpleSpansProcessor.newBuilder(exporter).build());
99+
getTracerProvider().addSpanProcessor(SimpleSpanProcessor.newBuilder(exporter).build());
100100
return setSpanExporter(exporter).autoBuild();
101101
}
102102
}

‎exporters/inmemory/src/test/java/io/opentelemetry/exporters/inmemory/InMemorySpanExporterTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import io.opentelemetry.sdk.trace.TracerSdkProvider;
2222
import io.opentelemetry.sdk.trace.data.SpanData;
2323
import io.opentelemetry.sdk.trace.data.SpanDataImpl;
24-
import io.opentelemetry.sdk.trace.export.SimpleSpansProcessor;
24+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
2525
import io.opentelemetry.sdk.trace.export.SpanExporter.ResultCode;
2626
import io.opentelemetry.trace.Tracer;
2727
import java.util.Collections;
@@ -40,7 +40,7 @@ public class InMemorySpanExporterTest {
4040

4141
@Before
4242
public void setup() {
43-
tracerSdkProvider.addSpanProcessor(SimpleSpansProcessor.newBuilder(exporter).build());
43+
tracerSdkProvider.addSpanProcessor(SimpleSpanProcessor.newBuilder(exporter).build());
4444
}
4545

4646
@Test

‎exporters/jaeger/src/main/java/io/opentelemetry/exporters/jaeger/JaegerGrpcSpanExporter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import io.opentelemetry.exporters.jaeger.proto.api_v2.Model;
2424
import io.opentelemetry.sdk.trace.TracerSdkProvider;
2525
import io.opentelemetry.sdk.trace.data.SpanData;
26-
import io.opentelemetry.sdk.trace.export.BatchSpansProcessor;
26+
import io.opentelemetry.sdk.trace.export.BatchSpanProcessor;
2727
import io.opentelemetry.sdk.trace.export.SpanExporter;
2828
import java.net.InetAddress;
2929
import java.net.UnknownHostException;
@@ -232,7 +232,7 @@ public JaegerGrpcSpanExporter build() {
232232
* @param tracerSdkProvider tracer SDK provider
233233
*/
234234
public void install(TracerSdkProvider tracerSdkProvider) {
235-
BatchSpansProcessor spansProcessor = BatchSpansProcessor.newBuilder(this.build()).build();
235+
BatchSpanProcessor spansProcessor = BatchSpanProcessor.newBuilder(this.build()).build();
236236
tracerSdkProvider.addSpanProcessor(spansProcessor);
237237
}
238238

‎exporters/jaeger/src/test/java/io/opentelemetry/exporters/jaeger/JaegerIntegrationTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import io.grpc.ManagedChannelBuilder;
2323
import io.opentelemetry.OpenTelemetry;
2424
import io.opentelemetry.sdk.OpenTelemetrySdk;
25-
import io.opentelemetry.sdk.trace.export.SimpleSpansProcessor;
25+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
2626
import io.opentelemetry.sdk.trace.export.SpanExporter;
2727
import io.opentelemetry.trace.Span;
2828
import io.opentelemetry.trace.Tracer;
@@ -86,7 +86,7 @@ private static void setupJaegerExporter() {
8686
.setDeadlineMs(30000)
8787
.build();
8888
OpenTelemetrySdk.getTracerProvider()
89-
.addSpanProcessor(SimpleSpansProcessor.newBuilder(jaegerExporter).build());
89+
.addSpanProcessor(SimpleSpanProcessor.newBuilder(jaegerExporter).build());
9090
}
9191

9292
private void imitateWork() {

sdk/src/main/java/io/opentelemetry/sdk/trace/export/BatchSpansProcessor.java renamed to sdk/src/main/java/io/opentelemetry/sdk/trace/export/BatchSpanProcessor.java

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,17 @@
5757
* <p>This batch {@link SpanProcessor} can cause high contention in a very high traffic service.
5858
* TODO: Add a link to the SpanProcessor that uses Disruptor as alternative with low contention.
5959
*/
60-
public final class BatchSpansProcessor implements SpanProcessor {
60+
public final class BatchSpanProcessor implements SpanProcessor {
6161

6262
private static final String WORKER_THREAD_NAME =
63-
BatchSpansProcessor.class.getSimpleName() + "_WorkerThread";
63+
BatchSpanProcessor.class.getSimpleName() + "_WorkerThread";
6464
private static final String EXPORTER_THREAD_NAME =
65-
BatchSpansProcessor.class.getSimpleName() + "_ExporterThread";
65+
BatchSpanProcessor.class.getSimpleName() + "_ExporterThread";
6666
private final Worker worker;
6767
private final Thread workerThread;
6868
private final boolean sampled;
6969

70-
private BatchSpansProcessor(
70+
private BatchSpanProcessor(
7171
SpanExporter spanExporter,
7272
boolean sampled,
7373
long scheduleDelayMillis,
@@ -132,10 +132,10 @@ private static final class Worker implements Runnable {
132132
.longCounterBuilder("droppedSpans")
133133
.setUnit("1")
134134
.setDescription(
135-
"The number of spans dropped by the BatchSpansProcessor due to high throughput.")
135+
"The number of spans dropped by the BatchSpanProcessor due to high throughput.")
136136
.build();
137137
droppedSpans =
138-
droppedSpansCounter.bind("spanProcessorType", BatchSpansProcessor.class.getSimpleName());
138+
droppedSpansCounter.bind("spanProcessorType", BatchSpanProcessor.class.getSimpleName());
139139
}
140140

141141
private static final BoundLongCounter droppedSpans;
@@ -279,17 +279,17 @@ public void run() {
279279
}
280280

281281
/**
282-
* Returns a new Builder for {@link BatchSpansProcessor}.
282+
* Returns a new Builder for {@link BatchSpanProcessor}.
283283
*
284284
* @param spanExporter the {@code SpanExporter} to where the Spans are pushed.
285-
* @return a new {@link BatchSpansProcessor}.
285+
* @return a new {@link BatchSpanProcessor}.
286286
* @throws NullPointerException if the {@code spanExporter} is {@code null}.
287287
*/
288288
public static Builder newBuilder(SpanExporter spanExporter) {
289289
return new Builder(spanExporter);
290290
}
291291

292-
/** Builder class for {@link BatchSpansProcessor}. */
292+
/** Builder class for {@link BatchSpanProcessor}. */
293293
public static final class Builder extends ConfigBuilder<Builder> {
294294

295295
private static final String KEY_SCHEDULE_DELAY_MILLIS = "otel.bsp.schedule.delay";
@@ -429,7 +429,7 @@ public Builder readSystemProperties() {
429429
*
430430
* @param sampled report only sampled spans.
431431
* @return this.
432-
* @see BatchSpansProcessor.Builder#DEFAULT_EXPORT_ONLY_SAMPLED
432+
* @see BatchSpanProcessor.Builder#DEFAULT_EXPORT_ONLY_SAMPLED
433433
*/
434434
public Builder setExportOnlySampled(boolean sampled) {
435435
this.exportOnlySampled = sampled;
@@ -444,7 +444,7 @@ public Builder setExportOnlySampled(boolean sampled) {
444444
*
445445
* @param scheduleDelayMillis the delay interval between two consecutive exports.
446446
* @return this.
447-
* @see BatchSpansProcessor.Builder#DEFAULT_SCHEDULE_DELAY_MILLIS
447+
* @see BatchSpanProcessor.Builder#DEFAULT_SCHEDULE_DELAY_MILLIS
448448
*/
449449
public Builder setScheduleDelayMillis(long scheduleDelayMillis) {
450450
this.scheduleDelayMillis = scheduleDelayMillis;
@@ -458,7 +458,7 @@ public Builder setScheduleDelayMillis(long scheduleDelayMillis) {
458458
*
459459
* @param exporterTimeoutMillis the timeout for exports in milliseconds.
460460
* @return this
461-
* @see BatchSpansProcessor.Builder#DEFAULT_EXPORT_TIMEOUT_MILLIS
461+
* @see BatchSpanProcessor.Builder#DEFAULT_EXPORT_TIMEOUT_MILLIS
462462
*/
463463
public Builder setExporterTimeoutMillis(int exporterTimeoutMillis) {
464464
this.exporterTimeoutMillis = exporterTimeoutMillis;
@@ -476,7 +476,7 @@ public Builder setExporterTimeoutMillis(int exporterTimeoutMillis) {
476476
* @param maxQueueSize the maximum number of Spans that are kept in the queue before start
477477
* dropping.
478478
* @return this.
479-
* @see BatchSpansProcessor.Builder#DEFAULT_MAX_QUEUE_SIZE
479+
* @see BatchSpanProcessor.Builder#DEFAULT_MAX_QUEUE_SIZE
480480
*/
481481
public Builder setMaxQueueSize(int maxQueueSize) {
482482
this.maxQueueSize = maxQueueSize;
@@ -491,7 +491,7 @@ public Builder setMaxQueueSize(int maxQueueSize) {
491491
*
492492
* @param maxExportBatchSize the maximum batch size for every export.
493493
* @return this.
494-
* @see BatchSpansProcessor.Builder#DEFAULT_MAX_EXPORT_BATCH_SIZE
494+
* @see BatchSpanProcessor.Builder#DEFAULT_MAX_EXPORT_BATCH_SIZE
495495
*/
496496
public Builder setMaxExportBatchSize(int maxExportBatchSize) {
497497
Utils.checkArgument(maxExportBatchSize > 0, "maxExportBatchSize must be positive.");
@@ -500,14 +500,14 @@ public Builder setMaxExportBatchSize(int maxExportBatchSize) {
500500
}
501501

502502
/**
503-
* Returns a new {@link BatchSpansProcessor} that batches, then converts spans to proto and
503+
* Returns a new {@link BatchSpanProcessor} that batches, then converts spans to proto and
504504
* forwards them to the given {@code spanExporter}.
505505
*
506-
* @return a new {@link BatchSpansProcessor}.
506+
* @return a new {@link BatchSpanProcessor}.
507507
* @throws NullPointerException if the {@code spanExporter} is {@code null}.
508508
*/
509-
public BatchSpansProcessor build() {
510-
return new BatchSpansProcessor(
509+
public BatchSpanProcessor build() {
510+
return new BatchSpanProcessor(
511511
spanExporter,
512512
exportOnlySampled,
513513
scheduleDelayMillis,

sdk/src/main/java/io/opentelemetry/sdk/trace/export/SimpleSpansProcessor.java renamed to sdk/src/main/java/io/opentelemetry/sdk/trace/export/SimpleSpanProcessor.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@
3333
* An implementation of the {@link SpanProcessor} that converts the {@link ReadableSpan} to {@link
3434
* SpanData} and passes it to the configured exporter.
3535
*/
36-
public final class SimpleSpansProcessor implements SpanProcessor {
36+
public final class SimpleSpanProcessor implements SpanProcessor {
3737

38-
private static final Logger logger = Logger.getLogger(SimpleSpansProcessor.class.getName());
38+
private static final Logger logger = Logger.getLogger(SimpleSpanProcessor.class.getName());
3939

4040
private final SpanExporter spanExporter;
4141
private final boolean sampled;
4242

43-
private SimpleSpansProcessor(SpanExporter spanExporter, boolean sampled) {
43+
private SimpleSpanProcessor(SpanExporter spanExporter, boolean sampled) {
4444
this.spanExporter = Objects.requireNonNull(spanExporter, "spanExporter");
4545
this.sampled = sampled;
4646
}
@@ -84,17 +84,17 @@ public void forceFlush() {
8484
}
8585

8686
/**
87-
* Returns a new Builder for {@link SimpleSpansProcessor}.
87+
* Returns a new Builder for {@link SimpleSpanProcessor}.
8888
*
8989
* @param spanExporter the {@code SpanExporter} to where the Spans are pushed.
90-
* @return a new {@link SimpleSpansProcessor}.
90+
* @return a new {@link SimpleSpanProcessor}.
9191
* @throws NullPointerException if the {@code spanExporter} is {@code null}.
9292
*/
9393
public static Builder newBuilder(SpanExporter spanExporter) {
9494
return new Builder(spanExporter);
9595
}
9696

97-
/** Builder class for {@link SimpleSpansProcessor}. */
97+
/** Builder class for {@link SimpleSpanProcessor}. */
9898
public static final class Builder extends ConfigBuilder<Builder> {
9999

100100
private static final String KEY_SAMPLED = "otel.ssp.export.sampled";
@@ -181,7 +181,7 @@ public Builder readSystemProperties() {
181181
*
182182
* <p>Default value is {@code true}.
183183
*
184-
* @see SimpleSpansProcessor.Builder#DEFAULT_EXPORT_ONLY_SAMPLED
184+
* @see SimpleSpanProcessor.Builder#DEFAULT_EXPORT_ONLY_SAMPLED
185185
* @param sampled report only sampled spans.
186186
* @return this.
187187
*/
@@ -194,14 +194,14 @@ public Builder setExportOnlySampled(boolean sampled) {
194194
// TODO: Consider to add support for constant Attributes and/or Resource.
195195

196196
/**
197-
* Returns a new {@link SimpleSpansProcessor} that converts spans to proto and forwards them to
197+
* Returns a new {@link SimpleSpanProcessor} that converts spans to proto and forwards them to
198198
* the given {@code spanExporter}.
199199
*
200-
* @return a new {@link SimpleSpansProcessor}.
200+
* @return a new {@link SimpleSpanProcessor}.
201201
* @throws NullPointerException if the {@code spanExporter} is {@code null}.
202202
*/
203-
public SimpleSpansProcessor build() {
204-
return new SimpleSpansProcessor(spanExporter, sampled);
203+
public SimpleSpanProcessor build() {
204+
return new SimpleSpanProcessor(spanExporter, sampled);
205205
}
206206
}
207207
}

‎sdk/src/main/java/io/opentelemetry/sdk/trace/export/SpanExporter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* their own format.
2626
*
2727
* <p>To export data this MUST be register to the {@code TracerSdk} using a {@link
28-
* SimpleSpansProcessor} or a {@code BatchSampledSpansProcessor}.
28+
* SimpleSpanProcessor} or a {@code BatchSampledSpansProcessor}.
2929
*/
3030
public interface SpanExporter {
3131

‎sdk/src/main/java/io/opentelemetry/sdk/trace/export/package-info.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,35 +22,35 @@
2222
*
2323
* <ul>
2424
* <li>{@link io.opentelemetry.sdk.trace.export.SpanExporter}
25-
* <li>{@link io.opentelemetry.sdk.trace.export.SimpleSpansProcessor}
26-
* <li>{@link io.opentelemetry.sdk.trace.export.BatchSpansProcessor}
25+
* <li>{@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor}
26+
* <li>{@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor}
2727
* <li>{@link io.opentelemetry.sdk.trace.export.MultiSpanExporter}
2828
* </ul>
2929
*
30-
* <h2>Default values for {@link io.opentelemetry.sdk.trace.export.SimpleSpansProcessor}</h2>
30+
* <h2>Default values for {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor}</h2>
3131
*
3232
* <ul>
3333
* <li>{@code REPORT_ONLY_SAMPLED: true} *
3434
* </ul>
3535
*
36-
* <p>Values for {@link io.opentelemetry.sdk.trace.export.SimpleSpansProcessor} can be read from
36+
* <p>Values for {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} can be read from
3737
* system properties, environment variables, or {@link java.util.Properties} objects.
3838
*
3939
* <p>For System Properties and {@link java.util.Properties} objects, {@link
40-
* io.opentelemetry.sdk.trace.export.SimpleSpansProcessor} will look for the following names:
40+
* io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} will look for the following names:
4141
*
4242
* <ul>
4343
* <li>{@code otel.ssp.export.sampled}: sets whether only sampled spans should be exported.
4444
* </ul>
4545
*
46-
* <p>For Environment Variable, {@link io.opentelemetry.sdk.trace.export.SimpleSpansProcessor} will
46+
* <p>For Environment Variable, {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} will
4747
* look for the following names:
4848
*
4949
* <ul>
5050
* <li>{@code OTEL_SSP_EXPORT_SAMPLED}: sets whether only sampled spans should be exported.
5151
* </ul>
5252
*
53-
* <h2>Default values for {@link io.opentelemetry.sdk.trace.export.BatchSpansProcessor}</h2>
53+
* <h2>Default values for {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor}</h2>
5454
*
5555
* <ul>
5656
* <li>{@code SCHEDULE_DELAY_MILLIS: 5000}
@@ -60,11 +60,11 @@
6060
* <li>{@code REPORT_ONLY_SAMPLED: true}
6161
* </ul>
6262
*
63-
* <p>Values for {@link io.opentelemetry.sdk.trace.export.BatchSpansProcessor} can be read from
63+
* <p>Values for {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} can be read from
6464
* system properties, environment variables, or {@link java.util.Properties} objects.
6565
*
6666
* <p>For System Properties and {@link java.util.Properties} objects, {@link
67-
* io.opentelemetry.sdk.trace.export.BatchSpansProcessor} will look for the following names:
67+
* io.opentelemetry.sdk.trace.export.BatchSpanProcessor} will look for the following names:
6868
*
6969
* <ul>
7070
* <li>{@code otel.bsp.schedule.delay}: sets the delay interval between two consecutive exports.
@@ -74,7 +74,7 @@
7474
* <li>{@code otel.bsp.export.sampled}: sets whether only sampled spans should be exported.
7575
* </ul>
7676
*
77-
* <p>For Environment Variable, {@link io.opentelemetry.sdk.trace.export.BatchSpansProcessor} will
77+
* <p>For Environment Variable, {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} will
7878
* look for the following names:
7979
*
8080
* <ul>

0 commit comments

Comments
 (0)