Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

log discarded span attributes, events, links #1336

Merged
merged 7 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .phan/config.php
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,6 @@
'vendor/guzzlehttp',
'vendor/psr',
'vendor/php-http',
'vendor/phan/phan/src/Phan',
'vendor/phpunit/phpunit/src',
'vendor/google/protobuf/src',
],
Expand Down
11 changes: 11 additions & 0 deletions src/SDK/Trace/Span.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace OpenTelemetry\SDK\Trace;

use OpenTelemetry\API\Behavior\LogsMessagesTrait;
use OpenTelemetry\API\Common\Time\Clock;
use OpenTelemetry\API\Trace as API;
use OpenTelemetry\API\Trace\SpanContextInterface;
Expand All @@ -17,6 +18,7 @@

final class Span extends API\Span implements ReadWriteSpanInterface
{
use LogsMessagesTrait;

/** @var list<EventInterface> */
private array $events = [];
Expand Down Expand Up @@ -249,6 +251,15 @@ public function end(int $endEpochNanos = null): void
return;
}

$spanData = $this->toSpanData();
agoallikmaa marked this conversation as resolved.
Show resolved Hide resolved
if ($spanData->getTotalDroppedLinks() || $spanData->getTotalDroppedEvents() || $spanData->getAttributes()->getDroppedAttributesCount()) {
self::logWarning('Dropped span attributes, links or events', [
agoallikmaa marked this conversation as resolved.
Show resolved Hide resolved
'attributes' => $spanData->getAttributes()->getDroppedAttributesCount(),
'links' => $spanData->getTotalDroppedLinks(),
'events' => $spanData->getTotalDroppedEvents(),
]);
}

$this->endEpochNanos = $endEpochNanos ?? Clock::getDefault()->now();
$this->hasEnded = true;

Expand Down
2 changes: 2 additions & 0 deletions tests/Integration/SDK/SpanBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Mockery;
use Mockery\Adapter\Phpunit\MockeryTestCase;
use Mockery\MockInterface;
use OpenTelemetry\API\Behavior\Internal\Logging;
use OpenTelemetry\API\Trace as API;
use OpenTelemetry\API\Trace\SpanContext;
use OpenTelemetry\API\Trace\SpanContextValidator;
Expand Down Expand Up @@ -96,6 +97,7 @@ public function test_add_link_invalid(): void

public function test_add_link_dropping_links(): void
{
Logging::disable();
$maxNumberOfLinks = 8;
$tracerProvider = new TracerProvider([], null, null, (new SpanLimitsBuilder())->setLinkCountLimit($maxNumberOfLinks)->build());
$spanBuilder = $tracerProvider
Expand Down
2 changes: 2 additions & 0 deletions tests/Integration/SDK/TracerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace OpenTelemetry\Tests\Integration\SDK;

use OpenTelemetry\API\Behavior\Internal\Logging;
use OpenTelemetry\API\Trace as API;
use OpenTelemetry\API\Trace\NonRecordingSpan;
use OpenTelemetry\API\Trace\SpanContext;
Expand Down Expand Up @@ -113,6 +114,7 @@ public function test_factory_returns_noop_tracer_when_sdk_disabled(): void

public function test_general_identity_attributes_are_dropped_by_default(): void
{
Logging::disable();
$exporter = new InMemoryExporter();
$tracerProvider = new TracerProvider(new SimpleSpanProcessor($exporter));
$tracer = $tracerProvider->getTracer('test');
Expand Down
39 changes: 39 additions & 0 deletions tests/Unit/SDK/Trace/SpanTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@
#[CoversClass(Span::class)]
class SpanTest extends MockeryTestCase
{
private const TRACE_ID = 'e4a8d4e0d75c0702200af2882cb16c6b';
private const SPAN_ID = '46701247e52c2d1b';
private const SPAN_NAME = 'test_span';
private const NEW_SPAN_NAME = 'new_test_span';
private const START_EPOCH = 1000123789654;
Expand Down Expand Up @@ -655,6 +657,7 @@ public function test_attribute_length(): void
public function test_dropping_attributes(): void
{
$maxNumberOfAttributes = 8;
$this->expectDropped(8, 0, 0);
$span = $this->createTestSpan(API\SpanKind::KIND_INTERNAL, (new SpanLimitsBuilder())->setAttributeCountLimit($maxNumberOfAttributes)->build());

foreach (range(1, $maxNumberOfAttributes * 2) as $idx) {
Expand All @@ -676,6 +679,7 @@ public function test_dropping_attributes(): void
public function test_dropping_attributes_provided_via_span_builder(): void
{
$maxNumberOfAttributes = 8;
$this->expectDropped(8, 0, 0);

$attributesBuilder = Attributes::factory()->builder();

Expand Down Expand Up @@ -704,6 +708,7 @@ public function test_dropping_attributes_provided_via_span_builder(): void

public function test_dropping_events(): void
{
$this->expectDropped(0, 8, 0);
$maxNumberOfEvents = 8;
$span = $this->createTestSpan(API\SpanKind::KIND_INTERNAL, (new SpanLimitsBuilder())->setEventCountLimit($maxNumberOfEvents)->build());

Expand All @@ -719,6 +724,26 @@ public function test_dropping_events(): void
$span->end();
}

public function test_dropping_links(): void
{
$maxNumberOfLinks = 8;
$expectedDroppedLinks = 9; //test span contains one link by default
$this->expectDropped(0, 0, $expectedDroppedLinks);
$span = $this->createTestSpan(API\SpanKind::KIND_INTERNAL, (new SpanLimitsBuilder())->setLinkCountLimit($maxNumberOfLinks)->build());
$ctx = SpanContext::create(self::TRACE_ID, self::SPAN_ID);

foreach (range(1, $maxNumberOfLinks * 2) as $_idx) {
$span->addLink($ctx);
$this->testClock->advanceSeconds();
}

$spanData = $span->toSpanData();
$this->assertCount($maxNumberOfLinks, $spanData->getLinks());
$this->assertSame($expectedDroppedLinks, $spanData->getTotalDroppedLinks());

$span->end();
}

// endregion SDK
#[Group('trace-compliance')]
public function test_set_attributes_merges_attributes(): void
Expand Down Expand Up @@ -915,4 +940,18 @@ private function assertSpanData(
$this->assertSame($hasEnded, $spanData->hasEnded());
$this->assertEquals($attributes, $spanData->getAttributes());
}

private function expectDropped(int $attributes, int $events, int $links): void
{
$this->logWriter->expects($this->once())->method('write')->with(
$this->anything(),
$this->stringContains('Dropped span attributes'),
$this->equalTo([
'attributes' => $attributes,
'links' => $links,
'events' => $events,
'source' => 'OpenTelemetry\\SDK\\Trace\\Span',
])
);
}
}
Loading