-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FRW-9744 addded Guzzle instrumentation
- Loading branch information
Showing
4 changed files
with
196 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
src/Spryker/Service/Opentelemetry/Instrumentation/GuzzleInstrumentation.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Copyright © 2016-present Spryker Systems GmbH. All rights reserved. | ||
| * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file. | ||
| */ | ||
|
|
||
| namespace Spryker\Service\Opentelemetry\Instrumentation; | ||
|
|
||
| use GuzzleHttp\Client; | ||
| use GuzzleHttp\Promise\PromiseInterface; | ||
| use OpenTelemetry\API\Trace\SpanKind; | ||
| use OpenTelemetry\API\Trace\StatusCode; | ||
| use OpenTelemetry\Context\Context; | ||
| use OpenTelemetry\SDK\Sdk; | ||
| use OpenTelemetry\SemConv\TraceAttributes; | ||
| use Psr\Http\Message\ResponseInterface; | ||
| use Spryker\Service\Opentelemetry\Instrumentation\Sampler\CriticalSpanRatioSampler; | ||
| use Spryker\Service\Opentelemetry\Instrumentation\Sampler\TraceSampleResult; | ||
| use Spryker\Service\Opentelemetry\Instrumentation\Span\Span; | ||
| use Spryker\Shared\Opentelemetry\Instrumentation\CachedInstrumentation; | ||
| use Throwable; | ||
| use function OpenTelemetry\Instrumentation\hook; | ||
|
|
||
| class GuzzleInstrumentation | ||
| { | ||
| /** | ||
| * @var string | ||
| */ | ||
| protected const NAME = 'spryker_otel_guzzle'; | ||
|
|
||
| /** | ||
| * @var string | ||
| */ | ||
| protected const HEADER_USER_AGENT = 'User-Agent'; | ||
|
|
||
| /** | ||
| * @return void | ||
| */ | ||
| public static function register(): void | ||
| { | ||
| //BC check | ||
| if (class_exists('\OpenTelemetry\Contrib\Instrumentation\Guzzle\GuzzleInstrumentation')) { | ||
| return; | ||
| } | ||
|
|
||
| if (Sdk::isInstrumentationDisabled(static::NAME) === true) { | ||
| return; | ||
| } | ||
|
|
||
| $instrumentation = CachedInstrumentation::getCachedInstrumentation(); | ||
|
|
||
| hook( | ||
| Client::class, | ||
| 'transfer', | ||
| pre: static function (Client $guzzleClient, array $params, string $class, string $function, ?string $filename, ?int $lineno) use ($instrumentation): void { | ||
| if (TraceSampleResult::shouldSkipTraceBody()) { | ||
| return; | ||
| } | ||
| $context = Context::getCurrent(); | ||
| /** @var \Psr\Http\Message\RequestInterface $request */ | ||
| $request = $params[0]; | ||
| $uriObject = $request->getUri(); | ||
| $method = $request->getMethod(); | ||
| $url = (string)$uriObject; | ||
|
|
||
| $span = $instrumentation->tracer() | ||
| ->spanBuilder(sprintf('Guzzle %s %s', $method, $url)) | ||
| ->setSpanKind(SpanKind::KIND_CLIENT) | ||
| ->setParent($context) | ||
| ->setAttribute(CriticalSpanRatioSampler::IS_CRITICAL_ATTRIBUTE, true) | ||
| ->setAttribute(TraceAttributes::CODE_FUNCTION, $function) | ||
| ->setAttribute(TraceAttributes::CODE_NAMESPACE, $class) | ||
| ->setAttribute(TraceAttributes::CODE_FILEPATH, $filename) | ||
| ->setAttribute(TraceAttributes::CODE_LINENO, $lineno) | ||
| ->setAttribute(TraceAttributes::SERVER_ADDRESS, $uriObject->getHost()) | ||
| ->setAttribute(TraceAttributes::SERVER_PORT, $uriObject->getPort()) | ||
| ->setAttribute(TraceAttributes::URL_PATH, $uriObject->getPath()) | ||
| ->setAttribute(TraceAttributes::URL_FULL, $url) | ||
| ->setAttribute(TraceAttributes::HTTP_REQUEST_METHOD, $method) | ||
| ->setAttribute(TraceAttributes::NETWORK_PROTOCOL_VERSION, $request->getProtocolVersion()) | ||
| ->setAttribute(TraceAttributes::USER_AGENT_ORIGINAL, $request->getHeaderLine(static::HEADER_USER_AGENT)) | ||
| ->startSpan(); | ||
|
|
||
| Context::storage()->attach($span->storeInContext($context)); | ||
| }, | ||
| post: static function (Client $guzzleClient, array $params, PromiseInterface $promise, ?Throwable $exception): void { | ||
| if (TraceSampleResult::shouldSkipTraceBody()) { | ||
| return; | ||
| } | ||
| $scope = Context::storage()->scope(); | ||
|
|
||
| if ($scope === null) { | ||
| return; | ||
| } | ||
|
|
||
| $scope->detach(); | ||
|
|
||
| $span = Span::fromContext($scope->context()); | ||
|
|
||
| if ($exception) { | ||
| $span->recordException($exception); | ||
| $span->setStatus(StatusCode::STATUS_ERROR); | ||
| $span->end(); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $promise->then( | ||
| onFulfilled: function (ResponseInterface $response) use ($span) { | ||
| $span->setAttribute(TraceAttributes::HTTP_RESPONSE_STATUS_CODE, $response->getStatusCode()); | ||
|
|
||
| if ($response->getStatusCode() >= 400 && $response->getStatusCode() < 600) { | ||
| $span->setStatus(StatusCode::STATUS_ERROR); | ||
| } | ||
| $span->end(); | ||
|
|
||
| return $response; | ||
| }, | ||
| onRejected: function (Throwable $exception) use ($span) { | ||
| $span->recordException($exception); | ||
| $span->setStatus(StatusCode::STATUS_ERROR); | ||
| $span->end(); | ||
|
|
||
| throw $exception; | ||
| } | ||
| ); | ||
| }, | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters