Using Nginx FastCGI Cache

FastCGI Cache  is a data caching system implemented at the Nginx HTTP server level  .

The advantage of  FastCGI Cache  is that Nginx will return the cached response to the user as soon as it receives a request, while the application layer will not process the incoming HTTP request at all if it is in the Nginx cache. 

Using FastCGI Cache is a great way to reduce the load on your system.

If your site has pages that rarely change or the delay in updating information for a while is not critical, then FastCGI Cache is exactly what you need.

How Nginx FastCGI Cache works

If an HTTP request came to the Nginx server and some time ago the response to the same request was placed in the cache, then Nginx will not send this request to execute PHP-FPM, instead of this Nginx will return the result from the cache.

Task

Suppose we have a web-based control system for a flight to the moon, which is written in PHP. Each user must enter their username and password to enter the system and be on the main page of the space application. 

, , . . . SQL- .

, , . 

, , . .

?

  • , .

  • -. .

  • 1 .

 

:

http {

    include /etc/nginx/mime.types;

    server {
    
        listen 80;
        index index.php index.html;
        server_name moon-flight.aero;
        error_log /var/log/nginx/moon-flight.aero.error.log;
        access_log /var/log/nginx/moon-flight.aero.access.log
        root /var/www/moon-flight.aero/public;

        location / {
            try_files $uri $uri/ /index.php?$query_string;
        }

        location ~ \.php$ {
            try_files $uri =404;
            fastcgi_split_path_info ^(.+\.php)(/.+)$;
            fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
            fastcgi_index index.php;
            include fastcgi_params;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_param PATH_INFO $fastcgi_script_name;
        }
    }
}

, fastcgi_cache_path   http.

fastcgi_cache_path /tmp/nginx_cache levels=1:2 keys_zone=fastcgicache:10m inactive=70m max_size=512m;

 /tmp/nginx_cache  , .  /tmp  , . , ,  /tmp/nginx_cache  .

β€” .  levels=1:2. ,  2. , , .

β€” . keys_zone=fastcgicache:10m ,  fastcgicache,  10m β€” . 10 80 000 . , .

β€” inactive=70m,  , , , . , ,  inactive, , .  inactive  10 .

 max_size=512m β€” . . , Nginx .

.  fastcgi_cache_key.  httpserver  location.

 server  fastcgi_cache_key:

fastcgi_cache_key "$scheme$request_method$host$request_uri$cookie_codeAuth";

:

β€” $scheme 

β€” $request_method

β€” $host

β€” $request_uri

β€” $cookie_codeAuth

. , . 

, :

http://moon-flight.aero/search/?query=10

 Nginx  :

$scheme

http

$request_method

GET

$host

moon-flight.aero

$request_uri

/search/?query=10

$cookie_codeAuth

Cookie codeAuth, . Cookie -.

, Cookie  codeAuth. 

Nginx Cookie, $cookie_.

, HTTP- :

Cookie: codeAuth=a7e30fbb7f4513redfd22049c6b5dzme306f4e

 "$scheme$request_method$host$request_uri$cookie_codeAuth" ,   , .  $cookie_codeAuth  .

 server   fastcgi_cachefastcgi_cache_validfastcgi_cache_bypass  fastcgi_no_cache   location.

 server.

:

  • ,  $request_uri  "/".

  •  GET  .  $request_method   GET.

  • ,  GET .  $query_string   "".

 3  (  server):

set $no_cache 0;

if ($request_method != GET) {
     set $no_cache 1;
}

if ($query_string != "") {
     set $no_cache 1;
}

if ($request_uri != "/") {
     set $no_cache 1;
}

fastcgi_cache, fastcgi_cache_valid, fastcgi_cache_bypass fastcgi_no_cache  location.

fastcgi_cache fastcgicache;
fastcgi_cache_valid 200 60m;
fastcgi_cache_bypass $no_cache;
fastcgi_no_cache $no_cache;

?

fastcgi_cache β€” , .  fastcgi_cache_path.

fastcgi_cache_valid β€” HTTP- . 60 200.

fastcgi_cache_bypass β€” , .  0, .

fastcgi_no_cache β€” , .  0, .

:

sudo service nginx reload

.

, ?

. ,  $upstream_cache_status

 server   add_header  :

add_header x-fastcgi-cache $upstream_cache_status;

x-fastcgi-cache β€” . 

 $upstream_cache_status  : 

  • MISS

  • BYPASS

  • EXPIRED

  • STALE

  • UPDATING

  • REVALIDATED

  • HIT

,  HIT.

:

