Skip to content

allow set max number of logs to collect #11

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
6 changes: 5 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
on: [push, pull_request]
on:
push:
branches:
- main
pull_request:

name: Lint

15 changes: 11 additions & 4 deletions examples/slim/index.php
Original file line number Diff line number Diff line change
@@ -20,17 +20,24 @@
$traceableLogger = new LoggerTraceable($log);

SlimPhpWebProfilerBuilder::fromApp($app)
->withBufferSizeInMb(1)
->withPdo($pdoTraceable)
->withLogger($traceableLogger)
->build();

$app->get('/', function (Request $request, Response $response) use ($traceableLogger, $pdoTraceable) {
$response->getBody()->write('Hello world!');

$traceableLogger->error('This is an error message');
ini_set('memory_limit', '2048M');
$response->getBody()->write(ini_get('memory_limit'));

$pdoTraceable->exec('INSERT INTO test (title) VALUES ("test");');
$pdoTraceable->exec('SELECT * FROM test;');

foreach (range(0, 10000) as $item) {
$pdoTraceable->exec('SELECT * FROM test WHERE title="test" limit 1 OFFSET 0;');
$traceableLogger->error('This is an error message');
$traceableLogger->info('This is an error message');
$traceableLogger->warning('This is an error message');
$traceableLogger->error('This is an error message');
}

return $response;
});
17 changes: 17 additions & 0 deletions src/Bridge/Slim/SlimPhpWebProfilerBuilder.php
Original file line number Diff line number Diff line change
@@ -18,13 +18,15 @@
use WebProfiler\PhpWebProfilerBuilder;
use WebProfiler\Traceables\LoggerTraceable;
use WebProfiler\Traceables\RequestTraceable;
use WebProfiler\Traits\BufferSize;

final class SlimPhpWebProfilerBuilder implements PhpWebProfilerBuilder
{
private ?RequestTraceable $requestTraceable = null;
private ?LoggerTraceable $logger = null;
private ?PdoTraceableInterface $pdo = null;
private ?StorageInterface $storage = null;
private int $bufferSizeInBytes = 6144;

private function __construct(
private App $app,
@@ -44,6 +46,10 @@ public function withPdo(PdoTraceableInterface $pdo): self
{
$this->pdo = $pdo;

if (in_array(BufferSize::class, class_uses($pdo), true)) {
$pdo->setBufferSize($this->bufferSizeInBytes);
}

return $this;
}

@@ -58,6 +64,10 @@ public function withLogger(LoggerTraceable $logger): self
{
$this->logger = $logger;

if (in_array(BufferSize::class, class_uses($logger), true)) {
$logger->setBufferSize($this->bufferSizeInBytes);
}

return $this;
}

@@ -68,6 +78,13 @@ public function withStorage(StorageInterface $storage): self
return $this;
}

public function withBufferSizeInMb(int $bufferSizeInMb): self
{
$this->bufferSizeInBytes = $bufferSizeInMb * (1024 * 1024);

return $this;
}

public function build(): PhpWebProfiler
{
$this->setStorage();
9 changes: 8 additions & 1 deletion src/Traceables/LoggerTraceable.php
Original file line number Diff line number Diff line change
@@ -6,9 +6,12 @@

use Psr\Log\LoggerInterface;
use WebProfiler\Contracts\LoggerTraceableInterface;
use WebProfiler\Traits\BufferSize;

final class LoggerTraceable implements LoggerInterface, LoggerTraceableInterface
{
use BufferSize;

private array $logs = [];

public function __construct(private LoggerInterface $logger)
@@ -20,8 +23,12 @@ public function logs(): array
return $this->logs;
}

public function addLog(string $message, string $type, array $context = [])
public function addLog(string $message, string $type, array $context = []): void
{
if ($this->isBufferSizeExceeded()) {
return;
}

$this->logs[] = [
$type,
$message,
7 changes: 7 additions & 0 deletions src/Traceables/PdoTraceable.php
Original file line number Diff line number Diff line change
@@ -5,9 +5,12 @@
namespace WebProfiler\Traceables;

use WebProfiler\Contracts\PdoTraceableInterface;
use WebProfiler\Traits\BufferSize;

final class PdoTraceable extends \PDO implements PdoTraceableInterface
{
use BufferSize;

private array $statements = [];

public function exec(string $statement)
@@ -19,6 +22,10 @@ public function exec(string $statement)

$duration = microtime(true) - $timeStart;

if ($this->isBufferSizeExceeded()) {
return;
}

$this->addStatement([
'time' => $time,
'duration' => $duration,
20 changes: 20 additions & 0 deletions src/Traits/BufferSize.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

declare(strict_types=1);

namespace WebProfiler\Traits;

trait BufferSize
{
private ?int $bufferSize = null;

public function isBufferSizeExceeded(): bool
{
return $this->bufferSize < memory_get_usage();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

diría que aquí se están justando 2 conceptos. Por un lado el uso de memoria de la aplicación y por otro el uso de memoria de los traceables.

La comparación no creo que debería ser con memory_get_usage si no con el tamaño que internamente tenga guardado el traceable.

Esto último haría que cada traceable tuviera su propio buffer, que quizá individualmente no llegan al máximo pero en conjunto sí.

Por eso creo que la solución buena sería más bien una clase por encima que vaya haciendo la gestión de las trazas que se guaran en memoria. Al tener todas podría saber el tamaño real que está consumiendo todo lo relacionado con logs (y sin depender de memory_get_usage y por tanto del resto de uso que está teniendo la aplicación).

El tener una clase por encima además permitiría guardar las trazas de otra manera que no fuera en memoria o incluso cuando llegue al límite en vez de dejar de logear enviar al Storage lo que tenga actualmente.

A su vez esto podría provocar que durante la ejecución funcionara bien pero a la hora de leer el json del storage fuera mal por límite máximo de memoria. Aquí la solución sería establecer un límite máximo de logs (en vez de de buffer, porque se va a ir volcando) o directamente mejorar el parseo del json para que quepa en memoria (quizá esto tiene demasiadas implicaciones y sería para otra versión).

Esto sería un cambio más grande de infraestructura de la librería.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

}

public function setBufferSize(int $bufferSize): void
{
$this->bufferSize = $bufferSize;
}
}