Skip to content

Commit e143d41

Browse files
danielmorelldanielmorell
authored
Merge pull request #160 from rollbar/added/telemetry
Added telemetry support
2 parents 5901c58 + fd6d17d commit e143d41

8 files changed

+542
-68
lines changed

‎.github/workflows/ci.yml

+6
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ jobs:
5151
php-version: ${{ matrix.php }}
5252
extensions: curl
5353

54+
- name: Install dependencies
55+
run: composer update --prefer-dist --no-interaction
56+
57+
- name: Execute Rollbar tests
58+
run: composer test
59+
5460
- name: Create Laravel test app
5561
run: composer create-project laravel/laravel rollbar-test-app ${{ matrix.laravel }}
5662

‎composer.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"require": {
2525
"php": "^8.1",
2626
"illuminate/support": "^10.0|^11.0",
27-
"rollbar/rollbar": "^4.0"
27+
"rollbar/rollbar": "v4.1.0-rc"
2828
},
2929
"require-dev": {
3030
"orchestra/testbench": "^8.0",
@@ -38,6 +38,11 @@
3838
"Rollbar\\Laravel\\": "src/"
3939
}
4040
},
41+
"autoload-dev": {
42+
"psr-4": {
43+
"Rollbar\\Laravel\\Tests\\": "tests/"
44+
}
45+
},
4146
"extra": {
4247
"laravel": {
4348
"providers": [

‎phpunit.xml

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<phpunit backupGlobals="false"
2+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
backupGlobals="false"
34
backupStaticAttributes="false"
45
bootstrap="tests/bootstrap.php"
56
colors="true"
@@ -8,15 +9,15 @@
89
convertWarningsToExceptions="true"
910
processIsolation="false"
1011
stopOnFailure="true"
11-
>
12+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
13+
<coverage processUncoveredFiles="true">
14+
<include>
15+
<directory suffix=".php">./src</directory>
16+
</include>
17+
</coverage>
1218
<testsuites>
1319
<testsuite name="Test Suite">
1420
<directory suffix=".php">./tests/</directory>
1521
</testsuite>
1622
</testsuites>
17-
<filter>
18-
<whitelist processUncoveredFilesFromWhitelist="true">
19-
<directory suffix=".php">./src</directory>
20-
</whitelist>
21-
</filter>
2223
</phpunit>

‎src/RollbarServiceProvider.php

+93-33
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<?php namespace Rollbar\Laravel;
22

3+
use Illuminate\Contracts\Container\BindingResolutionException;
4+
use Illuminate\Contracts\Events\Dispatcher;
35
use Rollbar\Rollbar;
46
use Rollbar\RollbarLogger;
57
use Illuminate\Support\Arr;
@@ -10,6 +12,11 @@
1012

1113
class RollbarServiceProvider extends ServiceProvider
1214
{
15+
/**
16+
* The telemetry event listener.
17+
*/
18+
protected TelemetryListener $telemetryListener;
19+
1320
/**
1421
* Register the service provider.
1522
*/
@@ -21,35 +28,11 @@ public function register(): void
2128
}
2229

2330
$this->app->singleton(RollbarLogger::class, function (Application $app) {
31+
$config = $this->getConfigs($app);
2432

25-
$defaults = [
26-
'environment' => $app->environment(),
27-
'root' => base_path(),
28-
'handle_exception' => true,
29-
'handle_error' => true,
30-
'handle_fatal' => true,
31-
];
32-
33-
$config = array_merge($defaults, $app['config']->get('logging.channels.rollbar', []));
34-
35-
$config['access_token'] = static::config('access_token');
36-
37-
if (empty($config['access_token'])) {
38-
throw new InvalidArgumentException('Rollbar access token not configured');
39-
}
40-
41-
$handleException = (bool) Arr::pull($config, 'handle_exception');
42-
$handleError = (bool) Arr::pull($config, 'handle_error');
43-
$handleFatal = (bool) Arr::pull($config, 'handle_fatal');
44-
45-
// Convert a request for the Rollbar agent to handle the logs to
46-
// the format expected by `Rollbar::init`.
47-
// @see https://github.com/rollbar/rollbar-php-laravel/issues/85
48-
$handler = Arr::get($config, 'handler');
49-
if ($handler === AgentHandler::class) {
50-
$config['handler'] = 'agent';
51-
}
52-
$config['framework'] = 'laravel ' . app()->version();
33+
$handleException = (bool)Arr::pull($config, 'handle_exception');
34+
$handleError = (bool)Arr::pull($config, 'handle_error');
35+
$handleFatal = (bool)Arr::pull($config, 'handle_fatal');
5336
Rollbar::init($config, $handleException, $handleError, $handleFatal);
5437

5538
return Rollbar::logger();
@@ -58,20 +41,39 @@ public function register(): void
5841
$this->app->singleton(MonologHandler::class, function (Application $app) {
5942

6043
$level = static::config('level', 'debug');
61-
44+
6245
$handler = new MonologHandler($app[RollbarLogger::class], $level);
6346
$handler->setApp($app);
6447

6548
return $handler;
6649
});
6750
}
6851

52+
/**
53+
* Boot is called after all services are registered.
54+
*
55+
* This is where we can start listening for events.
56+
*
57+
* @param RollbarLogger $logger This parameter is injected by the service container, and is required to ensure that
58+
* the Rollbar logger is initialized.
59+
* @return void
60+
*
61+
* @since 8.1.0
62+
*/
63+
public function boot(RollbarLogger $logger): void
64+
{
65+
// Set up telemetry if it is enabled.
66+
if (null !== Rollbar::getTelemeter()) {
67+
$this->setupTelemetry($this->getConfigs($this->app));
68+
}
69+
}
70+
6971
/**
7072
* Check if we should prevent the service from registering.
7173
*
7274
* @return boolean
7375
*/
74-
public function stop() : bool
76+
public function stop(): bool
7577
{
7678
$level = static::config('level');
7779

@@ -85,8 +87,8 @@ public function stop() : bool
8587
/**
8688
* Return a rollbar logging config.
8789
*
88-
* @param string $key The config key to lookup.
89-
* @param mixed $default The default value to return if the config is not found.
90+
* @param string $key The config key to lookup.
91+
* @param mixed $default The default value to return if the config is not found.
9092
*
9193
* @return mixed
9294
*/
@@ -98,8 +100,66 @@ protected static function config(string $key = '', mixed $default = null): mixed
98100
$envKey = 'ROLLBAR_TOKEN';
99101
}
100102

101-
$logKey = empty($key) ? 'logging.channels.rollbar' : "logging.channels.rollbar.$key";
103+
$logKey = empty($key) ? 'logging.channels.rollbar' : 'logging.channels.rollbar.' . $key;
102104

103105
return getenv($envKey) ?: Config::get($logKey, $default);
104106
}
107+
108+
/**
109+
* Returns the Rollbar configuration.
110+
*
111+
* @param Application $app The Laravel application.
112+
* @return array
113+
*
114+
* @since 8.1.0
115+
*
116+
* @throw InvalidArgumentException If the Rollbar access token is not configured.
117+
*/
118+
public function getConfigs(Application $app): array
119+
{
120+
$defaults = [
121+
'environment' => $app->environment(),
122+
'root' => base_path(),
123+
'handle_exception' => true,
124+
'handle_error' => true,
125+
'handle_fatal' => true,
126+
];
127+
128+
$config = array_merge($defaults, $app['config']->get('logging.channels.rollbar', []));
129+
$config['access_token'] = static::config('access_token');
130+
131+
if (empty($config['access_token'])) {
132+
throw new InvalidArgumentException('Rollbar access token not configured');
133+
}
134+
// Convert a request for the Rollbar agent to handle the logs to
135+
// the format expected by `Rollbar::init`.
136+
// @see https://github.com/rollbar/rollbar-php-laravel/issues/85
137+
$handler = Arr::get($config, 'handler', MonologHandler::class);
138+
if ($handler === AgentHandler::class) {
139+
$config['handler'] = 'agent';
140+
}
141+
$config['framework'] = 'laravel ' . $app->version();
142+
return $config;
143+
}
144+
145+
/**
146+
* Sets up the telemetry event listeners.
147+
*
148+
* @param array $config
149+
* @return void
150+
*
151+
* @since 8.1.0
152+
*/
153+
protected function setupTelemetry(array $config): void
154+
{
155+
$this->telemetryListener = new TelemetryListener($this->app, $config);
156+
157+
try {
158+
$dispatcher = $this->app->make(Dispatcher::class);
159+
} catch (BindingResolutionException $e) {
160+
return;
161+
}
162+
163+
$this->telemetryListener->listen($dispatcher);
164+
}
105165
}

‎src/TelemetryListener.php

+151
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<?php
2+
3+
namespace Rollbar\Laravel;
4+
5+
use Exception;
6+
use Illuminate\Contracts\Container\Container;
7+
use Illuminate\Contracts\Events\Dispatcher;
8+
use Illuminate\Database\Events\QueryExecuted;
9+
use Illuminate\Log\Events\MessageLogged;
10+
use Illuminate\Routing\Events\RouteMatched;
11+
use Rollbar\Rollbar;
12+
use Rollbar\Telemetry\EventType;
13+
use Rollbar\Telemetry\EventLevel;
14+
use Rollbar\Telemetry\Telemeter;
15+
16+
/**
17+
* This class handles Laravel events and maps them to Rollbar telemetry events.
18+
*
19+
* @since 8.1.0
20+
*/
21+
class TelemetryListener
22+
{
23+
const BASE_EVENTS = [
24+
MessageLogged::class => 'logMessageHandler',
25+
RouteMatched::class => 'routeMatchedHandler',
26+
QueryExecuted::class => 'queryExecutedHandler',
27+
];
28+
29+
private Container $container;
30+
31+
private array $config;
32+
33+
/**
34+
* @var bool
35+
*/
36+
private bool $captureLogs;
37+
private bool $captureRouting;
38+
private bool $captureQueries;
39+
private bool $captureDbParameters;
40+
41+
/**
42+
* @param Container $container The Laravel application container.
43+
* @param array $config
44+
*/
45+
public function __construct(Container $container, array $config)
46+
{
47+
$this->container = $container;
48+
$this->config = $config;
49+
50+
$this->captureLogs = boolval($this->config['telemetry']['capture_logs'] ?? true);
51+
$this->captureRouting = boolval($this->config['telemetry']['capture_routing'] ?? true);
52+
$this->captureQueries = boolval($this->config['telemetry']['capture_db_queries'] ?? true);
53+
// We do not want to capture query parameters by default, the developer must explicitly enable it.
54+
$this->captureDbParameters = boolval($this->config['telemetry']['capture_db_query_parameters'] ?? false);
55+
}
56+
57+
/**
58+
* Register the event listeners for the application.
59+
*
60+
* @param Dispatcher $dispatcher
61+
* @return void
62+
*/
63+
public function listen(Dispatcher $dispatcher): void
64+
{
65+
foreach (self::BASE_EVENTS as $event => $handler) {
66+
$dispatcher->listen($event, [$this, $handler]);
67+
}
68+
}
69+
70+
/**
71+
* Execute the event handler.
72+
*
73+
* This is used so that the handlers are not public methods.
74+
*
75+
* @param string $method The method to call.
76+
* @param array $args The arguments to pass to the method.
77+
* @return void
78+
*/
79+
public function __call(string $method, array $args): void
80+
{
81+
if (!method_exists($this, $method)) {
82+
return;
83+
}
84+
85+
try {
86+
$this->{$method}(...$args);
87+
} catch (Exception $e) {
88+
// Do nothing.
89+
}
90+
}
91+
92+
/**
93+
* Handler for log messages.
94+
*
95+
* @param MessageLogged $message
96+
* @return void
97+
*/
98+
protected function logMessageHandler(MessageLogged $message): void
99+
{
100+
if (null === $message->message || !$this->captureLogs) {
101+
return;
102+
}
103+
104+
Rollbar::captureTelemetryEvent(
105+
EventType::Log,
106+
// Telemetry does not support all PSR-3 or RFC-5424 levels, so we need to convert them.
107+
Telemeter::getLevelFromPsrLevel($message->level),
108+
array_merge(
109+
$message->context,
110+
['message' => $message->message],
111+
),
112+
);
113+
}
114+
115+
protected function routeMatchedHandler(RouteMatched $matchedRoute): void
116+
{
117+
if (!$this->captureRouting) {
118+
return;
119+
}
120+
$routePath = $matchedRoute->route->uri();
121+
122+
Rollbar::captureTelemetryEvent(
123+
EventType::Manual,
124+
EventLevel::Info,
125+
[
126+
'message' => 'Route matched',
127+
'route' => $routePath,
128+
],
129+
);
130+
}
131+
132+
protected function queryExecutedHandler(QueryExecuted $query): void
133+
{
134+
if (!$this->captureQueries) {
135+
return;
136+
}
137+
138+
$meta = [
139+
'message' => 'Query executed',
140+
'query' => $query->sql,
141+
'time' => $query->time,
142+
'connection' => $query->connectionName,
143+
];
144+
145+
if ($this->captureDbParameters) {
146+
$meta['bindings'] = $query->bindings;
147+
}
148+
149+
Rollbar::captureTelemetryEvent(EventType::Manual, EventLevel::Info, $meta);
150+
}
151+
}

0 commit comments

Comments
 (0)