[HttpClient] Added TraceableHttpClient and WebProfiler panel #30494
[HttpClient] Added TraceableHttpClient and WebProfiler panel
- Loading branch information
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| {% extends '@WebProfiler/Profiler/layout.html.twig' %} | ||
|
|
||
| {% block toolbar %} | ||
| {% if collector.requestCount %} | ||
| {% set icon %} | ||
| {{ include('@WebProfiler/Icon/http-client.svg') }} | ||
| {% set status_color = '' %} | ||
| <span class="sf-toolbar- 6D47 value">{{ collector.requestCount }}</span> | ||
| {% endset %} | ||
|
|
||
| {{ include('@WebProfiler/Profiler/toolbar_item.html.twig', { link: profiler_url, status: status_color }) }} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block menu %} | ||
| <span class="label {{ collector.requestCount == 0 ? 'disabled' }}"> | ||
| <span class="icon">{{ include('@WebProfiler/Icon/http-client.svg') }}</span> | ||
| <strong>HTTP Client</strong> | ||
| {% if collector.requestCount %} | ||
| <span class="count"> | ||
|
There was a problem hiding this comment. I think we should add colors for warning and error codes here. |
||
| {{ collector.requestCount }} | ||
| </span> | ||
| {% endif %} | ||
| </span> | ||
| {% endblock %} | ||
|
|
||
| {% block panel %} | ||
| <h2>HTTP Client</h2> | ||
| {% if collector.requestCount == 0 %} | ||
| <div class="empty"> | ||
| <p>No HTTP requests were made.</p> | ||
| </div> | ||
| {% else %} | ||
| <div class="metrics"> | ||
| <div class="metric"> | ||
| <span class="value">{{ collector.requestCount }}</span> | ||
| <span class="label">Total requests</span> | ||
| </div> | ||
| <div class="metric"> | ||
| <span class="value">{{ collector.errorCount }}</span> | ||
| <span class="label">HTTP errors</span> | ||
| </div> | ||
| </div> | ||
| <h2>Clients</h2> | ||
| <div class="sf-tabs"> | ||
| {% for name, client in collector.clients %} | ||
| <div class="tab {{ client.traces|length == 0 ? 'disabled' }}"> | ||
| <h3 class="tab-title">{{ name }} <span class="badge">{{ client.traces|length }}</span></h3> | ||
| <div class="tab-content"> | ||
| {% if client.traces|length == 0 %} | ||
| <div class="empty"> | ||
| <p>No requests were made with the "{{ name }}" service.</p> | ||
| </div> | ||
| {% else %} | ||
| <h4>Requests</h4> | ||
| {% for trace in client.traces %} | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th> | ||
| <span class="label">{{ trace.method }}</span> | ||
| </th> | ||
| <th> | ||
| {{ trace.url }} | ||
| {% if trace.options is not empty %} | ||
| {{ profiler_dump(trace.options, maxDepth=1) }} | ||
| {% endif %} | ||
| </th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <th> | ||
| {% if trace.http_code >= 500 %} | ||
| {% set responseStatus = 'error' %} | ||
| {% elseif trace.http_code >= 400 %} | ||
| {% set responseStatus = 'warning' %} | ||
| {% else %} | ||
| {% set responseStatus = 'success' %} | ||
| {% endif %} | ||
| <span class="label status-{{ responseStatus }}"> | ||
| {{ trace.http_code }} | ||
| </span> | ||
| </th> | ||
| <td> | ||
| {{ profiler_dump(trace.info, maxDepth=1) }} | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| {% endfor %} | ||
| {% endif %} | ||
| </div> | ||
| </div> | ||
| {% endfor %} | ||
| {% endif %} | ||
| </div> | ||
| {% endblock %} | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpClient\DataCollector; | ||
|
|
||
| use Symfony\Component\HttpClient\TraceableHttpClient; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
| use Symfony\Component\HttpFoundation\Response; | ||
| use Symfony\Component\HttpKernel\DataCollector\DataCollector; | ||
|
|
||
| /** | ||
| * @author Jérémy Romey <jeremy@free-agent.fr> | ||
| */ | ||
| final class HttpClientDataCollector extends DataCollector | ||
| { | ||
| /** | ||
| * @var TraceableHttpClient[] | ||
| */ | ||
| private $clients = []; | ||
|
|
||
| public function addClient(string $name, TraceableHttpClient $client) | ||
| { | ||
| $this->clients[$name] = $client; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function collect(Request $request, Response $response, \Exception $exception = null) | ||
| { | ||
| $this->data = [ | ||
| 'clients' => [], | ||
| 'request_count' => 0, | ||
| 'error_count' => 0, | ||
| ]; | ||
|
|
||
| foreach ($this->clients as $name => $client) { | ||
| $traces = $client->getTraces(); | ||
|
|
||
| $this->data['request_count'] += \count($traces); | ||
| $errorCount = 0; | ||
|
|
||
| foreach ($traces as $i => $trace) { | ||
| if (400 <= ($trace['info']['http_code'] ?? 0)) { | ||
| ++$errorCount; | ||
| } | ||
|
|
||
| $info = $trace['info']; | ||
| $traces[$i]['http_code'] = $info['http_code']; | ||
|
|
||
| unset($info['filetime'], $info['http_code'], $info['ssl_verify_result'], $info['content_type']); | ||
|
|
||
| if ($trace['method'] === $info['http_method']) { | ||
| unset($info['http_method']); | ||
| } | ||
|
|
||
| if ($trace['url'] === $info['url']) { | ||
| unset($info['url']); | ||
| } | ||
|
|
||
| foreach ($info as $k => $v) { | ||
| if (!$v || (is_numeric($v) && 0 > $v)) { | ||
| unset($info[$k]); | ||
| } | ||
| } | ||
|
|
||
| $traces[$i]['info'] = $this->cloneVar($info); | ||
| $traces[$i]['options'] = $this->cloneVar($trace['options']); | ||
| } | ||
|
|
||
| $this->data['clients'][$name] = [ | ||
| 'traces' => $traces, | ||
| 'error_count' => $errorCount, | ||
| ]; | ||
| $this->data['error_count'] += $errorCount; | ||
| } | ||
| } | ||
|
|
||
| public function getClients(): array | ||
| { | ||
| return $this->data['clients'] ?? []; | ||
| } | ||
|
|
||
| public function getRequestCount(): int | ||
| { | ||
| return $this->data['request_count'] ?? 0; | ||
| } | ||
|
|
||
| public function getErrorCount(): int | ||
| { | ||
| return $this->data['error_count'] ?? 0; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function reset() | ||
| { | ||
| $this->data = []; | ||
| foreach ($this->clients as $client) { | ||
| $client->clearTraces(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getName(): string | ||
| { | ||
| return 'http_client'; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpClient; | ||
|
|
||
| use Symfony\Contracts\HttpClient\HttpClientInterface; | ||
| use Symfony\Contracts\HttpClient\ResponseInterface; | ||
| use Symfony\Contracts\HttpClient\ResponseStreamInterface; | ||
|
|
||
| /** | ||
| * @author Jérémy Romey <jeremy@free-agent.fr> | ||
| */ | ||
| final class TraceableHttpClient implements HttpClientInterface | ||
| { | ||
| private $client; | ||
| private $traces = []; | ||
|
|
||
| public function __construct(HttpClientInterface $client) | ||
| { | ||
| $this->client = $client; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function request(string $method, string $url, array $options = []): ResponseInterface | ||
| { | ||
| $traceInfo = []; | ||
| $this->traces[] = [ | ||
| 'method' => $method, | ||
| 'url' => $url, | ||
| 'options' => $options, | ||
| 'info' => &$traceInfo, | ||
| ]; | ||
| $onProgress = $options['on_progress'] ?? null; | ||
|
|
||
| $options['on_progress'] = function (int $dlNow, int $dlSize, array $info) use (&$traceInfo, $onProgress) { | ||
| $traceInfo = $info; | ||
|
|
||
| if ($onProgress) { | ||
| $onProgress($dlNow, $dlSize, $info); | ||
| } | ||
| }; | ||
|
|
||
| return $this->client->request($method, $url, $options); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function stream($responses, float $timeout = null): ResponseStreamInterface | ||
| { | ||
| return $this->client->stream($responses, $timeout); | ||
| } | ||
|
|
||
| public function getTraces(): array | ||
| { | ||
| return $this->traces; | ||
| } | ||
|
|
||
| public function clearTraces() | ||
| { | ||
| $this->traces = []; | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It could be interesting to add a tag to the service a this point, and to do the wiring logic in a compiler pass for all services having this tag. It will allow bundles to easily plug their own clients in the profiler.
For instance, we have this use case in API Platform.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm almost done except your comment.
To be sure to get your point I looked the Messenger stuff. So we are ok to add a tag to all http client here https://github.com/symfony/symfony/blob/4.4/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php#L1946-L1953
Like
http_client.client?Then adding a HttpClientPass to make the call to the dataCollector in all service tagged with
http_client.client. (if data_collector is registered of course).Right ?