http {

    include /etc/nginx/mime.types;
    
    fastcgi_cache_path /tmp/nginx_cache levels=1:2 keys_zone=fastcgicache:10m inactive=70m max_size=512m;

    server {
    
        listen 80;
        index index.php index.html;
        server_name moon-flight.aero;
        error_log /var/log/nginx/moon-flight.aero.error.log;
        access_log /var/log/nginx/moon-flight.aero.access.log
        root /var/www/moon-flight.aero/public;
        
        fastcgi_cache_key "$scheme$request_method$host$request_uri$cookie_codeAuth";
        
        set $no_cache 0;

        if ($request_method != GET) {
            set $no_cache 1;
        }

        if ($query_string != "") {
            set $no_cache 1;
        }
    
        if ($request_uri != "/") {
            set $no_cache 1;
        }

        location / {
            try_files $uri $uri/ /index.php?$query_string;
        }
        
        add_header x-fastcgi-cache $upstream_cache_status;

        location ~ \.php$ {
        
            fastcgi_cache fastcgicache;
            fastcgi_cache_valid 200 60m;
            fastcgi_cache_bypass $no_cache;
            fastcgi_no_cache $no_cache;
        
            try_files $uri =404;
            fastcgi_split_path_info ^(.+\.php)(/.+)$;
            fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
            fastcgi_index index.php;
            include fastcgi_params;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_param PATH_INFO $fastcgi_script_name;
        }
    }
}

 

Nginx :

sudo nginx -t

, , :

sudo service nginx reload

Apache Bench

Apache Bench -. C Apache Bench , . cookies.

Apache Bench Ununtu.

:

sudo apt-get update

:

sudo apt-get install apache2-utils

.

Apache Bench

FastCGI Cache $no_cache 1.

sudo service nginx reload

. , Apache Bench :

ab -c 5 -n 100 -C "codeAuth=a7e30fbb7f4513redfd22049c6b5dzme306f4e" http://moon-flight.aero

http://moon-flight.aero 100 , 5 . -C , cookie codeAuth.

:

This is ApacheBench, Version 2.3 <$Revision: 1843412 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking moon-flight.aero (be patient).....done


Server Software:        nginx/1.14.0
Server Hostname:        moon-flight.aero
Server Port:            80

Document Path:          /
Document Length:        31134 bytes

Concurrency Level:      5
Time taken for tests:   2.978 seconds
Complete requests:      100
Failed requests:        0
Total transferred:      3150400 bytes
HTML transferred:       3113400 bytes
Requests per second:    33.58 [#/sec] (mean)
Time per request:       148.878 [ms] (mean)
Time per request:       29.776 [ms] (mean, across all concurrent requests)
Transfer rate:          1033.25 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:       23   29   5.0     27      50
Processing:    58  112  17.1    113     142
Waiting:       58  112  17.0    113     142
Total:         85  141  16.7    142     176

Percentage of the requests served within a certain time (ms)
  50%    142
  66%    149
  75%    154
  80%    159
  90%    163
  95%    166
  98%    170
  99%    176
 100%    176 (longest request)

3 , 100 . β€” 33.58 .

Apache Bench

$no_cache 0.

sudo service nginx reload

:

ab -c 5 -n 100 -C "codeAuth=a7e30fbb7f4513redfd22049c6b5dzme306f4e" http://moon-flight.aero

:

This is ApacheBench, Version 2.3 <$Revision: 1843412 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking moon-flight.aero (be patient).....done


Server Software:        nginx/1.14.0
Server Hostname:        moon-flight.aero
Server Port:            80

Document Path:          /
Document Length:        31134 bytes

Concurrency Level:      5
Time taken for tests:   1.068 seconds
Complete requests:      100
Failed requests:        0
Total transferred:      3150104 bytes
HTML transferred:       3113400 bytes
Requests per second:    93.64 [#/sec] (mean)
Time per request:       53.398 [ms] (mean)
Time per request:       10.680 [ms] (mean, across all concurrent requests)
Transfer rate:          2880.52 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:       23   31   6.5     27      47
Processing:    14   17   7.8     16      93
Waiting:       14   17   7.8     16      93
Total:         37   47  10.1     44     122

Percentage of the requests served within a certain time (ms)
  50%     44
  66%     49
  75%     52
  80%     54
  90%     56
  95%     61
  98%     63
  99%    122
 100%    122 (longest request)

1 , 100 . β€” 93.64 .


:

Description of the ngx_http_fastcgi_module module is   available at the link: http://nginx.org/ru/docs/http/ngx http fastcgi_module.html

Video on how to set up FastCGI Cache Nginx: https://www.youtube.com/watch?v=Nri2KOI3HJo&t=66s

Apache Bench Documentation: https://httpd.apache.org/docs/2.4/programs/ab.html




All Articles