KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #deepseek-harness #open-source #macos #ai-agent

guzzle-debugbar

★ 76 Open GitHub ↗

A Guzzle middleware that lets you log HTTP requests in the PHP debugbar timeline.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [Guzzle](http://docs.guzzlephp.org/en/latest/) middleware to log requests to [PHP DebugBar](https://github.com/maximebf/php-debugbar)'s timeline

⚠️ This project is up for adoption. Get in touch if you're interested in actively maintaining 3 closely related packages.

[![Build Status](https://img.shields.io/travis/com/hannesvdvreken/guzzle-debugbar/4.x?style=flat-square)](https://app.travis-ci.com/github/hannesvdvreken/guzzle-debugbar/)
[![Latest Stable Version](https://img.shields.io/packagist/v/hannesvdvreken/guzzle-debugbar.svg?style=flat-square)](https://packagist.org/packages/hannesvdvreken/guzzle-debugbar)
[![Code Quality](https://img.shields.io/scrutinizer/g/hannesvdvreken/guzzle-debugbar.svg?style=flat-square)](https://scrutinizer-ci.com/g/hannesvdvreken/guzzle-debugbar/)
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/hannesvdvreken/guzzle-debugbar.svg?style=flat-square)](https://scrutinizer-ci.com/g/hannesvdvreken/guzzle-debugbar/)
[![Total Downloads](https://img.shields.io/packagist/dt/hannesvdvreken/guzzle-debugbar.svg?style=flat-square)](https://packagist.org/packages/hannesvdvreken/guzzle-debugbar)
[![License](https://img.shields.io/github/license/hannesvdvreken/guzzle-debugbar?style=flat-square)](https://raw.githubusercontent.com/hannesvdvreken/guzzle-debugbar/5.x/)

Guzzle middleware to log requests to DebugBar's timeline.

![Debugbar timeline](https://raw.githubusercontent.com/hannesvdvreken/guzzle-debugbar/5.x/images/debugbar-timeline.png)
![Debugbar logs](https://raw.githubusercontent.com/hannesvdvreken/guzzle-debugbar/5.x/images/debugbar-logs.png)

## Installation

```
composer require hannesvdvreken/guzzle-debugbar --dev
```

## Usage

Just six lines of code are needed to log your requests to DebugBar's timeline.

```php
$debugBar = new StandardDebugBar();
// or when using Laravel:
$debugBar = app('debugbar');

// Get data collector.
$timeline = $debugBar->getCollector('time');

// Wrap the timeline.
$profiler = new \GuzzleHttp\Profiling\Debugbar\Profiler($timeline);

// Add the middleware to the stack
$stack = \GuzzleHttp\HandlerStack::create();
$stack->unshift(new \GuzzleHttp\Profiling\Middleware($profiler));

// New up the client with this handler stack.
$client = new \GuzzleHttp\Client(['handler' => $stack]);
```

Now `$client` is ready to make requests. Every request is now logged to the timeline.

### Recommended: use Guzzle's Log middleware

```php
$debugBar = new StandardDebugBar();
// or when using Laravel:
$debugBar = app('debugbar');

// PSR-3 logger:
$logger = $debugBar->getCollector('messages');

// Create a new Log middleware.
$stack->push(\GuzzleHttp\Middleware::log($logger, new \GuzzleHttp\MessageFormatter()));

// New up the client with this handler stack.
$client = new \GuzzleHttp\Client(['handler' => $stack]);
```

## Support

### Laravel

It is recommended to have my friend Barry's [laravel-debugbar](https://github.com/barryvdh/laravel-debugbar) installed and configured. Make sure to include his and our service providers your app's `providers` array:

```php
'providers' => [
    ...
    Barryvdh\Debugbar\ServiceProvider::class,
    GuzzleHttp\Profiling\Debugbar\Support\Laravel\ServiceProvider::class,
],
```

If you want to use a different `DebugBar\DebugBar` instance, create a ServiceProvider that binds an
instance with the key `debugbar`. For example with this register method:

```php
public function register()
{
    $this->app->singleton('debugbar', function () {
        return new \DebugBar\StandardDebugBar();
    });
}
```

Be sure to create every client (type hint with `GuzzleHttp\ClientInterface` or `GuzzleHttp\Client`) via the IoC container.

### FAQ:

I get one of these errors:

`'time' is not a registered collector`
`'exceptions' is not a registered collector`

It means you disabled the `time` collector and/or the `exceptions` collector in your `packages/barryvdh/laravel-debugbar/config.php`. These are enabled by default. This package depends on it, so please enable them both.

## Contributing

Feel free to make a pull request. Please try to be as
[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
compliant as possible. Fix Code Style quickly by running `vendor/bin/php-cs-fixer fix`. Give a good description of what is supposed to be added/changed/removed/fixed.

### Testing

To test your code before pushing, run the unit test suite.

```bash
vendor/bin/phpunit
```

## License

[MIT](LICENSE)

guzzle-debugbar

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README