Skip to content

Commit 4b6b423

Browse files
HypeMCHypeMC
committed
Add ability to specify custom Sentry hub service
1 parent 20611cc commit 4b6b423

File tree

4 files changed

+86
-27
lines changed

4 files changed

+86
-27
lines changed

‎DependencyInjection/Configuration.php‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,9 @@
212212
* - [auto_log_stacks]: bool, defaults to false
213213
* - [environment]: string, default to null (no env specified)
214214
*
215+
* - sentry:
216+
* - hub_id: Sentry hub custom service id (optional)
217+
*
215218
* - newrelic:
216219
* - [level]: level name or int value, defaults to DEBUG
217220
* - [bubble]: bool, defaults to true
@@ -639,6 +642,7 @@ public function getConfigTreeBuilder()
639642
->scalarNode('connection_timeout')->end() // socket_handler, logentries, pushover, hipchat & slack
640643
->booleanNode('persistent')->end() // socket_handler
641644
->scalarNode('dsn')->end() // raven_handler, sentry_handler
645+
->scalarNode('hub_id')->defaultNull()->end() // sentry_handler
642646
->scalarNode('client_id')->defaultNull()->end() // raven_handler, sentry_handler
643647
->scalarNode('auto_log_stacks')->defaultFalse()->end() // raven_handler
644648
->scalarNode('release')->defaultNull()->end() // raven_handler, sentry_handler
@@ -860,9 +864,13 @@ public function getConfigTreeBuilder()
860864
->thenInvalid('The DSN has to be specified to use a RavenHandler')
861865
->end()
862866
->validate()
863-
->ifTrue(function ($v) { return 'sentry' === $v['type'] && !array_key_exists('dsn', $v) && null === $v['client_id']; })
867+
->ifTrue(function ($v) { return 'sentry' === $v['type'] && !array_key_exists('dsn', $v) && null === $v['hub_id'] && null === $v['client_id']; })
864868
->thenInvalid('The DSN has to be specified to use Sentry\'s handler')
865869
->end()
870+
->validate()
871+
->ifTrue(function ($v) { return 'sentry' === $v['type'] && null !== $v['hub_id'] && null !== $v['client_id']; })
872+
->thenInvalid('You can not use both a hub_id and a client_id in a Sentry handler')
873+
->end()
866874
->validate()
867875
->ifTrue(function ($v) { return 'hipchat' === $v['type'] && (empty($v['token']) || empty($v['room'])); })
868876
->thenInvalid('The token and room have to be specified to use a HipChatHandler')

‎DependencyInjection/MonologExtension.php‎

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -724,42 +724,46 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
724724
break;
725725

