From a5df0c553f2a8534f287daa880d3d3f71cbdc697 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 1 Mar 2021 09:48:59 -0800 Subject: [PATCH 1/3] rename span processor --- CHANGELOG.md | 4 ++ docs/examples/auto-instrumentation/client.py | 4 +- .../server_instrumented.py | 4 +- .../server_uninstrumented.py | 4 +- docs/examples/basic_tracer/basic_trace.py | 4 +- docs/examples/basic_tracer/resources.py | 4 +- docs/examples/django/client.py | 4 +- docs/examples/django/pages/views.py | 4 +- .../opencensus-exporter-tracer/collector.py | 4 +- docs/examples/opentracing/main.py | 4 +- docs/getting_started/flask_example.py | 4 +- docs/getting_started/jaeger_example.py | 4 +- docs/getting_started/otlpcollector_example.py | 4 +- docs/getting_started/tracing_example.py | 4 +- .../examples/jaeger_exporter_example.py | 6 +-- .../opentelemetry/exporter/jaeger/__init__.py | 6 +-- .../opentelemetry/exporter/otlp/__init__.py | 4 +- .../test_benchmark_trace_exporter.py | 10 ++-- .../tests/test_otlp_trace_exporter.py | 4 +- .../opentelemetry/exporter/zipkin/__init__.py | 6 +-- .../src/opentelemetry/distro/__init__.py | 4 +- .../tests/test_configurator.py | 2 +- .../sdk/trace/export/__init__.py | 12 ++--- .../src/opentelemetry/sdk/trace/sampling.py | 8 +-- .../tests/context/test_asyncio.py | 2 +- .../profile_resource_usage_batch_export.py | 4 +- .../profile_resource_usage_simple_export.py | 4 +- .../tests/trace/export/test_export.py | 50 +++++++++---------- .../export/test_in_memory_span_exporter.py | 2 +- .../tests/testbed/otel_ot_shim_tracer.py | 4 +- .../test_opencensusexporter_functional.py | 4 +- .../src/opentelemetry/test/spantestutil.py | 2 +- .../util/src/opentelemetry/test/test_base.py | 4 +- tests/w3c_tracecontext_validation_server.py | 4 +- 34 files changed, 101 insertions(+), 97 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bcb8d65d4b8..2809e88fc3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v0.18b0...HEAD) +### Changed +- Renamed `BatchExportSpanProcessor` to `BatchSpanProcessor` and `SimpleExportSpanProcessor` to + `SimpleSpanProcessor` + ## [0.18b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.18b0) - 2021-02-16 ### Added diff --git a/docs/examples/auto-instrumentation/client.py b/docs/examples/auto-instrumentation/client.py index 8cef055b35f..fefc1f67b98 100644 --- a/docs/examples/auto-instrumentation/client.py +++ b/docs/examples/auto-instrumentation/client.py @@ -20,14 +20,14 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer_provider().get_tracer(__name__) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) diff --git a/docs/examples/auto-instrumentation/server_instrumented.py b/docs/examples/auto-instrumentation/server_instrumented.py index 66bb0b584a9..5bf5e8dafe2 100644 --- a/docs/examples/auto-instrumentation/server_instrumented.py +++ b/docs/examples/auto-instrumentation/server_instrumented.py @@ -20,7 +20,7 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) from opentelemetry.trace.propagation.textmap import DictGetter @@ -30,7 +30,7 @@ tracer = trace.get_tracer_provider().get_tracer(__name__) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) diff --git a/docs/examples/auto-instrumentation/server_uninstrumented.py b/docs/examples/auto-instrumentation/server_uninstrumented.py index b8360341ab2..5edcd5cf60a 100644 --- a/docs/examples/auto-instrumentation/server_uninstrumented.py +++ b/docs/examples/auto-instrumentation/server_uninstrumented.py @@ -18,7 +18,7 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) app = Flask(__name__) @@ -26,7 +26,7 @@ trace.set_tracer_provider(TracerProvider()) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) diff --git a/docs/examples/basic_tracer/basic_trace.py b/docs/examples/basic_tracer/basic_trace.py index 5fcfe51d19d..54fcb1c3c61 100644 --- a/docs/examples/basic_tracer/basic_trace.py +++ b/docs/examples/basic_tracer/basic_trace.py @@ -16,12 +16,12 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) tracer = trace.get_tracer(__name__) with tracer.start_as_current_span("foo"): diff --git a/docs/examples/basic_tracer/resources.py b/docs/examples/basic_tracer/resources.py index 1d1a6cd0475..d69b689aa61 100644 --- a/docs/examples/basic_tracer/resources.py +++ b/docs/examples/basic_tracer/resources.py @@ -17,7 +17,7 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) resource = Resource.create({"service.name": "basic_service"}) @@ -25,7 +25,7 @@ trace.set_tracer_provider(TracerProvider(resource=resource)) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) tracer = trace.get_tracer(__name__) with tracer.start_as_current_span("foo"): diff --git a/docs/examples/django/client.py b/docs/examples/django/client.py index d32be31a851..bc3606cbe76 100644 --- a/docs/examples/django/client.py +++ b/docs/examples/django/client.py @@ -21,14 +21,14 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer_provider().get_tracer(__name__) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) diff --git a/docs/examples/django/pages/views.py b/docs/examples/django/pages/views.py index 4083888e17b..e69de63f095 100644 --- a/docs/examples/django/pages/views.py +++ b/docs/examples/django/pages/views.py @@ -17,13 +17,13 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) diff --git a/docs/examples/opencensus-exporter-tracer/collector.py b/docs/examples/opencensus-exporter-tracer/collector.py index d404cfbce5f..fdc45d71622 100644 --- a/docs/examples/opencensus-exporter-tracer/collector.py +++ b/docs/examples/opencensus-exporter-tracer/collector.py @@ -19,7 +19,7 @@ OpenCensusSpanExporter, ) from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import BatchExportSpanProcessor +from opentelemetry.sdk.trace.export import BatchSpanProcessor exporter = OpenCensusSpanExporter( service_name="basic-service", endpoint="localhost:55678" @@ -27,7 +27,7 @@ trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer(__name__) -span_processor = BatchExportSpanProcessor(exporter) +span_processor = BatchSpanProcessor(exporter) trace.get_tracer_provider().add_span_processor(span_processor) with tracer.start_as_current_span("foo"): diff --git a/docs/examples/opentracing/main.py b/docs/examples/opentracing/main.py index 7de4b33730c..f997801aaa5 100755 --- a/docs/examples/opentracing/main.py +++ b/docs/examples/opentracing/main.py @@ -5,7 +5,7 @@ from opentelemetry import trace from opentelemetry.exporter.jaeger import JaegerSpanExporter from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor +from opentelemetry.sdk.trace.export import SimpleSpanProcessor from opentelemetry.shim import opentracing_shim # Configure the tracer using the default implementation @@ -18,7 +18,7 @@ agent_host_name="localhost", agent_port=6831, ) -span_processor = SimpleExportSpanProcessor(jaeger_exporter) +span_processor = SimpleSpanProcessor(jaeger_exporter) tracer_provider.add_span_processor(span_processor) # Create an OpenTracing shim. This implements the OpenTracing tracer API, but diff --git a/docs/getting_started/flask_example.py b/docs/getting_started/flask_example.py index c4a172389cd..2b60d4def87 100644 --- a/docs/getting_started/flask_example.py +++ b/docs/getting_started/flask_example.py @@ -22,12 +22,12 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) app = flask.Flask(__name__) diff --git a/docs/getting_started/jaeger_example.py b/docs/getting_started/jaeger_example.py index f9c8e5cd059..0494333d2cf 100644 --- a/docs/getting_started/jaeger_example.py +++ b/docs/getting_started/jaeger_example.py @@ -16,7 +16,7 @@ from opentelemetry import trace from opentelemetry.exporter import jaeger from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import BatchExportSpanProcessor +from opentelemetry.sdk.trace.export import BatchSpanProcessor trace.set_tracer_provider(TracerProvider()) @@ -27,7 +27,7 @@ ) trace.get_tracer_provider().add_span_processor( - BatchExportSpanProcessor(jaeger_exporter) + BatchSpanProcessor(jaeger_exporter) ) tracer = trace.get_tracer(__name__) diff --git a/docs/getting_started/otlpcollector_example.py b/docs/getting_started/otlpcollector_example.py index d31fdf0bd8e..4ca7ade35f7 100644 --- a/docs/getting_started/otlpcollector_example.py +++ b/docs/getting_started/otlpcollector_example.py @@ -18,7 +18,7 @@ from opentelemetry import trace from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import BatchExportSpanProcessor +from opentelemetry.sdk.trace.export import BatchSpanProcessor span_exporter = OTLPSpanExporter( # optional @@ -28,7 +28,7 @@ ) tracer_provider = TracerProvider() trace.set_tracer_provider(tracer_provider) -span_processor = BatchExportSpanProcessor(span_exporter) +span_processor = BatchSpanProcessor(span_exporter) tracer_provider.add_span_processor(span_processor) # Configure the tracer to use the collector exporter diff --git a/docs/getting_started/tracing_example.py b/docs/getting_started/tracing_example.py index 5d449458b4a..6bb8f18e8ad 100644 --- a/docs/getting_started/tracing_example.py +++ b/docs/getting_started/tracing_example.py @@ -17,12 +17,12 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) tracer = trace.get_tracer(__name__) diff --git a/exporter/opentelemetry-exporter-jaeger/examples/jaeger_exporter_example.py b/exporter/opentelemetry-exporter-jaeger/examples/jaeger_exporter_example.py index 0d312676b90..0ebe1c874cf 100644 --- a/exporter/opentelemetry-exporter-jaeger/examples/jaeger_exporter_example.py +++ b/exporter/opentelemetry-exporter-jaeger/examples/jaeger_exporter_example.py @@ -3,7 +3,7 @@ from opentelemetry import trace from opentelemetry.exporter import jaeger from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import BatchExportSpanProcessor +from opentelemetry.sdk.trace.export import BatchSpanProcessor trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer(__name__) @@ -35,8 +35,8 @@ # transport_format="protobuf", # ) -# create a BatchExportSpanProcessor and add the exporter to it -span_processor = BatchExportSpanProcessor(jaeger_exporter) +# create a BatchSpanProcessor and add the exporter to it +span_processor = BatchSpanProcessor(jaeger_exporter) # add to the tracer factory trace.get_tracer_provider().add_span_processor(span_processor) diff --git a/exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/__init__.py b/exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/__init__.py index 20b4bda3d9f..4d968ffeac0 100644 --- a/exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/__init__.py +++ b/exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/__init__.py @@ -29,7 +29,7 @@ from opentelemetry import trace from opentelemetry.exporter import jaeger from opentelemetry.sdk.trace import TracerProvider - from opentelemetry.sdk.trace.export import BatchExportSpanProcessor + from opentelemetry.sdk.trace.export import BatchSpanProcessor trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer(__name__) @@ -49,8 +49,8 @@ # transport_format='protobuf' # optional ) - # Create a BatchExportSpanProcessor and add the exporter to it - span_processor = BatchExportSpanProcessor(jaeger_exporter) + # Create a BatchSpanProcessor and add the exporter to it + span_processor = BatchSpanProcessor(jaeger_exporter) # add to the tracer trace.get_tracer_provider().add_span_processor(span_processor) diff --git a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py index abc4186b71b..b1db06b295e 100644 --- a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py +++ b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py @@ -42,7 +42,7 @@ from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.resources import Resource from opentelemetry.sdk.trace import TracerProvider - from opentelemetry.sdk.trace.export import BatchExportSpanProcessor + from opentelemetry.sdk.trace.export import BatchSpanProcessor # Resource can be required for some backends, e.g. Jaeger # If resource wouldn't be set - traces wouldn't appears in Jaeger @@ -55,7 +55,7 @@ otlp_exporter = OTLPSpanExporter(endpoint="localhost:4317", insecure=True) - span_processor = BatchExportSpanProcessor(otlp_exporter) + span_processor = BatchSpanProcessor(otlp_exporter) trace.get_tracer_provider().add_span_processor(span_processor) diff --git a/exporter/opentelemetry-exporter-otlp/tests/performance/benchmarks/test_benchmark_trace_exporter.py b/exporter/opentelemetry-exporter-otlp/tests/performance/benchmarks/test_benchmark_trace_exporter.py index 00c22f0359b..7434a0d8d0d 100644 --- a/exporter/opentelemetry-exporter-otlp/tests/performance/benchmarks/test_benchmark_trace_exporter.py +++ b/exporter/opentelemetry-exporter-otlp/tests/performance/benchmarks/test_benchmark_trace_exporter.py @@ -17,8 +17,8 @@ from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.trace import TracerProvider, sampling from opentelemetry.sdk.trace.export import ( - BatchExportSpanProcessor, - SimpleExportSpanProcessor, + BatchSpanProcessor, + SimpleSpanProcessor, ) @@ -40,7 +40,7 @@ def __init__(self, channel): new=MockTraceServiceStub, ) def test_simple_span_processor(benchmark): - tracer = get_tracer_with_processor(SimpleExportSpanProcessor) + tracer = get_tracer_with_processor(SimpleSpanProcessor) def create_spans_to_be_exported(): span = tracer.start_span("benchmarkedSpan",) @@ -59,14 +59,14 @@ def create_spans_to_be_exported(): new=MockTraceServiceStub, ) def test_batch_span_processor(benchmark): - """Runs benchmark tests using BatchExportSpanProcessor. + """Runs benchmark tests using BatchSpanProcessor. One particular call by pytest-benchmark will be much more expensive since the batch export thread will activate and consume a lot of CPU to process all the spans. For this reason, focus on the average measurement. Do not focus on the min/max measurements which will be misleading. """ - tracer = get_tracer_with_processor(BatchExportSpanProcessor) + tracer = get_tracer_with_processor(BatchSpanProcessor) def create_spans_to_be_exported(): span = tracer.start_span("benchmarkedSpan",) diff --git a/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py b/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py index a1dbcfbd63b..d9ae6e2a014 100644 --- a/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py +++ b/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py @@ -56,7 +56,7 @@ from opentelemetry.sdk.trace import StatusCode as SDKStatusCode from opentelemetry.sdk.trace import TracerProvider, _Span from opentelemetry.sdk.trace.export import ( - SimpleExportSpanProcessor, + SimpleSpanProcessor, SpanExportResult, ) from opentelemetry.sdk.util.instrumentation import InstrumentationInfo @@ -115,7 +115,7 @@ def setUp(self): tracer_provider = TracerProvider() self.exporter = OTLPSpanExporter(insecure=True) tracer_provider.add_span_processor( - SimpleExportSpanProcessor(self.exporter) + SimpleSpanProcessor(self.exporter) ) self.tracer = tracer_provider.get_tracer(__name__) diff --git a/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py b/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py index 1b2554923f6..3dce5e4ed2c 100644 --- a/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py +++ b/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py @@ -34,7 +34,7 @@ from opentelemetry import trace from opentelemetry.exporter import zipkin from opentelemetry.sdk.trace import TracerProvider - from opentelemetry.sdk.trace.export import BatchExportSpanProcessor + from opentelemetry.sdk.trace.export import BatchSpanProcessor trace.set_tracer_provider(TracerProvider()) tracer = trace.get_tracer(__name__) @@ -50,8 +50,8 @@ # max_tag_value_length=256 ) - # Create a BatchExportSpanProcessor and add the exporter to it - span_processor = BatchExportSpanProcessor(zipkin_exporter) + # Create a BatchSpanProcessor and add the exporter to it + span_processor = BatchSpanProcessor(zipkin_exporter) # add to the tracer trace.get_tracer_provider().add_span_processor(span_processor) diff --git a/opentelemetry-distro/src/opentelemetry/distro/__init__.py b/opentelemetry-distro/src/opentelemetry/distro/__init__.py index 46b469b0fb8..02f70d3431e 100644 --- a/opentelemetry-distro/src/opentelemetry/distro/__init__.py +++ b/opentelemetry-distro/src/opentelemetry/distro/__init__.py @@ -30,7 +30,7 @@ from opentelemetry.sdk.resources import Resource from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( - BatchExportSpanProcessor, + BatchSpanProcessor, SpanExporter, ) from opentelemetry.sdk.trace.ids_generator import IdsGenerator @@ -95,7 +95,7 @@ def _init_tracing( exporter_args["service_name"] = service_name provider.add_span_processor( - BatchExportSpanProcessor(exporter_class(**exporter_args)) + BatchSpanProcessor(exporter_class(**exporter_args)) ) diff --git a/opentelemetry-distro/tests/test_configurator.py b/opentelemetry-distro/tests/test_configurator.py index e1a8cfc8ae0..0654d4164e2 100644 --- a/opentelemetry-distro/tests/test_configurator.py +++ b/opentelemetry-distro/tests/test_configurator.py @@ -84,7 +84,7 @@ def setUp(self): "opentelemetry.distro.TracerProvider", Provider ) self.get_processor_patcher = patch( - "opentelemetry.distro.BatchExportSpanProcessor", Processor + "opentelemetry.distro.BatchSpanProcessor", Processor ) self.set_provider_patcher = patch( "opentelemetry.trace.set_tracer_provider" diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py index 18f14654739..457c7f4d6ee 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py @@ -46,7 +46,7 @@ class SpanExporter: in their own format. To export data this MUST be registered to the :class`opentelemetry.sdk.trace.Tracer` using a - `SimpleExportSpanProcessor` or a `BatchExportSpanProcessor`. + `SimpleSpanProcessor` or a `BatchSpanProcessor`. """ def export( @@ -68,10 +68,10 @@ def shutdown(self) -> None: """ -class SimpleExportSpanProcessor(SpanProcessor): +class SimpleSpanProcessor(SpanProcessor): """Simple SpanProcessor implementation. - SimpleExportSpanProcessor is an implementation of `SpanProcessor` that + SimpleSpanProcessor is an implementation of `SpanProcessor` that passes ended spans directly to the configured `SpanExporter`. """ @@ -103,7 +103,7 @@ def force_flush(self, timeout_millis: int = 30000) -> bool: class _FlushRequest: - """Represents a request for the BatchExportSpanProcessor to flush spans.""" + """Represents a request for the BatchSpanProcessor to flush spans.""" __slots__ = ["event", "num_spans"] @@ -112,10 +112,10 @@ def __init__(self): self.num_spans = 0 -class BatchExportSpanProcessor(SpanProcessor): +class BatchSpanProcessor(SpanProcessor): """Batch span processor implementation. - BatchExportSpanProcessor is an implementation of `SpanProcessor` that + BatchSpanProcessor is an implementation of `SpanProcessor` that batches ended spans and pushes them to the configured `SpanExporter`. """ diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py b/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py index cc860fc7a70..81051f4b031 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py @@ -41,7 +41,7 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) from opentelemetry.sdk.trace.sampling import TraceIdRatioBased @@ -53,7 +53,7 @@ # set up an exporter for sampled spans trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) # created spans will now be sampled by the TraceIdRatioBased sampler @@ -81,14 +81,14 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) trace.set_tracer_provider(TracerProvider()) # set up an exporter for sampled spans trace.get_tracer_provider().add_span_processor( - SimpleExportSpanProcessor(ConsoleSpanExporter()) + SimpleSpanProcessor(ConsoleSpanExporter()) ) # created spans will now be sampled by the TraceIdRatioBased sampler with rate 1/1000. diff --git a/opentelemetry-sdk/tests/context/test_asyncio.py b/opentelemetry-sdk/tests/context/test_asyncio.py index 7f9539738ca..a9b32e10faa 100644 --- a/opentelemetry-sdk/tests/context/test_asyncio.py +++ b/opentelemetry-sdk/tests/context/test_asyncio.py @@ -68,7 +68,7 @@ def setUp(self): self.tracer_provider = trace.TracerProvider() self.tracer = self.tracer_provider.get_tracer(__name__) self.memory_exporter = InMemorySpanExporter() - span_processor = export.SimpleExportSpanProcessor(self.memory_exporter) + span_processor = export.SimpleSpanProcessor(self.memory_exporter) self.tracer_provider.add_span_processor(span_processor) self.loop = asyncio.get_event_loop() diff --git a/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_batch_export.py b/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_batch_export.py index 08e3d772452..570965cd53d 100644 --- a/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_batch_export.py +++ b/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_batch_export.py @@ -17,7 +17,7 @@ from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.trace import TracerProvider, sampling -from opentelemetry.sdk.trace.export import BatchExportSpanProcessor +from opentelemetry.sdk.trace.export import BatchSpanProcessor TEST_DURATION_SECONDS = 15 SPANS_PER_SECOND = 10_000 @@ -31,7 +31,7 @@ def __init__(self, channel): old_stub = OTLPSpanExporter._stub OTLPSpanExporter._stub = MockTraceServiceStub -simple_span_processor = BatchExportSpanProcessor(OTLPSpanExporter()) +simple_span_processor = BatchSpanProcessor(OTLPSpanExporter()) tracer = TracerProvider( active_span_processor=simple_span_processor, sampler=sampling.DEFAULT_ON, ).get_tracer("resource_usage_tracer") diff --git a/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_simple_export.py b/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_simple_export.py index f9dc460b005..4636b31d5cd 100644 --- a/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_simple_export.py +++ b/opentelemetry-sdk/tests/performance/resource-usage/trace/profile_resource_usage_simple_export.py @@ -17,7 +17,7 @@ from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.trace import TracerProvider, sampling -from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor +from opentelemetry.sdk.trace.export import SimpleSpanProcessor TEST_DURATION_SECONDS = 15 SPANS_PER_SECOND = 10_000 @@ -31,7 +31,7 @@ def __init__(self, channel): old_stub = OTLPSpanExporter._stub OTLPSpanExporter._stub = MockTraceServiceStub -simple_span_processor = SimpleExportSpanProcessor(OTLPSpanExporter()) +simple_span_processor = SimpleSpanProcessor(OTLPSpanExporter()) tracer = TracerProvider( active_span_processor=simple_span_processor, sampler=sampling.DEFAULT_ON, ).get_tracer("resource_usage_tracer") diff --git a/opentelemetry-sdk/tests/trace/export/test_export.py b/opentelemetry-sdk/tests/trace/export/test_export.py index 86cd990cca6..4cdf6eb4570 100644 --- a/opentelemetry-sdk/tests/trace/export/test_export.py +++ b/opentelemetry-sdk/tests/trace/export/test_export.py @@ -64,7 +64,7 @@ def shutdown(self): self.is_shutdown = True -class TestSimpleExportSpanProcessor(unittest.TestCase): +class TestSimpleSpanProcessor(unittest.TestCase): def test_simple_span_processor(self): tracer_provider = trace.TracerProvider() tracer = tracer_provider.get_tracer(__name__) @@ -72,7 +72,7 @@ def test_simple_span_processor(self): spans_names_list = [] my_exporter = MySpanExporter(destination=spans_names_list) - span_processor = export.SimpleExportSpanProcessor(my_exporter) + span_processor = export.SimpleSpanProcessor(my_exporter) tracer_provider.add_span_processor(span_processor) with tracer.start_as_current_span("foo"): @@ -97,7 +97,7 @@ def test_simple_span_processor_no_context(self): spans_names_list = [] my_exporter = MySpanExporter(destination=spans_names_list) - span_processor = export.SimpleExportSpanProcessor(my_exporter) + span_processor = export.SimpleSpanProcessor(my_exporter) tracer_provider.add_span_processor(span_processor) with tracer.start_span("foo"): @@ -114,7 +114,7 @@ def test_on_start_accepts_context(self): exporter = MySpanExporter([]) span_processor = mock.Mock( - wraps=export.SimpleExportSpanProcessor(exporter) + wraps=export.SimpleSpanProcessor(exporter) ) tracer_provider.add_span_processor(span_processor) @@ -133,7 +133,7 @@ def test_simple_span_processor_not_sampled(self): spans_names_list = [] my_exporter = MySpanExporter(destination=spans_names_list) - span_processor = export.SimpleExportSpanProcessor(my_exporter) + span_processor = export.SimpleSpanProcessor(my_exporter) tracer_provider.add_span_processor(span_processor) with tracer.start_as_current_span("foo"): @@ -159,7 +159,7 @@ def _create_start_and_end_span(name, span_processor): span.end() -class TestBatchExportSpanProcessor(unittest.TestCase): +class TestBatchSpanProcessor(unittest.TestCase): @mock.patch.dict( "os.environ", { @@ -171,7 +171,7 @@ class TestBatchExportSpanProcessor(unittest.TestCase): ) def test_batch_span_processor_environment_variables(self): - batch_span_processor = export.BatchExportSpanProcessor( + batch_span_processor = export.BatchSpanProcessor( MySpanExporter(destination=[]) ) @@ -184,7 +184,7 @@ def test_on_start_accepts_parent_context(self): # pylint: disable=no-self-use my_exporter = MySpanExporter(destination=[]) span_processor = mock.Mock( - wraps=export.BatchExportSpanProcessor(my_exporter) + wraps=export.BatchSpanProcessor(my_exporter) ) tracer_provider = trace.TracerProvider() tracer_provider.add_span_processor(span_processor) @@ -201,7 +201,7 @@ def test_shutdown(self): spans_names_list = [] my_exporter = MySpanExporter(destination=spans_names_list) - span_processor = export.BatchExportSpanProcessor(my_exporter) + span_processor = export.BatchSpanProcessor(my_exporter) span_names = ["xxx", "bar", "foo"] @@ -219,7 +219,7 @@ def test_flush(self): spans_names_list = [] my_exporter = MySpanExporter(destination=spans_names_list) - span_processor = export.BatchExportSpanProcessor(my_exporter) + span_processor = export.BatchSpanProcessor(my_exporter) span_names0 = ["xxx", "bar", "foo"] span_names1 = ["yyy", "baz", "fox"] @@ -243,7 +243,7 @@ def test_flush_empty(self): spans_names_list = [] my_exporter = MySpanExporter(destination=spans_names_list) - span_processor = export.BatchExportSpanProcessor(my_exporter) + span_processor = export.BatchSpanProcessor(my_exporter) self.assertTrue(span_processor.force_flush()) @@ -254,7 +254,7 @@ def test_flush_from_multiple_threads(self): span_list = [] my_exporter = MySpanExporter(destination=span_list) - span_processor = export.BatchExportSpanProcessor( + span_processor = export.BatchSpanProcessor( my_exporter, max_queue_size=512, max_export_batch_size=128 ) @@ -281,7 +281,7 @@ def test_flush_timeout(self): my_exporter = MySpanExporter( destination=spans_names_list, export_timeout_millis=500 ) - span_processor = export.BatchExportSpanProcessor(my_exporter) + span_processor = export.BatchSpanProcessor(my_exporter) _create_start_and_end_span("foo", span_processor) @@ -297,7 +297,7 @@ def test_batch_span_processor_lossless(self): my_exporter = MySpanExporter( destination=spans_names_list, max_export_batch_size=128 ) - span_processor = export.BatchExportSpanProcessor( + span_processor = export.BatchSpanProcessor( my_exporter, max_queue_size=512, max_export_batch_size=128 ) @@ -316,7 +316,7 @@ def test_batch_span_processor_many_spans(self): my_exporter = MySpanExporter( destination=spans_names_list, max_export_batch_size=128 ) - span_processor = export.BatchExportSpanProcessor( + span_processor = export.BatchSpanProcessor( my_exporter, max_queue_size=256, max_export_batch_size=64, @@ -343,7 +343,7 @@ def test_batch_span_processor_not_sampled(self): my_exporter = MySpanExporter( destination=spans_names_list, max_export_batch_size=128 ) - span_processor = export.BatchExportSpanProcessor( + span_processor = export.BatchSpanProcessor( my_exporter, max_queue_size=256, max_export_batch_size=64, @@ -366,7 +366,7 @@ def test_batch_span_processor_scheduled_delay(self): my_exporter = MySpanExporter( destination=spans_names_list, export_event=export_event ) - span_processor = export.BatchExportSpanProcessor( + span_processor = export.BatchSpanProcessor( my_exporter, schedule_delay_millis=50, ) @@ -392,7 +392,7 @@ def test_batch_span_processor_reset_timeout(self): export_timeout_millis=50, ) - span_processor = export.BatchExportSpanProcessor( + span_processor = export.BatchSpanProcessor( my_exporter, schedule_delay_millis=50, ) @@ -421,13 +421,13 @@ def test_batch_span_processor_reset_timeout(self): def test_batch_span_processor_parameters(self): # zero max_queue_size self.assertRaises( - ValueError, export.BatchExportSpanProcessor, None, max_queue_size=0 + ValueError, export.BatchSpanProcessor, None, max_queue_size=0 ) # negative max_queue_size self.assertRaises( ValueError, - export.BatchExportSpanProcessor, + export.BatchSpanProcessor, None, max_queue_size=-500, ) @@ -435,7 +435,7 @@ def test_batch_span_processor_parameters(self): # zero schedule_delay_millis self.assertRaises( ValueError, - export.BatchExportSpanProcessor, + export.BatchSpanProcessor, None, schedule_delay_millis=0, ) @@ -443,7 +443,7 @@ def test_batch_span_processor_parameters(self): # negative schedule_delay_millis self.assertRaises( ValueError, - export.BatchExportSpanProcessor, + export.BatchSpanProcessor, None, schedule_delay_millis=-500, ) @@ -451,7 +451,7 @@ def test_batch_span_processor_parameters(self): # zero max_export_batch_size self.assertRaises( ValueError, - export.BatchExportSpanProcessor, + export.BatchSpanProcessor, None, max_export_batch_size=0, ) @@ -459,7 +459,7 @@ def test_batch_span_processor_parameters(self): # negative max_export_batch_size self.assertRaises( ValueError, - export.BatchExportSpanProcessor, + export.BatchSpanProcessor, None, max_export_batch_size=-500, ) @@ -467,7 +467,7 @@ def test_batch_span_processor_parameters(self): # max_export_batch_size > max_queue_size: self.assertRaises( ValueError, - export.BatchExportSpanProcessor, + export.BatchSpanProcessor, None, max_queue_size=256, max_export_batch_size=512, diff --git a/opentelemetry-sdk/tests/trace/export/test_in_memory_span_exporter.py b/opentelemetry-sdk/tests/trace/export/test_in_memory_span_exporter.py index e45e8ee8fd5..eb366728c0b 100644 --- a/opentelemetry-sdk/tests/trace/export/test_in_memory_span_exporter.py +++ b/opentelemetry-sdk/tests/trace/export/test_in_memory_span_exporter.py @@ -28,7 +28,7 @@ def setUp(self): self.tracer_provider = trace.TracerProvider() self.tracer = self.tracer_provider.get_tracer(__name__) self.memory_exporter = InMemorySpanExporter() - span_processor = export.SimpleExportSpanProcessor(self.memory_exporter) + span_processor = export.SimpleSpanProcessor(self.memory_exporter) self.tracer_provider.add_span_processor(span_processor) self.exec_scenario() diff --git a/shim/opentelemetry-opentracing-shim/tests/testbed/otel_ot_shim_tracer.py b/shim/opentelemetry-opentracing-shim/tests/testbed/otel_ot_shim_tracer.py index 6ed5818e34e..fa1f537a99e 100644 --- a/shim/opentelemetry-opentracing-shim/tests/testbed/otel_ot_shim_tracer.py +++ b/shim/opentelemetry-opentracing-shim/tests/testbed/otel_ot_shim_tracer.py @@ -1,6 +1,6 @@ import opentelemetry.shim.opentracing_shim as opentracingshim from opentelemetry.sdk import trace -from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor +from opentelemetry.sdk.trace.export import SimpleSpanProcessor from opentelemetry.sdk.trace.export.in_memory_span_exporter import ( InMemorySpanExporter, ) @@ -17,7 +17,7 @@ def __init__(self): oteltracer = tracer_provider.get_tracer(__name__) super(MockTracer, self).__init__(oteltracer) exporter = InMemorySpanExporter() - span_processor = SimpleExportSpanProcessor(exporter) + span_processor = SimpleSpanProcessor(exporter) tracer_provider.add_span_processor(span_processor) self.exporter = exporter diff --git a/tests/opentelemetry-docker-tests/tests/opencensus/test_opencensusexporter_functional.py b/tests/opentelemetry-docker-tests/tests/opencensus/test_opencensusexporter_functional.py index c7948917834..ce2f3a02b4d 100644 --- a/tests/opentelemetry-docker-tests/tests/opencensus/test_opencensusexporter_functional.py +++ b/tests/opentelemetry-docker-tests/tests/opencensus/test_opencensusexporter_functional.py @@ -18,11 +18,11 @@ OpenCensusSpanExporter, ) from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor +from opentelemetry.sdk.trace.export import SimpleSpanProcessor from opentelemetry.test.test_base import TestBase -class ExportStatusSpanProcessor(SimpleExportSpanProcessor): +class ExportStatusSpanProcessor(SimpleSpanProcessor): def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.export_status = [] diff --git a/tests/util/src/opentelemetry/test/spantestutil.py b/tests/util/src/opentelemetry/test/spantestutil.py index 4ae4669a040..3e7de791589 100644 --- a/tests/util/src/opentelemetry/test/spantestutil.py +++ b/tests/util/src/opentelemetry/test/spantestutil.py @@ -31,7 +31,7 @@ def setUpClass(cls): trace_api.set_tracer_provider(TracerProvider()) tracer_provider = trace_api.get_tracer_provider() _MEMORY_EXPORTER = InMemorySpanExporter() - span_processor = export.SimpleExportSpanProcessor(_MEMORY_EXPORTER) + span_processor = export.SimpleSpanProcessor(_MEMORY_EXPORTER) tracer_provider.add_span_processor(span_processor) @classmethod diff --git a/tests/util/src/opentelemetry/test/test_base.py b/tests/util/src/opentelemetry/test/test_base.py index c1ec6d2ee4a..14ef48d40e1 100644 --- a/tests/util/src/opentelemetry/test/test_base.py +++ b/tests/util/src/opentelemetry/test/test_base.py @@ -65,7 +65,7 @@ def create_tracer_provider(**kwargs): """Helper to create a configured tracer provider. Creates and configures a `TracerProvider` with a - `SimpleExportSpanProcessor` and a `InMemorySpanExporter`. + `SimpleSpanProcessor` and a `InMemorySpanExporter`. All the parameters passed are forwarded to the TracerProvider constructor. @@ -75,7 +75,7 @@ def create_tracer_provider(**kwargs): """ tracer_provider = TracerProvider(**kwargs) memory_exporter = InMemorySpanExporter() - span_processor = export.SimpleExportSpanProcessor(memory_exporter) + span_processor = export.SimpleSpanProcessor(memory_exporter) tracer_provider.add_span_processor(span_processor) return tracer_provider, memory_exporter diff --git a/tests/w3c_tracecontext_validation_server.py b/tests/w3c_tracecontext_validation_server.py index f2fb14f206d..d6c468025e4 100644 --- a/tests/w3c_tracecontext_validation_server.py +++ b/tests/w3c_tracecontext_validation_server.py @@ -29,7 +29,7 @@ from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, - SimpleExportSpanProcessor, + SimpleSpanProcessor, ) # FIXME This could likely be avoided by integrating this script into the @@ -42,7 +42,7 @@ RequestsInstrumentor().instrument() # SpanExporter receives the spans and send them to the target location. -span_processor = SimpleExportSpanProcessor(ConsoleSpanExporter()) +span_processor = SimpleSpanProcessor(ConsoleSpanExporter()) trace.get_tracer_provider().add_span_processor(span_processor) app = flask.Flask(__name__) From 1c0dc2693f78ced459d924e09073a112f1c2c199 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 1 Mar 2021 09:57:20 -0800 Subject: [PATCH 2/3] fix lint --- .../tests/test_otlp_trace_exporter.py | 4 +--- .../src/opentelemetry/distro/__init__.py | 5 +---- opentelemetry-sdk/tests/trace/export/test_export.py | 9 ++------- 3 files changed, 4 insertions(+), 14 deletions(-) diff --git a/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py b/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py index d9ae6e2a014..be35f306237 100644 --- a/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py +++ b/exporter/opentelemetry-exporter-otlp/tests/test_otlp_trace_exporter.py @@ -114,9 +114,7 @@ class TestOTLPSpanExporter(TestCase): def setUp(self): tracer_provider = TracerProvider() self.exporter = OTLPSpanExporter(insecure=True) - tracer_provider.add_span_processor( - SimpleSpanProcessor(self.exporter) - ) + tracer_provider.add_span_processor(SimpleSpanProcessor(self.exporter)) self.tracer = tracer_provider.get_tracer(__name__) self.server = server(ThreadPoolExecutor(max_workers=10)) diff --git a/opentelemetry-distro/src/opentelemetry/distro/__init__.py b/opentelemetry-distro/src/opentelemetry/distro/__init__.py index a9ee844e947..666ab57bb37 100644 --- a/opentelemetry-distro/src/opentelemetry/distro/__init__.py +++ b/opentelemetry-distro/src/opentelemetry/distro/__init__.py @@ -29,10 +29,7 @@ from opentelemetry.instrumentation.distro import BaseDistro from opentelemetry.sdk.resources import Resource from opentelemetry.sdk.trace import TracerProvider -from opentelemetry.sdk.trace.export import ( - BatchSpanProcessor, - SpanExporter, -) +from opentelemetry.sdk.trace.export import BatchSpanProcessor, SpanExporter from opentelemetry.sdk.trace.id_generator import IdGenerator logger = getLogger(__file__) diff --git a/opentelemetry-sdk/tests/trace/export/test_export.py b/opentelemetry-sdk/tests/trace/export/test_export.py index 4cdf6eb4570..831105b8fff 100644 --- a/opentelemetry-sdk/tests/trace/export/test_export.py +++ b/opentelemetry-sdk/tests/trace/export/test_export.py @@ -113,9 +113,7 @@ def test_on_start_accepts_context(self): tracer = tracer_provider.get_tracer(__name__) exporter = MySpanExporter([]) - span_processor = mock.Mock( - wraps=export.SimpleSpanProcessor(exporter) - ) + span_processor = mock.Mock(wraps=export.SimpleSpanProcessor(exporter)) tracer_provider.add_span_processor(span_processor) context = Context() @@ -426,10 +424,7 @@ def test_batch_span_processor_parameters(self): # negative max_queue_size self.assertRaises( - ValueError, - export.BatchSpanProcessor, - None, - max_queue_size=-500, + ValueError, export.BatchSpanProcessor, None, max_queue_size=-500, ) # zero schedule_delay_millis From 6a778683f22200219d1963a366f88828ae10ebbb Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 1 Mar 2021 13:16:36 -0800 Subject: [PATCH 3/3] update sha --- .github/workflows/test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 34e11fc67ee..236cd3fd91f 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -10,7 +10,7 @@ env: # Otherwise, set variable to the commit of your branch on # opentelemetry-python-contrib which is compatible with these Core repo # changes. - CONTRIB_REPO_SHA: c86562fcddcf8fd037492de3880790776abe79ce + CONTRIB_REPO_SHA: 63a755348c2c9a2b83da85a5c72487ddc507b8b4 jobs: build: