Enhanced PHP File Manager

⬆️ Go Up (..)

📊 Server Information

Server:

nginx/1.28.0

System:

Linux 6.8.0-90-generic

PHP Version:

8.4.15

User:

alqudsvolunteers

Directory:

/home/alqudsvolunteers/rootlink/proc/thread-self/root/usr/share/doc/varnish/html/users-guide

Free Space:

79.31 GB

🔧 Quick Actions

✏️ Editing: vcl-grace.html

<!DOCTYPE html>

<title>Grace mode and keep &#8212; Varnish version 7.5.0 documentation</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=e2714048" />
    
    <script src="../_static/documentation_options.js?v=8214db13"></script>
    <script src="../_static/doctools.js?v=888ff710"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Separate VCL files" href="vcl-separate.html" />
    <link rel="prev" title="Hashing" href="vcl-hashing.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="vcl-separate.html" title="Separate VCL files"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="vcl-hashing.html" title="Hashing"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Varnish version 7.5.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >The Varnish Users Guide</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="vcl.html" accesskey="U">VCL - Varnish Configuration Language</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Grace mode and keep</a></li> 
      </ul>
    </div>

<div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="grace-mode-and-keep">
<span id="users-guide-handling-misbehaving-servers"></span><h1>Grace mode and keep<a class="headerlink" href="#grace-mode-and-keep" title="Link to this heading">¶</a></h1>
<p>Sometimes you want Varnish to serve content that is somewhat stale
instead of waiting for a fresh object from the backend. For example,
if you run a news site, serving a main page that is a few seconds old
is not a problem if this gives your site faster load times.</p>
<p>In Varnish this is achieved by using <cite>grace mode</cite>. A related idea
is <cite>keep</cite>, which is also explained here.</p>
<section id="grace-mode">
<h2>Grace mode<a class="headerlink" href="#grace-mode" title="Link to this heading">¶</a></h2>
<p>When several clients are requesting the same page Varnish will send
one request to the backend and place the others on hold while fetching
one copy from the backend. In some products this is called request
coalescing and Varnish does this automatically.</p>
<p>If you are serving thousands of hits per second the queue of waiting
requests can get huge. There are two potential problems - one is a
thundering herd problem - suddenly releasing a thousand threads to
serve content might send the load sky high. Secondly - nobody likes to
wait.</p>
<p>Setting an object’s <cite>grace</cite> to a positive value tells Varnish that it
should serve the object to clients for some time after the TTL has
expired, while Varnish fetches a new version of the object. The default
value is controlled by the runtime parameter <code class="docutils literal notranslate"><span class="pre">default_grace</span></code>.</p>
</section>
<section id="keep">
<h2>Keep<a class="headerlink" href="#keep" title="Link to this heading">¶</a></h2>
<p>Setting an object’s <cite>keep</cite> tells Varnish that it should keep an object
in the cache for some additional time. The reasons to set <cite>keep</cite> is to
use the object to construct a conditional GET backend request (with
If-Modified-Since: and/or Ìf-None-Match: headers), allowing the
backend to reply with a 304 Not Modified response, which may be more
efficient on the backend and saves re-transmitting the unchanged body.</p>
<p>The values are additive, so if grace is 10 seconds and keep is 1 minute,
then objects will survive in cache for 70 seconds after the TTL has
expired.</p>
</section>
<section id="setting-grace-and-keep">
<h2>Setting grace and keep<a class="headerlink" href="#setting-grace-and-keep" title="Link to this heading">¶</a></h2>
<p>We can use VCL to make Varnish keep all objects for 10 minutes beyond
their TTL with a grace period of 2 minutes:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sub</span> <span class="n">vcl_backend_response</span> <span class="p">{</span>
     <span class="nb">set</span> <span class="n">beresp</span><span class="o">.</span><span class="n">grace</span> <span class="o">=</span> <span class="mi">2</span><span class="n">m</span><span class="p">;</span>
     <span class="nb">set</span> <span class="n">beresp</span><span class="o">.</span><span class="n">keep</span> <span class="o">=</span> <span class="mi">8</span><span class="n">m</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
<section id="the-effect-of-grace-and-keep">
<h2>The effect of grace and keep<a class="headerlink" href="#the-effect-of-grace-and-keep" title="Link to this heading">¶</a></h2>
<p>For most users setting the default grace and/or a suitable grace for
each object is enough. The default VCL will do the right thing and
behave as described above. However, if you want to customize how
Varnish behaves, then you should know some of the details on how this
works.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">sub</span> <span class="pre">vcl_recv</span></code> ends with <code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">(lookup)</span></code> (which is the
default behavior), Varnish will look for a matching object in its
cache. Then, if it only found an object whose TTL has run out, Varnish
will consider the following:</p>
<ul class="simple">
<li><p>Is there already an ongoing backend request for the object?</p></li>
<li><p>Is the object within the <cite>grace period</cite>?</p></li>
</ul>
<p>Then, Varnish reacts using the following rules:</p>
<ul class="simple">
<li><p>If the <cite>grace period</cite> has run out and there is no ongoing backend
request, then <code class="docutils literal notranslate"><span class="pre">sub</span> <span class="pre">vcl_miss</span></code> is called immediately, and the object
will be used as a 304 candidate.</p></li>
<li><p>If the <cite>grace period</cite> has run out and there is an ongoing backend
request, then the request will wait until the backend request
finishes.</p></li>
<li><p>If there is no backend request for the object, one is scheduled.</p></li>
<li><p>Assuming the object will be delivered, <code class="docutils literal notranslate"><span class="pre">sub</span> <span class="pre">vcl_hit</span></code> is called
immediately.</p></li>
</ul>
<p>Note that the backend fetch happens asynchronously, and the moment the
new object is in it will replace the one we’ve already got.</p>
<p>If you do not define your own <code class="docutils literal notranslate"><span class="pre">sub</span> <span class="pre">vcl_hit</span></code>, then the default one is
used. It looks like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sub</span> <span class="n">vcl_hit</span> <span class="p">{</span>
     <span class="k">return</span> <span class="p">(</span><span class="n">deliver</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Note that the condition <code class="docutils literal notranslate"><span class="pre">obj.ttl</span> <span class="pre">+</span> <span class="pre">obj.grace</span> <span class="pre">&gt;</span> <span class="pre">0s</span></code> will (in <code class="docutils literal notranslate"><span class="pre">sub</span>
<span class="pre">vcl_hit</span></code>) always evaluate to true. In earlier versions (6.0.0 and
earlier), this was not the case, and a test in the builtin VCL was
necessary to make sure that “keep objects” (objects in the cache where
both TTL and grace had run out) would not be delivered to the clients.</p>
<p>In the current version, when there are only “keep objects” available,
<code class="docutils literal notranslate"><span class="pre">sub</span> <span class="pre">vcl_miss</span></code> will be called, and a fetch for a new object will be
initiated.</p>
</section>
<section id="misbehaving-servers">
<h2>Misbehaving servers<a class="headerlink" href="#misbehaving-servers" title="Link to this heading">¶</a></h2>
<p>A key feature of Varnish is its ability to shield you from misbehaving
web- and application servers.</p>
<p>If you have enabled <a class="reference internal" href="vcl-backends.html#users-guide-advanced-backend-servers-health"><span class="std std-ref">Health checks</span></a>
you can check if the backend is sick and modify the behavior when it
comes to grace. This can done in the following way:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sub</span> <span class="n">vcl_backend_response</span> <span class="p">{</span>
     <span class="nb">set</span> <span class="n">beresp</span><span class="o">.</span><span class="n">grace</span> <span class="o">=</span> <span class="mi">24</span><span class="n">h</span><span class="p">;</span>
     <span class="o">//</span> <span class="n">no</span> <span class="n">keep</span> <span class="o">-</span> <span class="n">the</span> <span class="n">grace</span> <span class="n">should</span> <span class="n">be</span> <span class="n">enough</span> <span class="k">for</span> <span class="mi">304</span> <span class="n">candidates</span>
<span class="p">}</span>

<span class="n">sub</span> <span class="n">vcl_recv</span> <span class="p">{</span>
     <span class="k">if</span> <span class="p">(</span><span class="n">std</span><span class="o">.</span><span class="n">healthy</span><span class="p">(</span><span class="n">req</span><span class="o">.</span><span class="n">backend_hint</span><span class="p">))</span> <span class="p">{</span>
          <span class="o">//</span> <span class="n">change</span> <span class="n">the</span> <span class="n">behavior</span> <span class="k">for</span> <span class="n">healthy</span> <span class="n">backends</span><span class="p">:</span> <span class="n">Cap</span> <span class="n">grace</span> <span class="n">to</span> <span class="mi">10</span><span class="n">s</span>
          <span class="nb">set</span> <span class="n">req</span><span class="o">.</span><span class="n">grace</span> <span class="o">=</span> <span class="mi">10</span><span class="n">s</span><span class="p">;</span>
     <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>In the example above, the special variable <code class="docutils literal notranslate"><span class="pre">req.grace</span></code> is set.  The
effect is that, when the backend is healthy, objects with grace above
10 seconds will have an <cite>effective</cite> grace of 10 seconds.  When the
backend is sick, the default VCL kicks in, and the long grace is used.</p>
<p>Additionally, you might want to stop cache insertion when a backend fetch
returns an <code class="docutils literal notranslate"><span class="pre">5xx</span></code> error:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sub</span> <span class="n">vcl_backend_response</span> <span class="p">{</span>
     <span class="k">if</span> <span class="p">(</span><span class="n">beresp</span><span class="o">.</span><span class="n">status</span> <span class="o">&gt;=</span> <span class="mi">500</span> <span class="o">&amp;&amp;</span> <span class="n">bereq</span><span class="o">.</span><span class="n">is_bgfetch</span><span class="p">)</span> <span class="p">{</span>
          <span class="k">return</span> <span class="p">(</span><span class="n">abandon</span><span class="p">);</span>
     <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Link to this heading">¶</a></h2>
<p>Grace mode allows Varnish to deliver slightly stale content to clients
while getting a fresh version from the backend. The result is faster
load times at lower cost.</p>
<p>It is possible to limit the grace during lookup by setting
<code class="docutils literal notranslate"><span class="pre">req.grace</span></code> and then change the behavior when it comes to
grace. Often this is done to change the <cite>effective</cite> grace depending on
the health of the backend.</p>
</section>
</section>

<div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
<li><a class="reference internal" href="#">Grace mode and keep</a><ul>
<li><a class="reference internal" href="#grace-mode">Grace mode</a></li>
<li><a class="reference internal" href="#keep">Keep</a></li>
<li><a class="reference internal" href="#setting-grace-and-keep">Setting grace and keep</a></li>
<li><a class="reference internal" href="#the-effect-of-grace-and-keep">The effect of grace and keep</a></li>
<li><a class="reference internal" href="#misbehaving-servers">Misbehaving servers</a></li>
<li><a class="reference internal" href="#summary">Summary</a></li>
</ul>
</li>
</ul>

</div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="vcl-hashing.html"
                          title="previous chapter">Hashing</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="vcl-separate.html"
                          title="next chapter">Separate VCL files</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/users-guide/vcl-grace.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="vcl-separate.html" title="Separate VCL files"
             >next</a> |</li>
        <li class="right" >
          <a href="vcl-hashing.html" title="Hashing"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Varnish version 7.5.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >The Varnish Users Guide</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="vcl.html" >VCL - Varnish Configuration Language</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Grace mode and keep</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2010-2014, Varnish Software AS.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
    </div>
  </body>
</html>

❌ Cancel

🗂️ Enhanced PHP File Manager

📊 Server Information

🔧 Quick Actions

✏️ Editing: vcl-grace.html

📤 Upload File

📁 Create Folder

📄 Create File

✏️ Rename Item

🗑️ Delete Confirmation