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

Add AsyncReporter for trace which relies on the batch runner #548

Merged
merged 1 commit into from
Jun 26, 2017
Merged
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
166 changes: 166 additions & 0 deletions src/Trace/Reporter/AsyncReporter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<?php
/**
* Copyright 2017 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

namespace Google\Cloud\Trace\Reporter;

use Google\Cloud\Core\Batch\BatchRunner;
use Google\Cloud\Core\Exception\ServiceException;
use Google\Cloud\Trace\TraceClient;
use Google\Cloud\Trace\Tracer\TracerInterface;

/**
* This implementation of the ReporterInterface use the BatchRunner to provide
* asynchronous reporting of Traces and their TraceSpans.
*/
class AsyncReporter implements ReporterInterface
{
const BATCH_RUNNER_JOB_NAME = 'stackdriver-trace';

/**
* @var TraceClient
*/
protected static $client;

/**
* @var array
*/
private $clientConfig;

/**
* @var BatchRunner
*/
private $batchRunner;

/**
* @var bool
*/
private $debugOutput;

/**
* Create a TraceReporter that uses the provided TraceClient to report.
*
* @param array $options [optional] {
* Configuration options.
*
* @type bool $debugOutput Whether or not to output debug information.
* **Defaults to** false
* @type array $batchOptions An option to BatchJob.
* {@see \Google\Cloud\Core\Batch\BatchJob::__construct()}
* **Defaults to** ['batchSize' => 1000,
* 'callPeriod' => 2.0,
* 'workerNum' => 2]
* @type array $clientConfig A config to LoggingClient
* {@see \Google\Cloud\Logging\LoggingClient::__construct()}
* **Defaults to** []
* @type BatchRunner $batchRunner A BatchRunner object. Mainly used for
* the tests to inject a mock. **Defaults to** a newly created
* BatchRunner.
* }
*/
public function __construct(array $options = [])
{
$this->debugOutput = array_key_exists('debugOutput', $options)
? $options['debugOutput']
: false;
$this->clientConfig = array_key_exists('clientConfig', $options)
? $options['clientConfig']
: [];
$batchOptions = array_key_exists('batchOptions', $options)
? $options['batchOptions']
: [];
$this->batchOptions = $batchOptions + [
'batchSize' => 1000,
'callPeriod' => 2.0,
'workerNum' => 2
];

$this->batchRunner = array_key_exists('batchRunner', $options)
? $options['batchRunner']
: new BatchRunner();
$this->batchRunner->registerJob(
self::BATCH_RUNNER_JOB_NAME,
[$this, 'sendEntries'],
$this->batchOptions
);
}

/**
* Report the provided Trace to a backend.
*
* @param TracerInterface $tracer
* @return bool
*/
public function report(TracerInterface $tracer)
{
$spans = $tracer->spans();
if (empty($spans)) {
return false;
}

$entry = [
'traceId' => $tracer->context()->traceId(),
'spans' => $spans
];
try {
return $this->batchRunner->submitItem(self::BATCH_RUNNER_JOB_NAME, $entry);
} catch (\Exception $e) {
return false;
}
}

/**
* BatchRunner callback handler for reporting serialied traces
*
* @param array $entries An array of traces to send.
* @return bool
*/
public function sendEntries(array $entries)
{
$start = microtime(true);
$client = $this->getClient();
$traces = array_map(function ($entry) use ($client) {
$trace = $client->trace($entry['traceId']);
$trace->setSpans($entry['spans']);
return $trace;
}, $entries);

try {
$client->insertBatch($traces);
} catch (ServiceException $e) {
fwrite(STDERR, $e->getMessage() . PHP_EOL);
return false;
}
$end = microtime(true);
if ($this->debugOutput) {
printf(
'%f seconds for insertBatch %d entries' . PHP_EOL,
$end - $start,
count($entries)
);
printf('memory used: %d' . PHP_EOL, memory_get_usage());
}
return true;
}

protected function getClient()
{
if (!isset(self::$client)) {
self::$client = new TraceClient($this->clientConfig);
}
return self::$client;
}
}
127 changes: 127 additions & 0 deletions tests/unit/Trace/Reporter/AsyncReporterTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<?php
/**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

namespace Google\Cloud\Tests\Unit\Trace\Reporter;

use Google\Cloud\Core\Batch\BatchRunner;
use Google\Cloud\Trace\Reporter\AsyncReporter;
use Google\Cloud\Trace\TraceClient;
use Google\Cloud\Trace\TraceContext;
use Google\Cloud\Trace\TraceSpan;
use Google\Cloud\Trace\Trace;
use Google\Cloud\Trace\Tracer\TracerInterface;
use Prophecy\Argument;

/**
* @group trace
*/
class AsyncReporterTest extends \PHPUnit_Framework_TestCase
{
private $runner;
private $tracer;

public function setUp()
{
$this->runner = $this->prophesize(BatchRunner::class);
$this->tracer = $this->prophesize(TracerInterface::class);

$this->runner->registerJob(
Argument::type('string'),
Argument::type('array'),
Argument::type('array')
)->willReturn(true);
}

public function testReportsTrace()
{
$spans = [
new TraceSpan([
'name' => 'span',
'startTime' => microtime(true),
'endTime' => microtime(true) + 10
])
];
$this->tracer->context()->willReturn(new TraceContext('testtraceid'));
$this->tracer->spans()->willReturn($spans);

$this->runner->submitItem(Argument::type('string'), Argument::type('array'))
->willReturn(true);

$reporter = new AsyncReporter([
'batchRunner' => $this->runner->reveal()
]);
$this->assertTrue($reporter->report($this->tracer->reveal()));
}

public function testSkipsReportingWhenNoSpans()
{
$this->tracer->spans()->willReturn([]);

$reporter = new AsyncReporter([
'batchRunner' => $this->runner->reveal()
]);
$this->assertFalse($reporter->report($this->tracer->reveal()));
}

public function testCallback()
{
$client = $this->prophesize(TraceClient::class);
$reporter = new TestAsyncReporter([
'batchRunner' => $this->runner->reveal()
]);
$trace1 = $this->prophesize(Trace::class);
$trace2 = $this->prophesize(Trace::class);
$trace1->setSpans(Argument::any())->shouldBeCalled();
$trace2->setSpans(Argument::any())->shouldBeCalled();

$client->insertBatch([$trace1, $trace2])->willReturn(true);
$client->trace('trace1')->willReturn($trace1)->shouldBeCalled();
$client->trace('trace2')->willReturn($trace2)->shouldBeCalled();

$reporter->setClient($client->reveal());
$entries = [
[
'traceId' => 'trace1',
'spans' => [[
'name' => 'main',
'spanId' => '012345',
'startTime' => '2017-03-28T21:44:10.484299000Z',
'endTime' => '2017-03-28T21:44:10.625299000Z'
]]
],
[
'traceId' => 'trace2',
'spans' => [[
'name' => 'main',
'spanId' => '234567',
'startTime' => '2017-03-28T21:44:10.484299000Z',
'endTime' => '2017-03-28T21:44:10.625299000Z'
]]
]
];

$reporter->sendEntries($entries);
}
}

class TestAsyncReporter extends AsyncReporter
{
public function setClient($client)
{
self::$client = $client;
}
}