From 2c00772cad85ffec17e14349f678025d173ad772 Mon Sep 17 00:00:00 2001 From: Timo Michna Date: Sat, 13 Nov 2021 16:27:47 +0100 Subject: [PATCH] Move SpanContext and SpanContextKey to API (#467) --- src/API/Trace/AbstractSpan.php | 2 -- src/API/Trace/Propagation/TraceContextPropagator.php | 2 +- src/{SDK => API}/Trace/SpanContext.php | 2 +- src/{SDK => API}/Trace/SpanContextKey.php | 2 +- src/SDK/Trace/SpanBuilder.php | 2 +- tests/Context/Unit/Propagation/TraceContextPropagatorTest.php | 2 +- tests/Contrib/Unit/OTLPGrpcSpanConverterTest.php | 2 +- tests/Contrib/Unit/OTLPHttpSpanConverterTest.php | 2 +- tests/Contrib/Unit/ZipkinSpanConverterTest.php | 2 +- tests/SDK/Integration/AlwaysOffSamplerTest.php | 2 +- tests/SDK/Integration/AlwaysOnSamplerTest.php | 2 +- tests/SDK/Integration/Context/SpanContextTest.php | 2 +- tests/SDK/Integration/ParentBasedTest.php | 2 +- tests/SDK/Integration/TraceIdRatioBasedSamplerTest.php | 2 +- tests/SDK/Integration/TracerTest.php | 2 +- tests/SDK/Unit/Trace/RandomIdGeneratorTest.php | 2 +- tests/SDK/Unit/Trace/SpanBuilderTest.php | 2 +- tests/SDK/Unit/Trace/SpanContextTest.php | 2 +- .../SDK/Unit/Trace/SpanProcessor/SimpleSpanProcessorTest.php | 2 +- tests/SDK/Unit/Trace/SpanTest.php | 2 +- tests/SDK/Util/SpanData.php | 4 ++-- tests/TraceContext/W3CTestService/TestController.php | 2 +- 22 files changed, 22 insertions(+), 24 deletions(-) rename src/{SDK => API}/Trace/SpanContext.php (99%) rename src/{SDK => API}/Trace/SpanContextKey.php (93%) diff --git a/src/API/Trace/AbstractSpan.php b/src/API/Trace/AbstractSpan.php index 921896af..e9488777 100644 --- a/src/API/Trace/AbstractSpan.php +++ b/src/API/Trace/AbstractSpan.php @@ -6,8 +6,6 @@ namespace OpenTelemetry\API\Trace; use OpenTelemetry\Context\Context; use OpenTelemetry\Context\ScopeInterface; -use OpenTelemetry\SDK\Trace\SpanContext; -use OpenTelemetry\SDK\Trace\SpanContextKey; abstract class AbstractSpan implements SpanInterface { diff --git a/src/API/Trace/Propagation/TraceContextPropagator.php b/src/API/Trace/Propagation/TraceContextPropagator.php index 0b9d0a9f..777c4bb7 100644 --- a/src/API/Trace/Propagation/TraceContextPropagator.php +++ b/src/API/Trace/Propagation/TraceContextPropagator.php @@ -8,13 +8,13 @@ use function count; use function explode; use function hexdec; use OpenTelemetry\API\Trace as API; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\Context\Propagation\ArrayAccessGetterSetter; use OpenTelemetry\Context\Propagation\PropagationGetterInterface; use OpenTelemetry\Context\Propagation\PropagationSetterInterface; use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface; use OpenTelemetry\SDK\Trace\Span; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; /** diff --git a/src/SDK/Trace/SpanContext.php b/src/API/Trace/SpanContext.php similarity index 99% rename from src/SDK/Trace/SpanContext.php rename to src/API/Trace/SpanContext.php index 1c7a1c0f..0b20b21d 100644 --- a/src/SDK/Trace/SpanContext.php +++ b/src/API/Trace/SpanContext.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace OpenTelemetry\SDK\Trace; +namespace OpenTelemetry\API\Trace; use OpenTelemetry\API\Trace as API; use function strlen; diff --git a/src/SDK/Trace/SpanContextKey.php b/src/API/Trace/SpanContextKey.php similarity index 93% rename from src/SDK/Trace/SpanContextKey.php rename to src/API/Trace/SpanContextKey.php index d50b36bf..2321e0c0 100644 --- a/src/SDK/Trace/SpanContextKey.php +++ b/src/API/Trace/SpanContextKey.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace OpenTelemetry\SDK\Trace; +namespace OpenTelemetry\API\Trace; use OpenTelemetry\Context\Context; use OpenTelemetry\Context\ContextKey; diff --git a/src/SDK/Trace/SpanBuilder.php b/src/SDK/Trace/SpanBuilder.php index 8987bd50..28a8a957 100644 --- a/src/SDK/Trace/SpanBuilder.php +++ b/src/SDK/Trace/SpanBuilder.php @@ -186,7 +186,7 @@ final class SpanBuilder implements API\SpanBuilderInterface $samplingDecision = $samplingResult->getDecision(); $samplingResultTraceState = $samplingResult->getTraceState(); - $spanContext = SpanContext::create( + $spanContext = API\SpanContext::create( $traceId, $spanId, SamplingResult::RECORD_AND_SAMPLE === $samplingDecision ? API\SpanContextInterface::TRACE_FLAG_SAMPLED : API\SpanContextInterface::TRACE_FLAG_DEFAULT, diff --git a/tests/Context/Unit/Propagation/TraceContextPropagatorTest.php b/tests/Context/Unit/Propagation/TraceContextPropagatorTest.php index 5495542b..cc15665e 100644 --- a/tests/Context/Unit/Propagation/TraceContextPropagatorTest.php +++ b/tests/Context/Unit/Propagation/TraceContextPropagatorTest.php @@ -5,11 +5,11 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\Context\Unit\Propagation; use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\API\Trace\SpanContextInterface; use OpenTelemetry\API\Trace\TraceStateInterface; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Span; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; use PHPUnit\Framework\TestCase; diff --git a/tests/Contrib/Unit/OTLPGrpcSpanConverterTest.php b/tests/Contrib/Unit/OTLPGrpcSpanConverterTest.php index 940a6b3b..3c179853 100644 --- a/tests/Contrib/Unit/OTLPGrpcSpanConverterTest.php +++ b/tests/Contrib/Unit/OTLPGrpcSpanConverterTest.php @@ -5,6 +5,7 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\Contrib\Unit; use function bin2hex; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Contrib\OtlpGrpc\SpanConverter; use Opentelemetry\Proto\Common\V1\AnyValue; use Opentelemetry\Proto\Common\V1\KeyValue; @@ -15,7 +16,6 @@ use Opentelemetry\Proto\Trace\V1\ResourceSpans; use OpenTelemetry\SDK\InstrumentationLibrary; use OpenTelemetry\SDK\Resource\ResourceInfo; use OpenTelemetry\SDK\Trace\Attributes; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\StatusData; use OpenTelemetry\Tests\SDK\Util\SpanData; use PHPUnit\Framework\TestCase; diff --git a/tests/Contrib/Unit/OTLPHttpSpanConverterTest.php b/tests/Contrib/Unit/OTLPHttpSpanConverterTest.php index 7f37ba03..62e40e5c 100644 --- a/tests/Contrib/Unit/OTLPHttpSpanConverterTest.php +++ b/tests/Contrib/Unit/OTLPHttpSpanConverterTest.php @@ -5,6 +5,7 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\Contrib\Unit; use function bin2hex; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Contrib\OtlpHttp\SpanConverter; use Opentelemetry\Proto\Common\V1\AnyValue; use Opentelemetry\Proto\Common\V1\ArrayValue; @@ -17,7 +18,6 @@ use OpenTelemetry\SDK\InstrumentationLibrary; use OpenTelemetry\SDK\Resource\ResourceInfo; use OpenTelemetry\SDK\Trace\Attributes; use OpenTelemetry\SDK\Trace\Span; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\StatusData; use OpenTelemetry\Tests\SDK\Util\SpanData; diff --git a/tests/Contrib/Unit/ZipkinSpanConverterTest.php b/tests/Contrib/Unit/ZipkinSpanConverterTest.php index 2f36d4ed..ecbf1acb 100644 --- a/tests/Contrib/Unit/ZipkinSpanConverterTest.php +++ b/tests/Contrib/Unit/ZipkinSpanConverterTest.php @@ -4,13 +4,13 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\Contrib\Unit; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\API\Trace\SpanKind; use OpenTelemetry\API\Trace\StatusCode; use OpenTelemetry\Contrib\Zipkin\SpanConverter; use OpenTelemetry\SDK\InstrumentationLibrary; use OpenTelemetry\SDK\Trace\Attribute; use OpenTelemetry\SDK\Trace\Attributes; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\StatusData; use OpenTelemetry\Tests\SDK\Util\SpanData; use PHPUnit\Framework\TestCase; diff --git a/tests/SDK/Integration/AlwaysOffSamplerTest.php b/tests/SDK/Integration/AlwaysOffSamplerTest.php index 87518c5b..3b9e12ff 100644 --- a/tests/SDK/Integration/AlwaysOffSamplerTest.php +++ b/tests/SDK/Integration/AlwaysOffSamplerTest.php @@ -6,10 +6,10 @@ namespace OpenTelemetry\Tests\SDK\Integration; use OpenTelemetry\API\Trace as API; use OpenTelemetry\API\Trace\NonRecordingSpan; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Sampler\AlwaysOffSampler; use OpenTelemetry\SDK\Trace\SamplingResult; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; use PHPUnit\Framework\TestCase; diff --git a/tests/SDK/Integration/AlwaysOnSamplerTest.php b/tests/SDK/Integration/AlwaysOnSamplerTest.php index d2602639..f834ed02 100644 --- a/tests/SDK/Integration/AlwaysOnSamplerTest.php +++ b/tests/SDK/Integration/AlwaysOnSamplerTest.php @@ -6,10 +6,10 @@ namespace OpenTelemetry\Tests\SDK\Integration; use OpenTelemetry\API\Trace as API; use OpenTelemetry\API\Trace\NonRecordingSpan; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler; use OpenTelemetry\SDK\Trace\SamplingResult; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; use PHPUnit\Framework\TestCase; diff --git a/tests/SDK/Integration/Context/SpanContextTest.php b/tests/SDK/Integration/Context/SpanContextTest.php index a50f8fba..0b44f388 100644 --- a/tests/SDK/Integration/Context/SpanContextTest.php +++ b/tests/SDK/Integration/Context/SpanContextTest.php @@ -5,8 +5,8 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\SDK\Integration\Context; use OpenTelemetry\API\Trace as API; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\SDK\Trace\RandomIdGenerator; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; use PHPUnit\Framework\TestCase; diff --git a/tests/SDK/Integration/ParentBasedTest.php b/tests/SDK/Integration/ParentBasedTest.php index 05309242..dc25d15a 100644 --- a/tests/SDK/Integration/ParentBasedTest.php +++ b/tests/SDK/Integration/ParentBasedTest.php @@ -6,11 +6,11 @@ namespace OpenTelemetry\Tests\SDK\Integration; use OpenTelemetry\API\Trace as API; use OpenTelemetry\API\Trace\NonRecordingSpan; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Sampler\ParentBased; use OpenTelemetry\SDK\Trace\SamplerInterface; use OpenTelemetry\SDK\Trace\SamplingResult; -use OpenTelemetry\SDK\Trace\SpanContext; use PHPUnit\Framework\TestCase; class ParentBasedTest extends TestCase diff --git a/tests/SDK/Integration/TraceIdRatioBasedSamplerTest.php b/tests/SDK/Integration/TraceIdRatioBasedSamplerTest.php index dc6129df..ddbb5a11 100644 --- a/tests/SDK/Integration/TraceIdRatioBasedSamplerTest.php +++ b/tests/SDK/Integration/TraceIdRatioBasedSamplerTest.php @@ -7,10 +7,10 @@ namespace OpenTelemetry\Tests\SDK\Integration; use InvalidArgumentException; use OpenTelemetry\API\Trace as API; use OpenTelemetry\API\Trace\NonRecordingSpan; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Sampler\TraceIdRatioBasedSampler; use OpenTelemetry\SDK\Trace\SamplingResult; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; use PHPUnit\Framework\TestCase; diff --git a/tests/SDK/Integration/TracerTest.php b/tests/SDK/Integration/TracerTest.php index 62dfd923..a8aab3f6 100644 --- a/tests/SDK/Integration/TracerTest.php +++ b/tests/SDK/Integration/TracerTest.php @@ -6,12 +6,12 @@ namespace OpenTelemetry\Tests\SDK\Integration; use OpenTelemetry\API\Trace as API; use OpenTelemetry\API\Trace\NonRecordingSpan; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Sampler\AlwaysOffSampler; use OpenTelemetry\SDK\Trace\SamplerInterface; use OpenTelemetry\SDK\Trace\SamplingResult; use OpenTelemetry\SDK\Trace\Span; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\SpanProcessorInterface; use OpenTelemetry\SDK\Trace\TracerProvider; use OpenTelemetry\SDK\Trace\TraceState; diff --git a/tests/SDK/Unit/Trace/RandomIdGeneratorTest.php b/tests/SDK/Unit/Trace/RandomIdGeneratorTest.php index cbc230f7..f54afa6a 100644 --- a/tests/SDK/Unit/Trace/RandomIdGeneratorTest.php +++ b/tests/SDK/Unit/Trace/RandomIdGeneratorTest.php @@ -4,8 +4,8 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\SDK\Unit\Trace; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\SDK\Trace\RandomIdGenerator; -use OpenTelemetry\SDK\Trace\SpanContext; use PHPUnit\Framework\TestCase; class RandomIdGeneratorTest extends TestCase diff --git a/tests/SDK/Unit/Trace/SpanBuilderTest.php b/tests/SDK/Unit/Trace/SpanBuilderTest.php index d0d0a1af..f4332875 100644 --- a/tests/SDK/Unit/Trace/SpanBuilderTest.php +++ b/tests/SDK/Unit/Trace/SpanBuilderTest.php @@ -8,6 +8,7 @@ use Mockery; use Mockery\Adapter\Phpunit\MockeryTestCase; use Mockery\MockInterface; use OpenTelemetry\API\Trace as API; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\Attributes; use OpenTelemetry\SDK\Trace\Link; @@ -15,7 +16,6 @@ use OpenTelemetry\SDK\Trace\Sampler\AlwaysOffSampler; use OpenTelemetry\SDK\Trace\SamplerInterface; use OpenTelemetry\SDK\Trace\SamplingResult; use OpenTelemetry\SDK\Trace\Span; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\SpanLimitsBuilder; use OpenTelemetry\SDK\Trace\SpanProcessorInterface; use OpenTelemetry\SDK\Trace\TracerProvider; diff --git a/tests/SDK/Unit/Trace/SpanContextTest.php b/tests/SDK/Unit/Trace/SpanContextTest.php index efe3144c..81627227 100644 --- a/tests/SDK/Unit/Trace/SpanContextTest.php +++ b/tests/SDK/Unit/Trace/SpanContextTest.php @@ -5,7 +5,7 @@ declare(strict_types=1); namespace OpenTelemetry\Tests\SDK\Unit\Trace; use OpenTelemetry\API\Trace as API; -use OpenTelemetry\SDK\Trace\SpanContext; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\SDK\Trace\TraceState; use PHPUnit\Framework\TestCase; diff --git a/tests/SDK/Unit/Trace/SpanProcessor/SimpleSpanProcessorTest.php b/tests/SDK/Unit/Trace/SpanProcessor/SimpleSpanProcessorTest.php index f7318437..f22a042c 100644 --- a/tests/SDK/Unit/Trace/SpanProcessor/SimpleSpanProcessorTest.php +++ b/tests/SDK/Unit/Trace/SpanProcessor/SimpleSpanProcessorTest.php @@ -7,11 +7,11 @@ namespace OpenTelemetry\Tests\SDK\Unit\Trace\SpanProcessor; use Mockery; use Mockery\Adapter\Phpunit\MockeryTestCase; use Mockery\MockInterface; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\API\Trace\SpanContextInterface; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\Trace\ReadableSpanInterface; use OpenTelemetry\SDK\Trace\ReadWriteSpanInterface; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\SpanExporterInterface; use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor; use OpenTelemetry\Tests\SDK\Util\SpanData; diff --git a/tests/SDK/Unit/Trace/SpanTest.php b/tests/SDK/Unit/Trace/SpanTest.php index 86e2532f..53f147f9 100644 --- a/tests/SDK/Unit/Trace/SpanTest.php +++ b/tests/SDK/Unit/Trace/SpanTest.php @@ -10,6 +10,7 @@ use Mockery; use Mockery\Adapter\Phpunit\MockeryTestCase; use Mockery\MockInterface; use OpenTelemetry\API\Trace as API; +use OpenTelemetry\API\Trace\SpanContext; use OpenTelemetry\Context\Context; use OpenTelemetry\SDK\InstrumentationLibrary; use OpenTelemetry\SDK\Resource\ResourceInfo; @@ -20,7 +21,6 @@ use OpenTelemetry\SDK\Trace\IdGeneratorInterface; use OpenTelemetry\SDK\Trace\Link; use OpenTelemetry\SDK\Trace\RandomIdGenerator; use OpenTelemetry\SDK\Trace\Span; -use OpenTelemetry\SDK\Trace\SpanContext; use OpenTelemetry\SDK\Trace\SpanDataInterface; use OpenTelemetry\SDK\Trace\SpanLimits; use OpenTelemetry\SDK\Trace\SpanLimitsBuilder; diff --git a/tests/SDK/Util/SpanData.php b/tests/SDK/Util/SpanData.php index ec669f9e..2ae065e9 100644 --- a/tests/SDK/Util/SpanData.php +++ b/tests/SDK/Util/SpanData.php @@ -44,8 +44,8 @@ class SpanData implements SDK\SpanDataInterface $this->status = StatusData::unset(); $this->resource = ResourceInfo::emptyResource(); $this->instrumentationLibrary = InstrumentationLibrary::getEmpty(); /** @phan-suppress-current-line PhanAccessMethodInternal */ - $this->context = SDK\SpanContext::getInvalid(); - $this->parentContext = SDK\SpanContext::getInvalid(); + $this->context = API\SpanContext::getInvalid(); + $this->parentContext = API\SpanContext::getInvalid(); } public function getName(): string diff --git a/tests/TraceContext/W3CTestService/TestController.php b/tests/TraceContext/W3CTestService/TestController.php index 7f791f60..09201e6e 100644 --- a/tests/TraceContext/W3CTestService/TestController.php +++ b/tests/TraceContext/W3CTestService/TestController.php @@ -6,7 +6,7 @@ namespace App\Controller; use GuzzleHttp\Client; use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator; -use OpenTelemetry\SDK\Trace\SpanContext; +use OpenTelemetry\API\Trace\SpanContext; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Routing\Annotation\Route;