Skip to content

[HttpKernel] Document trace_level and trace_header config options in HttpCache #11340

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 7, 2019
Merged

[HttpKernel] Document trace_level and trace_header config options in HttpCache #11340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 20 additions & 1 deletion http_cache.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,26 @@ For a full list of the options and their meaning, see the

When you're in debug mode (the second argument of ``Kernel`` constructor in the
front controller is ``true``), Symfony automatically adds an ``X-Symfony-Cache``
header to the response. Use this to get information about cache hits and misses.
header to the response. You can also use the ``trace_level`` config
option and set it to either ``none``, ``short`` or ``full`` to
add this information.

``short`` will add the information for the master request only.
It's written in a concise way that makes it easy to record the
information in your server log files. For example, in Apache you can
use ``%{X-Symfony-Cache}o`` in ``LogFormat`` format statements.
This information can be used to extract general information about
cache efficiency of your routes.

.. tip::

You can change the name of the header used for the trace
information using the ``trace_header`` config option.

.. versionadded:: 4.3

The ``trace_level`` and ``trace_header`` configuration options
were introduced in Symfony 4.3.

.. _http-cache-symfony-versus-varnish:

Expand Down