phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-17 06:09:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
hugo/docs/content/en/troubleshooting/performance.md

95 lines
4.6 KiB
Markdown
Raw Normal View History

Squashed 'docs/' changes from 4d936aee6..4dd2d6415 4dd2d6415 Fix erroridf example 9ae8e9199 Clarify highlight options f3943f9c8 Fix typo b57ea5ac8 Add field to glossary of terms 3191e35b4 Clarify comment in the new-in shortcode 870c8d35c Correct description of Ref and RelRef page methods c9df50e6e Specify encoding in description of crypto functions 749bb37e2 Add Ref, RelRef, and Site shortcode methods 994d4374b Update fmt functions 740f5ef96 Misc additions 77acdcdb6 Remove rssLimit from root config documentation df84a1795 Document the openapi3.Unmarshal function 24236f57d Miscellaneous edits and corrections 41b54d421 Hide the "new in" button after some period of time 3c1ebac31 Update Ancestors.md e699eb313 Add new-in tags to select functions and methods 5c41f0bf8 Clarify time.Format method f7bd43ae1 Add link to built-in render hook for GoAT diagrams 06f9cd4c9 Document the diagrams.Goat function 5e432e12d Adjust quick reference weights fc915efd6 Update FAQ 5bccf8b19 Use LinkTitle consistently in examples 36f207f3a Add page collection quick reference 699de883d Inlcude example of newScratch.Values 9bb7f8c78 Include RenderString example for emoji shortcodes 783fdd3ac Fix typo 26d5a4399 Fix typo c7e86f0cf Fix typo ad2a82fbd Clarify data type returned by partial and partialCached 1de5a52dd Miscellaneous corrections 3509e1b4d Update configuration-markup.md 8c6a9bf02 Clairfy figure shortcode output c9d0dc8fb Update Markdownify.md 0c4bc1447 Update theme 0f0ab2ade Add methods deprecated in v0.120.0 e1c6ecd0f Miscellaneous edits ec53b55b9 netlify: Hugo 0.120.4 23a1f3fd5 templates/internal.md: Correct GoogleAnalytics key name 6dcfa9a82 Update troubleshooting section 0c8857e8f Adjust code and code-toggle shortcodes 8820264d3 Reduce number of site audit warnings 526d06b90 Clarify hint option in image processing spec 310849daa Image Processing: Improve sentence and fix code sample 5bb67bfd4 Revert "Image Processing: Improve sentence and fix code sample" (#2318) 77c926fde Image Processing: Improve sentence and fix code sample 52179fb18 Miscellaneous edits f4e886715 Revert change to hugo.work c410fefa8 Update theme 8b72dfedd Rework where function documentation f35a7126f Minor edits to global page function 903b42ebc Cleanup shortcode calls c9247e98d Update documentation.md dff3c4abb Clean up build option descriptions and examples f46d31308 Use consistent signatures 2af2470b5 Minor correction to resources.GetRemote 45ec53fe0 Remove superfluous shortcode param 2a0544757 Improve deployment documentation 3cf36a7fc Clarify lang keyword f10d6495d Update front-matter.md dc94e20be Add Sveltia to CMS list b15d6d670 Update front-ends.md bb41588b2 Update FormatCurrency.md b40fff396 Add showcase for hidden sections without index.html 71316e181 Improve image filter examples d46f0b1d8 Miscellaneous edits ad3f9cdb6 Adjust quick reference guides 8657804ba Update theme d9e981147 Miscellaneous corrections 508666575 Miscellaneous updates 80b2241f9 Miscellaneous updates 723a827fd Namespace functions and methods 40212779a netlify: Hugo 0.120.3 66017c704 Bump GitHub workflows to latest versions db0f1e682 Update related.md 7e758c23b netlify: Hugo 0.120.2 641ba3976 Update configuration.md d2a9909d9 Update rss.md 7eb59d7a2 netlify: Hugo 0.120.1 708c351c4 Document debug.Timer 28e2388c2 Add new-in tag to images.Padding ee24cffb5 Add new-in tags to hugo.IsDevelopment and hugo.IsServer aa47ca023 netlify: Hugo 0.120.0 9c3e606fc docs: Regen docshelper 159fd971e commands/new: Remove format flag from new content cmd 9f7878092 Merge commit 'aaaf1c8df5d6aa061609d20510f7fa6c42e5cc1a' 65b2dd324 docs: Regenerate docshelper 2be620663 resources/images: Create padding image filter c777d6c5e Merge commit '3710a5ec7efe6baca6e452f43632c05d22bab3c4' 24f2afeb2 Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688' 3f947c19a hugolib: Deprecate .Site.DisqusShortname 6bd1af892 hugolib: Deprecate .Site.GoogleAnalytics 78becc6ee tpl/tplimpl: Deprecate .Site.Social usage with internal templates e3ec2a4f2 common/hugo: Add hugo.IsServer and hugo.IsDevelopment git-subtree-dir: docs git-subtree-split: 4dd2d641531f74025ed9f51ea5a961e936988cfb
2023-12-04 14:14:18 +00:00
---
title: Performance
description: Use template metrics and timers to identify opportunities to improve performance.
categories: [troubleshooting]
keywords: []
menu:
docs:
parent: troubleshooting
weight: 60
weight: 60
toc: true
aliases: [/troubleshooting/build-performance/]
---
## Template metrics
Squashed 'docs/' changes from 4dd2d6415..3b1a8579d 3b1a8579d Update theme b1f04fd47 params: Adjust the twitter handle 2c8ba029f Fix typo 4421e46ec Update Where.md 5f9fec6a5 Update glossary.md fb16945cf collections.Where - Clarify description of "collection" 4d6d7018b Update Include.md - improve return statement example 037151073 Update IncludeCached - improve return statement example b053fa09c Improve return types f7d615267 Describe minimum required Windows version e97762b2a Update front matter in math.Sub 9e4d03a79 Fix data.GetJSON examples 9029ee123 Update spellcheck GitHub Action c852fe421 Add version verification step to quick start guide 8fafca49c Correct front matter example b412fdf65 Fix closing tag in notes docs 9a64d9579 Add hreflang Tag to Translation Link example 2d2a82101 Fix inverted examples in Permalink and RelPermalink ff3e67e3f Correct spelling 3904b72e3 Fix documentation contribution steps enumeration 348fd3c02 Fix some typos in the content summaries page a5823459a Fix two links, one to bonsai.io and one to digital.gov c36978686 Fix typo 0ee3ff44f Vendor theme 6b0a9b75d Fix typo 44e4cb5c6 Fix typos 815071742 Update min Go version to build from source 192d14df5 Fix typo e4a18946e Miscellaneous corrections f12b7b74e netlify: Hugo 0.121.2 97dbc1ea1 Merge branch 'tempv0.121.2' dc1c0aeeb Add cache note to resources.Concat a8d1a6020 Correct return type eca22e97c Fix front matter 7de247a03 Correct return type 5058bc520 collections.Seq: Specify max slice size e24d81a4b Fix typo on FAQ page ff8cf5a88 Correct 'related' front matter values 88b21fae0 Adjust deprecation handling f7e19a25b Update terminology on shortcode templates page 01e10942a Adjust formatting 6ed2e19c2 tpl/math: Add math.Rand template function b494a8d8d Update js.md 6d78035f4 Add interval description to glossary (#2378) f9b612b64 Templates Lookup Order: Add missing parenthesis 741ab1bb2 Show vendorClosest in module default config eb8cb878f Fix Babel headings cdcdfc8e8 Change project name in Codeowners example f31fe0d63 Update link to image filters 9dee1ee0e Update Solus installation instructions 716636fee Add TOC to collections.Sort f7c64143c Update collections.Sort 4b8f6b991 Add id attributes to Scratch and Store methods 2a1adea79 Add id attributes to GitInfo, File, and Resources methods b12d9cb8f Add Alpine Linux installation instructions dfbebeec7 Change writeStats to buildStats 175b8aac8 resources/images: Create AutoOrient image filter ba8e05c31 Update img shortcode 7fc15a6cc Fix default value of pluralizeListTitles a0be4fd8a Add Comentario to available comment engines 71aa7d8ab Update GitInfo.md 348441491 EXIF: describe applicable image types 743497eda Disable TOC for lang.Translate b3b1df75d Describe lang.Translate fallback behavior a6d9c362c Categorize CLI commands to improve search results 08cc2da4b Document canonical config for enabling inline shortcodes 8945be9c6 Update description of the humanize ordinal conversion b8b4ccb6f Fix grammatical error f53f9f936 Fix description of strings.HasSuffix cdbe19b5b Update Params.md e00c4eea2 Reformat site config descriptions 6f50c0755 Enumerate root configuration keys 1f2e7b9b2 Use canonical key when documenting menu configs 7d5a13d8d Update images.Text filter 315d2f8c3 Add math.Counter example to warnf 8ed9cdaa9 Miscellaneous edits 2bda491eb Fix front matter example 5c5bbbe3a netlify: Bump to Hugo 0.121.1 ed08f5943 Update Gentoo installation instructions e4eb48457 Miscellaneous edits 8c3700d12 netlify: Bump to Hugo 0.121.0 1bb5a377f Merge branch 'tempv0.121.0' 8cba89504 Improve where function 0dfc00b0f docs: Regen docshelper 028076a66 Fix link to Gentoo package 52d2db4ff Fix typo 120025c19 Improve Gentooo installation instructions 0c31a4b45 Update GitHub hosting workflow example dee99c36a Defend against missing aliases in quick-reference shortcode d305278f1 Add Gentoo installation instructions be98a37e1 docs: Adjust last merge from docs repository a703dab53 docs: Regen docs helper 2e9c3532f Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae' f57fdb44b deps: Update github.com/tdewolff/minify/v2 v2.20.7 => v2.20.8 50cad5e38 tpl/transform: Add transform.XMLEscape template function git-subtree-dir: docs git-subtree-split: 3b1a8579d2e032c1aab8a74d4cf63849ba11e7a8
2024-01-26 07:11:52 +00:00
Hugo is fast, but inefficient templates impede performance. Enable template metrics to determine which templates take the most time, and to identify caching opportunities:
Squashed 'docs/' changes from 4d936aee6..4dd2d6415 4dd2d6415 Fix erroridf example 9ae8e9199 Clarify highlight options f3943f9c8 Fix typo b57ea5ac8 Add field to glossary of terms 3191e35b4 Clarify comment in the new-in shortcode 870c8d35c Correct description of Ref and RelRef page methods c9df50e6e Specify encoding in description of crypto functions 749bb37e2 Add Ref, RelRef, and Site shortcode methods 994d4374b Update fmt functions 740f5ef96 Misc additions 77acdcdb6 Remove rssLimit from root config documentation df84a1795 Document the openapi3.Unmarshal function 24236f57d Miscellaneous edits and corrections 41b54d421 Hide the "new in" button after some period of time 3c1ebac31 Update Ancestors.md e699eb313 Add new-in tags to select functions and methods 5c41f0bf8 Clarify time.Format method f7bd43ae1 Add link to built-in render hook for GoAT diagrams 06f9cd4c9 Document the diagrams.Goat function 5e432e12d Adjust quick reference weights fc915efd6 Update FAQ 5bccf8b19 Use LinkTitle consistently in examples 36f207f3a Add page collection quick reference 699de883d Inlcude example of newScratch.Values 9bb7f8c78 Include RenderString example for emoji shortcodes 783fdd3ac Fix typo 26d5a4399 Fix typo c7e86f0cf Fix typo ad2a82fbd Clarify data type returned by partial and partialCached 1de5a52dd Miscellaneous corrections 3509e1b4d Update configuration-markup.md 8c6a9bf02 Clairfy figure shortcode output c9d0dc8fb Update Markdownify.md 0c4bc1447 Update theme 0f0ab2ade Add methods deprecated in v0.120.0 e1c6ecd0f Miscellaneous edits ec53b55b9 netlify: Hugo 0.120.4 23a1f3fd5 templates/internal.md: Correct GoogleAnalytics key name 6dcfa9a82 Update troubleshooting section 0c8857e8f Adjust code and code-toggle shortcodes 8820264d3 Reduce number of site audit warnings 526d06b90 Clarify hint option in image processing spec 310849daa Image Processing: Improve sentence and fix code sample 5bb67bfd4 Revert "Image Processing: Improve sentence and fix code sample" (#2318) 77c926fde Image Processing: Improve sentence and fix code sample 52179fb18 Miscellaneous edits f4e886715 Revert change to hugo.work c410fefa8 Update theme 8b72dfedd Rework where function documentation f35a7126f Minor edits to global page function 903b42ebc Cleanup shortcode calls c9247e98d Update documentation.md dff3c4abb Clean up build option descriptions and examples f46d31308 Use consistent signatures 2af2470b5 Minor correction to resources.GetRemote 45ec53fe0 Remove superfluous shortcode param 2a0544757 Improve deployment documentation 3cf36a7fc Clarify lang keyword f10d6495d Update front-matter.md dc94e20be Add Sveltia to CMS list b15d6d670 Update front-ends.md bb41588b2 Update FormatCurrency.md b40fff396 Add showcase for hidden sections without index.html 71316e181 Improve image filter examples d46f0b1d8 Miscellaneous edits ad3f9cdb6 Adjust quick reference guides 8657804ba Update theme d9e981147 Miscellaneous corrections 508666575 Miscellaneous updates 80b2241f9 Miscellaneous updates 723a827fd Namespace functions and methods 40212779a netlify: Hugo 0.120.3 66017c704 Bump GitHub workflows to latest versions db0f1e682 Update related.md 7e758c23b netlify: Hugo 0.120.2 641ba3976 Update configuration.md d2a9909d9 Update rss.md 7eb59d7a2 netlify: Hugo 0.120.1 708c351c4 Document debug.Timer 28e2388c2 Add new-in tag to images.Padding ee24cffb5 Add new-in tags to hugo.IsDevelopment and hugo.IsServer aa47ca023 netlify: Hugo 0.120.0 9c3e606fc docs: Regen docshelper 159fd971e commands/new: Remove format flag from new content cmd 9f7878092 Merge commit 'aaaf1c8df5d6aa061609d20510f7fa6c42e5cc1a' 65b2dd324 docs: Regenerate docshelper 2be620663 resources/images: Create padding image filter c777d6c5e Merge commit '3710a5ec7efe6baca6e452f43632c05d22bab3c4' 24f2afeb2 Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688' 3f947c19a hugolib: Deprecate .Site.DisqusShortname 6bd1af892 hugolib: Deprecate .Site.GoogleAnalytics 78becc6ee tpl/tplimpl: Deprecate .Site.Social usage with internal templates e3ec2a4f2 common/hugo: Add hugo.IsServer and hugo.IsDevelopment git-subtree-dir: docs git-subtree-split: 4dd2d641531f74025ed9f51ea5a961e936988cfb
2023-12-04 14:14:18 +00:00
```sh
hugo --templateMetrics --templateMetricsHints
```
The result will look something like this:
```text
Template Metrics:
cumulative average maximum cache percent cached total
duration duration duration potential cached count count template
---------- -------- -------- --------- ------- ------ ----- --------
36.037476822s 135.990478ms 225.765245ms 11 0 0 265 partials/head.html
35.920040902s 164.018451ms 233.475072ms 0 0 0 219 articles/single.html
34.163268129s 128.917992ms 224.816751ms 23 0 0 265 partials/head/meta/opengraph.html
1.041227437s 3.92916ms 186.303376ms 47 0 0 265 partials/head/meta/schema.html
805.628827ms 27.780304ms 114.678523ms 0 0 0 29 _default/list.html
624.08354ms 15.221549ms 108.420729ms 8 0 0 41 partials/utilities/render-page-collection.html
545.968801ms 775.523µs 105.045775ms 0 0 0 704 _default/summary.html
334.680981ms 1.262947ms 127.412027ms 100 0 0 265 partials/head/js.html
272.763205ms 2.050851ms 24.371757ms 0 0 0 133 _default/_markup/render-codeblock.html
230.490038ms 8.865001ms 177.4615ms 0 0 0 26 shortcodes/template.html
176.921913ms 176.921913ms 176.921913ms 0 0 0 1 examples.tmpl
163.951469ms 14.904679ms 70.267953ms 0 0 0 11 articles/list.html
153.07021ms 577.623µs 73.593597ms 100 0 0 265 partials/head/init.html
150.910984ms 150.910984ms 150.910984ms 0 0 0 1 _default/single.html
146.785804ms 146.785804ms 146.785804ms 0 0 0 1 _default/contact.html
115.364617ms 115.364617ms 115.364617ms 0 0 0 1 authors/term.html
87.392071ms 329.781µs 10.687132ms 100 0 0 265 partials/head/css.html
86.803122ms 86.803122ms 86.803122ms 0 0 0 1 _default/home.html
```
From left to right, the columns represent:
cumulative duration
: The cumulative time spent executing the template.
average duration
: The average time spent executing the template.
maximum duration
: The maximum time spent executing the template.
cache potential
: Displayed as a percentage, any partial template with a 100% cache potential should be called with the [`partialCached`] function instead of the [`partial`] function. See the [caching](#caching) section below.
percent cached
: The number of times the rendered templated was cached divided by the number of times the template was executed.
cached count
: The number of times the rendered templated was cached.
total count
: The number of times the template was executed.
template
: The path to the template, relative to the layouts directory.
[`partial`]: /functions/partials/include
[`partialCached`]: /functions/partials/includecached
{{% note %}}
Hugo builds pages in parallel where multiple pages are generated simultaneously. Because of this parallelism, the sum of "cumulative duration" values is usually greater than the actual time it takes to build a site.
{{% /note %}}
## Caching
Some partial templates such as sidebars or menus are executed many times during a site build. Depending on the content within the partial template and the desired output, the template may benefit from caching to reduce the number of executions. The [`partialCached`] template function provides caching capabilities for partial templates.
{{% note %}}
Note that you can create cached variants of each partial by passing additional parameters to `partialCached` beyond the initial context. See the `partialCached` documentation for more details.
{{% /note %}}
## Timers
Use the `debug.Timer` function to determine execution time for a block of code, useful for finding performance bottle necks in templates. See [details](/functions/debug/timer/).
Reference in a new issue Copy permalink