726726
case 'sentry':
727-
if (null !== $handler['client_id']) {
728-
$clientId = $handler['client_id'];
727+
if (null !== $handler['hub_id']) {
728+
$hub = new Reference($handler['hub_id']);
729729
} else {
730-
$options = new Definition(
731-
'Sentry\\Options',
732-
[['dsn' => $handler['dsn']]]
733-
);
730+
if (null !== $handler['client_id']) {
731+
$clientId = $handler['client_id'];
732+
} else {
733+
$options = new Definition(
734+
'Sentry\\Options',
735+
[['dsn' => $handler['dsn']]]
736+
);
734737

735-
if (!empty($handler['environment'])) {
736-
$options->addMethodCall('setEnvironment', [$handler['environment']]);
737-
}
738+
if (!empty($handler['environment'])) {
739+
$options->addMethodCall('setEnvironment', [$handler['environment']]);
740+
}
738741

739-
if (!empty($handler['release'])) {
740-
$options->addMethodCall('setRelease', [$handler['release']]);
741-
}
742+
if (!empty($handler['release'])) {
743+
$options->addMethodCall('setRelease', [$handler['release']]);
744+
}
742745

743-
$builder = new Definition('Sentry\\ClientBuilder', [$options]);
746+
$builder = new Definition('Sentry\\ClientBuilder', [$options]);
744747

745-
$client = new Definition('Sentry\\Client');
746-
$client->setFactory([$builder, 'getClient']);
748+
$client = new Definition('Sentry\\Client');
749+
$client->setFactory([$builder, 'getClient']);
747750

748-
$clientId = 'monolog.sentry.client.'.sha1($handler['dsn']);
749-
$container->setDefinition($clientId, $client);
751+
$clientId = 'monolog.sentry.client.'.sha1($handler['dsn']);
752+
$container->setDefinition($clientId, $client);
750753

751-
if (!$container->hasAlias('Sentry\\ClientInterface')) {
752-
$container->setAlias('Sentry\\ClientInterface', $clientId);
754+
if (!$container->hasAlias('Sentry\\ClientInterface')) {
755+
$container->setAlias('Sentry\\ClientInterface', $clientId);
756+
}
753757
}
754-
}
755758

756-
$hub = new Definition(
757-
'Sentry\\State\\Hub',
758-
[new Reference($clientId)]
759-
);
759+
$hub = new Definition(
760+
'Sentry\\State\\Hub',
761+
[new Reference($clientId)]
762+
);
760763

761-
// can't set the hub to the current hub, getting into a recursion otherwise...
762-
//$hub->addMethodCall('setCurrent', array($hub));
764+
// can't set the hub to the current hub, getting into a recursion otherwise...
765+
//$hub->addMethodCall('setCurrent', array($hub));
766+
}
763767

764768
$definition->setArguments([
765769
$hub,

‎Resources/config/schema/monolog-1.0.xsd‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
<xsd:attribute name="connection-timeout" type="xsd:string" />
6868
<xsd:attribute name="persistent" type="xsd:boolean" />
6969
<xsd:attribute name="dsn" type="xsd:string" />
70+
<xsd:attribute name="hub-id" type="xsd:string" />
7071
<xsd:attribute name="client-id" type="xsd:string" />
7172
<xsd:attribute name="use-ssl" type="xsd:boolean" />
7273
<xsd:attribute name="formatter" type="xsd:string" />

‎Tests/DependencyInjection/MonologExtensionTest.php‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,52 @@ public function testSentryHandlerWhenAClientIsSpecified()
456456
$this->assertDICConstructorArguments($handler->getArguments()[0], [new Reference('sentry.client')]);
457457
}
458458

459+
public function testSentryHandlerWhenAHubIsSpecified()
460+
{
461+
$container = $this->getContainer(
462+
[
463+
[
464+
'handlers' => [
465+
'sentry' => [
466+
'type' => 'sentry',
467+
'hub_id' => 'sentry.hub',
468+
],
469+
],
470+
],
471+
],
472+
[
473+
'sentry.hub' => new Definition(\Sentry\State\HubInterface::class),
474+
]
475+
);
476+
477+
$logger = $container->getDefinition('monolog.logger');
478+
$this->assertDICDefinitionMethodCallAt(0, $logger, 'useMicrosecondTimestamps', ['%monolog.use_microseconds%']);
479+
$this->assertDICDefinitionMethodCallAt(1, $logger, 'pushHandler', [new Reference('monolog.handler.sentry')]);
480+
481+
$handler = $container->getDefinition('monolog.handler.sentry');
482+
$this->assertDICConstructorArguments($handler, [new Reference('sentry.hub'), \Monolog\Logger::DEBUG, true]);
483+
}
484+
485+
public function testSentryHandlerWhenAHubAndAClientAreSpecified()
486+
{
487+
$this->expectException(InvalidConfigurationException::class);
488+
$this->expectExceptionMessage('You can not use both a hub_id and a client_id in a Sentry handler');
489+
490+
$this->getContainer(
491+
[
492+
[
493+
'handlers' => [
494+
'sentry' => [
495+
'type' => 'sentry',
496+
'hub_id' => 'sentry.hub',
497+
'client_id' => 'sentry.client',
498+
],
499+
],
500+
],
501+
]
502+
);
503+
}
504+
459505
public function testLogglyHandler()
460506
{
461507
$token = '026308d8-2b63-4225-8fe9-e01294b6e472';

0 commit comments

Comments
 (0)