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

Loosen JaegerTracing constraint & Make bundle configurable #6

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
8 changes: 2 additions & 6 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
],
"require": {
"php": ">=7.1",
"jonahgeorge/jaeger-client-php": "0.4.0",
"jonahgeorge/jaeger-client-php": "~0.4",
"symfony/config": "~3.4|~4.0",
"symfony/console": "~3.4|~4.0",
"symfony/dependency-injection": "~3.4.6|~4.1",
"symfony/http-kernel": "~3.4|~4.1",
"symfony/serializer-pack": "^1.0"
},
"require-dev": {
"phpunit/phpunit": "^7.4@dev"
"phpunit/phpunit": "^7.4"
},
"autoload": {
"psr-4": {
Expand All @@ -34,9 +34,5 @@
"branch-alias": {
"dev-master": "1.0-dev"
}
},
"minimum-stability": "dev",
"require-dev": {
"phpunit/phpunit": "^7.4@dev"
}
}
52 changes: 52 additions & 0 deletions src/DependencyInjection/Configuration.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php declare(strict_types=1);

namespace Adtechpotok\Bundle\SymfonyOpenTracing\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{

/**
* Generates the configuration tree builder.
*
* @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
*/
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder('symfony_open_tracing');
/** @var ArrayNodeDefinition $rootNode */
$rootNode = $treeBuilder->getRootNode();

// Basic Sentry configuration
$rootNode
->children()
->scalarNode('service_name')->end()
->scalarNode('enabled')->defaultTrue()->end()
->arrayNode('tracer_config')
->children()
->arrayNode('sampler')
->children()
->scalarNode('type')->defaultValue('const')->end()
->scalarNode('param')->defaultTrue()->end()
->end()
->end()
->arrayNode('local_agent')
->children()
->scalarNode('reporting_host')->defaultNull()->end()
->scalarNode('reporting_port')->defaultNull()->end()
->end()
->end()
->scalarNode('logging')->defaultTrue()->end()
->scalarNode('trace_id_header')->defaultNull()->end()
->scalarNode('baggage_header_prefix')->defaultNull()->end()
->scalarNode('debug_id_header_key')->defaultNull()->end()
->end()
->end()
->end();

return $treeBuilder;
}
}
13 changes: 8 additions & 5 deletions src/DependencyInjection/SymfonyOpenTracingExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,20 @@
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;

class SymfonyOpenTracingExtension extends Extension
class SymfonyOpenTracingExtension extends ConfigurableExtension
{
/**
* {@inheritdoc}
* Configures the passed container according to the merged configuration.
*/
public function load(array $configs, ContainerBuilder $container)
protected function loadInternal(array $mergedConfig, ContainerBuilder $container)
{
$loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resource/config'));
$loader->load('services.yml');
$loader->load('parameters.yml');

$container->setParameter('symfony_open_tracing.service_name', $mergedConfig['service_name']);
$container->setParameter('symfony_open_tracing.enabled', $mergedConfig['enabled']);
$container->setParameter('symfony_open_tracing.tracer_config', $mergedConfig['tracer_config']);
}
}
6 changes: 5 additions & 1 deletion src/EventListener/HttpListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ public function onKernelRequest(GetResponseEvent $event): void
$tracer = $this->openTracing->getTracer();
$request = $event->getRequest();

$context = $tracer->extract(Formats\HTTP_HEADERS, $request->headers->all());
$headers = [];
foreach ($request->headers->all() as $key => $values) {
$headers[$key] = is_array($values) ? $values[0] : $values;
}
$context = $tracer->extract(Formats\HTTP_HEADERS, $headers);

if ($context) {
$tracer->startActiveSpan($this->nameGetter->getNameByRequest($request), ['child_of' => $context]);
Expand Down
10 changes: 0 additions & 10 deletions src/Resource/config/parameters.yml

This file was deleted.

5 changes: 3 additions & 2 deletions src/Resource/config/services.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ services:
open_tracing.tracer:
class: Adtechpotok\Bundle\SymfonyOpenTracing\Service\OpenTracingService
arguments:
- '%open_tracing.tracer.service_name%'
- '%open_tracing.tracer.config%'
- '%symfony_open_tracing.enabled%'
- '%symfony_open_tracing.service_name%'
- '%symfony_open_tracing.tracer_config%'

open_tracing.name_getter:
class: Adtechpotok\Bundle\SymfonyOpenTracing\Service\RootSpanNameBuilder
Expand Down
4 changes: 2 additions & 2 deletions src/Service/OpenTracingService.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ class OpenTracingService
* @param string $appName
* @param array $config
*/
public function __construct(string $appName, array $config)
public function __construct(bool $enabled, string $appName, array $config)
{
if (isset($config['null_tracer']) && $config['null_tracer']) {
if (!$enabled) {
$this->tracer = new NoopTracer();
} else {
(new Config($config, $appName))->initializeTracer();
Expand Down