Skip to content

Defer rare telemetry instrument creation #4

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.

Sign up for GitHub

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

Merged
ChiragAgg5k merged 1 commit into from
May 29, 2026
Merged

Defer rare telemetry instrument creation #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"phpunit/phpunit": "^10.0",
"phpstan/phpstan": "^2.1",
"laravel/pint": "^1.29",
"utopia-php/telemetry": "0.2.*"
"utopia-php/telemetry": "^0.4"
},
"suggest": {
"utopia-php/telemetry": "Required when passing telemetry adapters or running the local telemetry demo.",
Expand Down
9 changes: 5 additions & 4 deletions src/CircuitBreaker/CircuitBreaker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,15 @@ public function __construct(
public function setTelemetry(Telemetry $telemetry): void
{
$this->calls = $telemetry->createCounter($this->metricName('breaker.calls'), '{call}');
$this->callbackFailures = $telemetry->createCounter($this->metricName('breaker.callback_failures'), '{failure}');
$this->fallbacks = $telemetry->createCounter($this->metricName('breaker.fallbacks'), '{fallback}');
$this->transitions = $telemetry->createCounter($this->metricName('breaker.transitions'), '{transition}');
$this->activeCalls = $telemetry->createUpDownCounter($this->metricName('breaker.active_calls'), '{call}');
$this->stateGauge = $telemetry->createGauge($this->metricName('breaker.state'));
$this->failuresGauge = $telemetry->createGauge($this->metricName('breaker.failures'), '{failure}');
$this->successesGauge = $telemetry->createGauge($this->metricName('breaker.successes'), '{success}');
$this->eventTimestamp = $telemetry->createGauge($this->metricName('breaker.event.timestamp'), 's');

$this->callbackFailures = Counter::lazy($telemetry, $this->metricName('breaker.callback_failures'), '{failure}');
$this->fallbacks = Counter::lazy($telemetry, $this->metricName('breaker.fallbacks'), '{fallback}');
$this->transitions = Counter::lazy($telemetry, $this->metricName('breaker.transitions'), '{transition}');
$this->eventTimestamp = Gauge::lazy($telemetry, $this->metricName('breaker.event.timestamp'), 's');
}

public function call(callable $open, callable $close, ?callable $halfOpen = null): mixed
Expand Down
39 changes: 39 additions & 0 deletions tests/unit/CircuitBreakerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,45 @@ public function testInspectionMethodsDoNotEmitTelemetry(): void
self::assertSame([], $telemetry->gauges['breaker.failures']->values);
self::assertSame([], $telemetry->gauges['breaker.successes']->values);
self::assertSame([], $telemetry->counters['breaker.calls']->values);
self::assertArrayNotHasKey('breaker.callback_failures', $telemetry->counters);
self::assertArrayNotHasKey('breaker.fallbacks', $telemetry->counters);
self::assertArrayNotHasKey('breaker.transitions', $telemetry->counters);
self::assertArrayNotHasKey('breaker.event.timestamp', $telemetry->gauges);
}

public function testRareTelemetryInstrumentsAreCreatedOnFirstRecord(): void
{
$telemetry = new TestTelemetry();
$breaker = new CircuitBreaker(telemetry: $telemetry);

self::assertArrayNotHasKey('breaker.callback_failures', $telemetry->counters);
self::assertArrayNotHasKey('breaker.fallbacks', $telemetry->counters);
self::assertArrayNotHasKey('breaker.transitions', $telemetry->counters);
self::assertArrayNotHasKey('breaker.event.timestamp', $telemetry->gauges);

$breaker->trip();

self::assertArrayNotHasKey('breaker.callback_failures', $telemetry->counters);
self::assertArrayNotHasKey('breaker.fallbacks', $telemetry->counters);
self::assertSame([1], $telemetry->counters['breaker.transitions']->values);
self::assertCount(1, $telemetry->gauges['breaker.event.timestamp']->values);
}

public function testSuccessfulCallsDoNotCreateRareTelemetryInstruments(): void
{
$telemetry = new TestTelemetry();
$breaker = new CircuitBreaker(telemetry: $telemetry);

self::assertSame('ok', $breaker->call(
open: static fn () => 'fallback',
close: static fn () => 'ok',
));

self::assertSame([1], $telemetry->counters['breaker.calls']->values);
self::assertArrayNotHasKey('breaker.callback_failures', $telemetry->counters);
self::assertArrayNotHasKey('breaker.fallbacks', $telemetry->counters);
self::assertArrayNotHasKey('breaker.transitions', $telemetry->counters);
self::assertArrayNotHasKey('breaker.event.timestamp', $telemetry->gauges);
}

public function testActiveCallTelemetryUsesPostUpdateState(): void
Expand Down
Loading