open-telemetry
/
opentelemetry-php
mirror of https://github.com/open-telemetry/opentelemetry-php.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Feature/add record exception (#255) 

* Add recordException event, test and examples

Fix phpstan errors

* Attempt to fix test failures
This commit is contained in:
Onyemenam Ndubuisi 2021-02-26 17:20:02 +01:00 committed by GitHub
parent e35fe4679f
commit 3c18f3a4ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api/Trace/Span.php
View File

@ -4,6 +4,8 @@ declare(strict_types=1);
namespace OpenTelemetry\Trace;
use Exception;
interface Span extends SpanStatus, SpanKind
{
public function getSpanName(): string;
@ -58,6 +60,13 @@ interface Span extends SpanStatus, SpanKind
*/
public function addLink(SpanContext $context, ?Attributes $attributes = null): Span;
/**
*
* @param Exception $exception
* @return Span Must return $this to allow setting multiple attributes at once in a chain.
*/
public function recordException(Exception $exception): Span;
/**
* Calling this method is highly discouraged; the name should be set on creation and left alone.
* @param string $name

6
examples/AlwaysOnJaegerExample.php
View File

@ -56,6 +56,12 @@ if (SamplingResult::RECORD_AND_SAMPLED === $samplingResult->getDecision()) {
'id' => md5((string) microtime(true)),
]));
try {
throw new Exception('Record exception test event');
} catch (Exception $exception) {
$span->recordException($exception);
}
$tracer->endActiveSpan();
}
echo PHP_EOL . 'AlwaysOnJaegerExample complete! See the results at http://localhost:16686/';

6
examples/AlwaysOnZipkinExample.php
View File

@ -56,6 +56,12 @@ if (SamplingResult::RECORD_AND_SAMPLED === $samplingResult->getDecision()) {
'id' => md5((string) microtime(true)),
]));
try {
throw new Exception('Record exception test event');
} catch (Exception $exception) {
$span->recordException($exception);
}
$tracer->endActiveSpan();
}
echo PHP_EOL . 'AlwaysOnZipkinExample complete! See the results at http://localhost:9411/';

15
sdk/Trace/NoopSpan.php
View File

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace OpenTelemetry\Sdk\Trace;
use Exception;
use OpenTelemetry\Trace as API;
class NoopSpan implements \OpenTelemetry\Trace\Span
@ -118,6 +119,20 @@ class NoopSpan implements \OpenTelemetry\Trace\Span
return $this;
}
public function recordException(Exception $exception): API\Span
{
$attributes = new Attributes(
[
'exception.type' => get_class($exception),
'exception.message' => $exception->getMessage(),
'exception.stacktrace' => $exception->getTraceAsString(),
]
);
$timestamp = time();
return $this->addEvent('exception', $timestamp, $attributes);
}
public function updateName(string $name): API\Span
{
return $this;

15
sdk/Trace/Span.php
View File

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace OpenTelemetry\Sdk\Trace;
use Exception;
use OpenTelemetry\Sdk\Resource\ResourceInfo;
use OpenTelemetry\Trace as API;
@ -207,6 +208,20 @@ class Span implements API\Span
return $this;
}
public function recordException(Exception $exception): API\Span
{
$attributes = new Attributes(
[
'exception.type' => get_class($exception),
'exception.message' => $exception->getMessage(),
'exception.stacktrace' => $exception->getTraceAsString(),
]
);
$timestamp = time();
return $this->addEvent('exception', $timestamp, $attributes);
}
public function getEvents(): API\Events
{
return $this->events;

15
tests/Sdk/Unit/Trace/NoopSpanTest.php
View File

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace OpenTelemetry\Tests\Sdk\Unit\Trace;
use Exception;
use OpenTelemetry\Sdk\Trace\Clock;
use OpenTelemetry\Sdk\Trace\NoopSpan;
use OpenTelemetry\Sdk\Trace\SpanStatus;
@ -51,6 +52,20 @@ class NoopSpanTest extends TestCase
$this->assertEmpty($this->span->getEvents());
}
/** @test */
public function eventsCollectionShouldBeEmptyEvenAfterRecordExceptionEventUpdate()
{
$this->assertEmpty($this->span->getEvents());
try {
throw new Exception('Record exception test event');
} catch (Exception $exception) {
$this->span->recordException($exception);
}
$this->assertEmpty($this->span->getEvents());
}
/** @test */
public function itsStatusShouldBeOkAndNoUpdatesShouldChangeIt()
{

32
tests/Sdk/Unit/Trace/TracingTest.php
View File

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace OpenTelemetry\Tests\Sdk\Unit\Trace;
use Exception;
use function iterator_to_array;
use OpenTelemetry\Sdk\Resource\ResourceConstants;
use OpenTelemetry\Sdk\Resource\ResourceInfo;
@ -286,6 +287,37 @@ class TracingTest extends TestCase
$this->assertCount(2, $span->getEvents());
}
public function testRecordExceptionEventRegistration()
{
$tracerProvider = new SDK\TracerProvider();
$tracer = $tracerProvider->getTracer('OpenTelemetry.TracingTest');
$span = $tracer->startAndActivateSpan('zerodivisiontest');
try {
throw new Exception('Record exception test event');
} catch (Exception $exception) {
$span->recordException($exception);
}
$events = $span->getEvents();
self::assertCount(1, $events);
[$event] = iterator_to_array($events);
$this->assertSame($event->getName(), 'exception');
$this->assertArrayHasKey('exception.type', iterator_to_array($event->getAttributes()));
$this->assertArrayHasKey('exception.message', iterator_to_array($event->getAttributes()));
$this->assertArrayHasKey('exception.stacktrace', iterator_to_array($event->getAttributes()));
$timestamp = Clock::get()->timestamp();
$span->addEvent('update', $timestamp)
->setAttribute('space', 'guard.session')
->setAttribute('id', 67235)
->setAttribute('active_at', time());
$this->assertCount(2, $span->getEvents());
}
public function testAddEventWhenNotRecording()
{
$tracerProvider = new SDK\TracerProvider();