Add resource usage performance tests for creating a span (open-telemetry#1499)

NathanielRN · web-flow · commit 5bc23b0b0272 · 2021-01-31T10:01:13.000-08:00
diff --git a/README.md b/README.md
@@ -97,6 +97,26 @@ pip install -e ./instrumentation/opentelemetry-instrumentation-{instrumentation}
 For additional exporter and instrumentation packages, see the 
 [`opentelemetry-python-contrib`](https://github.com/open-telemetry/opentelemetry-python-contrib) repository.
 
+## Running Performance Tests
+
+This section provides details on how to reproduce performance tests results on your own
+machine.
+
+### Resource Usage Tests
+
+1. Install scalene using the following command
+
+::
+
+    pip install -U scalene
+
+2. Run the `scalene` tests on any of the example Python programs
+
+::
+
+    scalene opentelemetry-<PACKAGE>/tests/performance/resource-usage/<PATH_TO_TEST>/profile_resource_usage_<NAME_OF_TEST>.py
+
+
 ## Documentation
 
 The online documentation is available at https://opentelemetry-python.readthedocs.io/.
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
@@ -0,0 +1,47 @@
+# Copyright The OpenTelemetry Authors
+#
+# 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.
+
+import time
+from unittest.mock import patch
+
+from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.trace import TracerProvider, sampling
+from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
+
+TEST_DURATION_SECONDS = 15
+SPANS_PER_SECOND = 10_000
+
+
+class MockTraceServiceStub(object):
+    def __init__(self, channel):
+        self.Export = lambda *args, **kwargs: None
+
+
+old_stub = OTLPSpanExporter._stub
+OTLPSpanExporter._stub = MockTraceServiceStub
+
+simple_span_processor = BatchExportSpanProcessor(OTLPSpanExporter())
+tracer = TracerProvider(
+    active_span_processor=simple_span_processor, sampler=sampling.DEFAULT_ON,
+).get_tracer("resource_usage_tracer")
+
+starttime = time.time()
+for _ in range(TEST_DURATION_SECONDS):
+    for _ in range(SPANS_PER_SECOND):
+        span = tracer.start_span("benchmarkedSpan")
+        span.end()
+    time_to_finish_spans = time.time() - starttime
+    time.sleep(1.0 - time_to_finish_spans if time_to_finish_spans < 1.0 else 0)
+
+OTLPSpanExporter._stub = old_stub
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
@@ -0,0 +1,47 @@
+# Copyright The OpenTelemetry Authors
+#
+# 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.
+
+import time
+from unittest.mock import patch
+
+from opentelemetry.exporter.otlp.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.trace import TracerProvider, sampling
+from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor
+
+TEST_DURATION_SECONDS = 15
+SPANS_PER_SECOND = 10_000
+
+
+class MockTraceServiceStub(object):
+    def __init__(self, channel):
+        self.Export = lambda *args, **kwargs: None
+
+
+old_stub = OTLPSpanExporter._stub
+OTLPSpanExporter._stub = MockTraceServiceStub
+
+simple_span_processor = SimpleExportSpanProcessor(OTLPSpanExporter())
+tracer = TracerProvider(
+    active_span_processor=simple_span_processor, sampler=sampling.DEFAULT_ON,
+).get_tracer("resource_usage_tracer")
+
+starttime = time.time()
+for _ in range(TEST_DURATION_SECONDS):
+    for _ in range(SPANS_PER_SECOND):
+        span = tracer.start_span("benchmarkedSpan")
+        span.end()
+    time_to_finish_spans = time.time() - starttime
+    time.sleep(1.0 - time_to_finish_spans if time_to_finish_spans < 1.0 else 0)
+
+OTLPSpanExporter._stub = old_stub
