Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[HttpKernel] Documenttrace_level andtrace_header config options inHttpCache#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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
wouterj merged 1 commit intosymfony:masterfrommpdude:http-cache-header-docs
Apr 7, 2019

Conversation

@mpdude
Copy link
Contributor

@mpdudempdude commentedApr 7, 2019
edited
Loading

Here's a small addition forsymfony/symfony#30964.

#FOSSHackathon

@mpdudempdude changed the titleAdd a tip pointing to the two new configuration options[HttpKernel] Documenttrace_level andtrace_header config options inHttpCacheApr 7, 2019
@wouterjwouterj added ⭐️ EU-FOSSA Hackathonhttps://symfony.com/blog/the-symfony-and-api-platform-hackathon-is-coming Waiting Code MergeDocs for features pending to be merged labelsApr 7, 2019
..versionadded::4.3

The ``trace_level`` and ``trace_header`` configuration options
were added in Symfony 4.3.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
wereadded in Symfony 4.3.
wereintroduced in Symfony 4.3.

``short`` contains 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.
Copy link
Member

Choose a reason for hiding this comment

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

I would add "This information can be used to extract general information about cache efficiency of your routes." here instead of the new paragraph, to avoid a wall of text.

@wouterjwouterj added this to thenext milestoneApr 7, 2019
symfony-splitter pushed a commit to symfony/http-kernel that referenced this pull requestApr 7, 2019
…eader configurable (mpdude)This PR was squashed before being merged into the 4.3-dev branch (closes #30964).Discussion----------[HttpKernel] Add a "short" trace header format, make header configurable| Q             | A| ------------- | ---| Branch?       | master| Bug fix?      | no| New feature?  | yes| BC breaks?    | no| Deprecations? | no| Tests pass?   | yes| Fixed tickets || License       | MIT| Doc PR        |symfony/symfony-docs#11340This pull requests adds the first usage of `array_key_first` to the Symfony code base. Additionally, it makes it possible to configure the `HttpCache` to also add a "trace" header in production.The `HttpCache` is a convenient, low-barrier yet performant way of accelerating the application. By having the "trace" information returned as a header in production as well, you can write it to server log files. For example, with Apache you can use `%{X-Symfony-Cache}o` in the `LogFormat` directive to log response headers.With the information in the log files, you can easily process it from logfile processing/system metrics tools to find out about cache performance, efficiency and the URLs that might need extra cache tweaking.<img width="1040" alt="Bildschirmfoto 2019-04-07 um 11 43 23" src="https://user-images.githubusercontent.com/1202333/55681763-6e90e980-592a-11e9-900f-e096350531c2.png">The "short" format will only output information for the main request to avoid leaking internal URLs for ESI subrequests. I also chose a concise format like `stale/valid/store` because that's much easier to parse out of logfiles (no whitespace, no need for quotes etc.).If you're not comfortable with having `Symfony` in the header name that way, the header name can be changed through a configuration setting as well.#FOSSHackathonCommits-------9a2fcc9 [HttpKernel] Add a \"short\" trace header format, make header configurable
nicolas-grekas added a commit to symfony/symfony that referenced this pull requestApr 7, 2019
…eader configurable (mpdude)This PR was squashed before being merged into the 4.3-dev branch (closes#30964).Discussion----------[HttpKernel] Add a "short" trace header format, make header configurable| Q             | A| ------------- | ---| Branch?       | master| Bug fix?      | no| New feature?  | yes| BC breaks?    | no| Deprecations? | no| Tests pass?   | yes| Fixed tickets || License       | MIT| Doc PR        |symfony/symfony-docs#11340This pull requests adds the first usage of `array_key_first` to the Symfony code base. Additionally, it makes it possible to configure the `HttpCache` to also add a "trace" header in production.The `HttpCache` is a convenient, low-barrier yet performant way of accelerating the application. By having the "trace" information returned as a header in production as well, you can write it to server log files. For example, with Apache you can use `%{X-Symfony-Cache}o` in the `LogFormat` directive to log response headers.With the information in the log files, you can easily process it from logfile processing/system metrics tools to find out about cache performance, efficiency and the URLs that might need extra cache tweaking.<img width="1040" alt="Bildschirmfoto 2019-04-07 um 11 43 23" src="https://user-images.githubusercontent.com/1202333/55681763-6e90e980-592a-11e9-900f-e096350531c2.png">The "short" format will only output information for the main request to avoid leaking internal URLs for ESI subrequests. I also chose a concise format like `stale/valid/store` because that's much easier to parse out of logfiles (no whitespace, no need for quotes etc.).If you're not comfortable with having `Symfony` in the header name that way, the header name can be changed through a configuration setting as well.#FOSSHackathonCommits-------9a2fcc9 [HttpKernel] Add a \"short\" trace header format, make header configurable
@OskarStarkOskarStark removed the Waiting Code MergeDocs for features pending to be merged labelApr 7, 2019
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.

..tip::
Copy link
Contributor

Choose a reason for hiding this comment

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

I am against such a “big” tip, why not adding a new dedicated section with a headline?

@mpdude
Copy link
ContributorAuthor

Did some brush-ups, please check again.

@wouterjwouterj modified the milestones:next,4.3Apr 7, 2019
@wouterjwouterjforce-pushed thehttp-cache-header-docs branch from15772e1 to75febdcCompareApril 7, 2019 20:00
@wouterj
Copy link
Member

Thanks a lot, this looks like a great feature & great docs! (and also great to have met you in real life this weekend!)

mpdude reacted with heart emoji

@wouterjwouterj merged commit75febdc intosymfony:masterApr 7, 2019
wouterj added a commit that referenced this pull requestApr 7, 2019
… config options in `HttpCache` (mpdude)This PR was squashed before being merged into the master branch (closes#11340).Discussion----------[HttpKernel] Document `trace_level` and `trace_header` config options in `HttpCache`Here's a small addition forsymfony/symfony#30964.#FOSSHackathonCommits-------75febdc [HttpKernel] Document `trace_level` and `trace_header` config options in `HttpCache`
@mpdudempdude deleted the http-cache-header-docs branchApril 8, 2019 20:16
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@wouterjwouterjwouterj approved these changes

@OskarStarkOskarStarkOskarStark approved these changes

Assignees

No one assigned

Labels

⭐️ EU-FOSSA Hackathonhttps://symfony.com/blog/the-symfony-and-api-platform-hackathon-is-comingStatus: Reviewed

Projects

None yet

Milestone

4.3

Development

Successfully merging this pull request may close these issues.

4 participants

@mpdude@wouterj@OskarStark@carsonbot

[8]ページ先頭

©2009-2025 Movatter.jp