搬磚PHP-FPM的預設配置

so_easy發表於2020-09-10
PHP
系列文章：
(MAC) PHP安裝和配置 PHP編譯安裝之Configure引數 (MAC) PHP擴充套件安裝 PHP-FPM和nginx配置 搬磚PHP-FPM的預設配置

前言

並沒有做過多的解釋，只是把預設的PHP-FPM配置項搬過來了。

開始

（1）可以配置的屬性如下描述的：

; Per pool prefix
; It only applies on the following directives:
; - 'access.log' 
; - 'slowlog'
; - 'listen' (unixsocket)
; - 'chroot'
; - 'chdir'
; - 'php_values'
; - 'php_admin_values'
; When not set, the global prefix (or /usr) applies instead.
; Note: This directive can also be relative to the global prefix.
; Default Value: none
;prefix = /path/to/pools/$pool

listen配置

  1. listen預設是listen = 127.0.0.1:9000。這個屬性的配置在nginx中對應的是fastcgi_pass。listen的配置介紹是：

    ; The address on which to accept FastCGI requests.
; Valid syntaxes are:
;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific IPv4 address on
;                            a specific port;
;   '[ip\:6\:addr\:ess]:port' - to listen on a TCP socket to a specific IPv6 address on
;                            a specific port;
;   'port'                 - to listen on a TCP socket to all IPv4 addresses on a
;                            specific port;
;   '[::]:port'            - to listen on a TCP socket to all addresses
;                            (IPv6 and IPv4-mapped) on a specific port;
;   '/path/to/unix/socket' - to listen on a unix socket.
; Note: This value is mandatory.

    可以支援的格式有：ip:port，ip6:port，port，[::]:port和 /path/to/unix/socket。如果是本地配置的話首選socket，因為速度最快。如果選用ip:port則可以將請求轉發到IP所在的伺服器響應。配合在nginx中配置upstream模組可以實現負載均衡。

  1. listen其他的一些配置
; Set listen(2) backlog.
; Default Value: 65535 (-1 on FreeBSD and OpenBSD)
; listen.backlog = 65535

; Set permissions for unix socket, if one is used. In Linux, read/write
; permissions must be set in order to allow connections from a web server. Many
; BSD-derived systems allow connections regardless of permissions. 
; Default Values: user and group are set as the running user
;                 mode is set to 0660
;listen.owner = nobody
;listen.group = nobody
;listen.mode = 0660

; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect.
; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
; must be separated by a comma. If this value is left blank, connections will be
; accepted from any ip address.
; Default Value: any
;listen.allowed_clients = 127.0.0.1

  • listen.backlog = 65535：

    如果是web請求涉及到讀寫那麼必須設定許可權，預設是啟動的使用者和使用者組，讀寫許可權是0660。

  • listen.owner = nobody：設定unix socket的可讀寫使用者。

  • listen.group = nobody：設定unix socket的可讀寫使用者組。

  • listen.mode = 0660：設定unix socket的可讀寫許可權

  • listen.allowed_clients = 127.0.0.1：限制可訪問的IP。預設值是any，允許任何IP源的請求。

    pm模組

    pm模組的調優可以參考為高效能最佳化 PHP-FPM
    我只是做一個預設配置的搬磚者而已！

  1. pm相關配置介紹如下
    ; Choose how the process manager will control the number of child processes.
; Possible Values:
;   static  - a fixed number (pm.max_children) of child processes;
;   dynamic - the number of child processes are set dynamically based on the
;             following directives. With this process management, there will be
;             always at least 1 children.
;             pm.max_children      - the maximum number of children that can
;                                    be alive at the same time.
;             pm.start_servers     - the number of children created on startup.
;             pm.min_spare_servers - the minimum number of children in 'idle'
;                                    state (waiting to process). If the number
;                                    of 'idle' processes is less than this
;                                    number then some children will be created.
;             pm.max_spare_servers - the maximum number of children in 'idle'
;                                    state (waiting to process). If the number
;                                    of 'idle' processes is greater than this
;                                    number then some children will be killed.
;  ondemand - no children are created at startup. Children will be forked when
;             new requests will connect. The following parameter are used:
;             pm.max_children           - the maximum number of children that
;                                         can be alive at the same time.
;             pm.process_idle_timeout   - The number of seconds after which
;                                         an idle process will be killed.
; Note: This value is mandatory.
pm = dynamic
    pm可選值：static、dynamic、ondemand。
    預設配置中的值是dynamic。所以還得參考如下配置：
  • pm.max_children = 5：最多多少個子程式同時存活
  • pm.start_servers = 2：剛啟動的時候啟動的子程式數量
  • pm.min_spare_servers = 1：空閒時最少有多少個子程式存在。如果當前少於這個程式數量就會啟動部分子程式。
  • pm.max_spare_servers = 3：空閒時最多有多少個子程式存在。如果當前多餘這個程式數量部分子程式就會被殺死。
    注意dynamic的註釋提到：子程式的管理會根據以下配置作為參考，但是至少是有一個子程式的。

static：固定的子程式數量。
ondemand：開始沒子程式，隨著請求的數量而啟動子程式。受pm.max_children和pm.process_idle_timeout影響。

ondemand配置

; The number of seconds after which an idle process will be killed.
; Note: Used only when pm is set to 'ondemand'
; Default Value: 10s
;pm.process_idle_timeout = 10s;

; The number of requests each child process should execute before respawning.
; This can be useful to work around memory leaks in 3rd party libraries. For
; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
; Default Value: 0
; pm.max_requests = 500
  • pm.process_idle_timeout = 10s：子程式空閒時間超過10s子程式就會被殺死。pm是ondemand才有效。
  • pm.max_requests = 500：最大同時存活的子程式數量，0表示無限大。對於第三方庫可能存在記憶體洩露是個不錯的方案。

pm.status_path配置

由於預設的介紹過多，所以儘量搬少一點。

; Default Value: not set 
; pm.status_path = /status
  • pm.status_path：記錄處理請求的狀態到指定的檔案，預設不設定。必須以/開頭，且最好別以.php結尾，防止和真正的php指令碼混合。可以以json、xml、html的格式輸出，預設text/plain。在請求的後面增加請求格式，如：www.foo.bar/status?json ，還可以增加引數full獲取更詳細的值如：www.foo.bar/status?json&full

不帶full引數輸出的值如下介紹：

;   pool                 - the name of the pool;
;   process manager      - static, dynamic or ondemand;
;   start time           - the date and time FPM has started;
;   start since          - number of seconds since FPM has started;
;   accepted conn        - the number of request accepted by the pool;
;   listen queue         - the number of request in the queue of pending
;                          connections (see backlog in listen(2));
;   max listen queue     - the maximum number of requests in the queue
;                          of pending connections since FPM has started;
;   listen queue len     - the size of the socket queue of pending connections;
;   idle processes       - the number of idle processes;
;   active processes     - the number of active processes;
;   total processes      - the number of idle + active processes;
;   max active processes - the maximum number of active processes since FPM
;                          has started;
;   max children reached - number of times, the process limit has been reached,
;                          when pm tries to start more children (works only for
;                          pm 'dynamic' and 'ondemand');

帶full引數輸出如下：

;   pid                  - the PID of the process;
;   state                - the state of the process (Idle, Running, ...);
;   start time           - the date and time the process has started;
;   start since          - the number of seconds since the process has started;
;   requests             - the number of requests the process has served;
;   request duration     - the duration in µs of the requests;
;   request method       - the request method (GET, POST, ...);
;   request URI          - the request URI with the query string;
;   content length       - the content length of the request (only with POST);
;   user                 - the user (PHP_AUTH_USER) (or '-' if not set);
;   script               - the main script called (or '-' if not set);
;   last request cpu     - the %cpu the last request consumed
;                          it's always 0 if the process is not in Idle state
;                          because CPU calculation is done when the request
;                          processing has terminated;
;   last request memory  - the max amount of memory the last request consumed
;                          it's always 0 if the process is not in Idle state
;                          because memory calculation is done when the request
;                          processing has terminated;

ping 相關配置

; The ping URI to call the monitoring page of FPM. If this value is not set, no
; URI will be recognized as a ping page. This could be used to test from outside
; that FPM is alive and responding, or to
; - create a graph of FPM availability (rrd or such);
; - remove a server from a group if it is not responding (load balancing);
; - trigger alerts for the operating team (24/7).
; Note: The value must start with a leading slash (/). The value can be
;       anything, but it may not be a good idea to use the .php extension or it
;       may conflict with a real PHP file.
; Default Value: not set
; ping.path = /ping

; This directive may be used to customize the response of a ping request. The
; response is formatted as text/plain with a 200 response code.
; Default Value: pong
; ping.response = pong
  • ping.path = /ping：用來監控FPM是否存活，預設是不設定。
  • ping.response = pong：定製ping的輸出

access.log和slowlog

; Default: not set
;access.log = log/$pool.access.log

; Default: "%R - %u %t \"%m %r\" %s"
;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%"

; The log file for slow requests
; Default Value: not set
; Note: slowlog is mandatory if request_slowlog_timeout is set
;slowlog = log/$pool.log.slow

; The timeout for serving a single request after which a PHP backtrace will be
; dumped to the 'slowlog' file. A value of '0s' means 'off'.
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
; Default Value: 0
;request_slowlog_timeout = 0
  • access.log：支援很多種的佔位符。具體先不貼上了，篇幅有限。
  • slowlog = log/$pool.log.slow：請求超時會被記錄到這裡，需要配置request_slowlog_timeout才有效。
  • request_slowlog_timeout = 0：設定請求超時的時間，單位是： s(econds)(default), m(inutes), h(ours), or d(ays)

request_terminate_timeout

; The timeout for serving a single request after which the worker process will
; be killed. This option should be used when the 'max_execution_time' ini option
; does not stop script execution for some reason. A value of '0' means 'off'.
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
; Default Value: 0
;request_terminate_timeout = 0
  • request_terminate_timeout = 0：如果某個請求超時則將此程式殺死，特別是用在配置了max_execution_time屬性但是卻不知道什麼原因導致程式無法結束的情況下。預設是0，不啟用。

rlimit_files 和 rlimit_core

; Set open file descriptor rlimit.
; Default Value: system defined value
;rlimit_files = 1024

; Set max core size rlimit.
; Possible Values: 'unlimited' or an integer greater or equal to 0
; Default Value: system defined value
;rlimit_core = 0
  • rlimit_files = 1024：設定開啟檔案描述符的限制，預設是系統的值。
  • rlimit_core = 0：設定檔案最大佔用限制，預設是系統的值。

chroot

; Chroot to this directory at the start. This value must be defined as an
; absolute path. When this value is not set, chroot is not used.
; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
; of its subdirectories. If the pool prefix is not set, the global prefix
; will be used instead.
; Note: chrooting is a great security feature and should be used whenever 
;       possible. However, all PHP paths will be relative to the chroot
;       (error_log, sessions.save_path, ...).
; Default Value: not set
;chroot =
  • chroot：把根目錄換成指定的目的目錄，必須是一個絕對路徑。可以使用$pool或$prefix變數。

chdir

; Chdir to this directory at the start.
; Note: relative path can be used.
; Default Value: current directory or / when chroot
;chdir = /var/www
  • chdir：改變當前目錄，類似cd。預設值就是當前路徑。如果啟用chroot那麼就是/。

catch_workers_output

; Redirect worker stdout and stderr into main error log. If not set, stdout and
; stderr will be redirected to /dev/null according to FastCGI specs.
; Note: on highloaded environement, this can cause some delay in the page
; process time (several ms).
; Default Value: no
;catch_workers_output = yes
  • catch_workers_output = yes：預設是no。不設定則將錯誤和輸出拋棄，設定則寫入main error log。

environment相關

; Clear environment in FPM workers
; Prevents arbitrary environment variables from reaching FPM worker processes
; by clearing the environment in workers before env vars specified in this
; pool configuration are added.
; Setting to "no" will make all environment variables available to PHP code
; via getenv(), $_ENV and $_SERVER.
; Default Value: yes
;clear_env = no

; Limits the extensions of the main script FPM will allow to parse. This can
; prevent configuration mistakes on the web server side. You should only limit
; FPM to .php extensions to prevent malicious users to use other extensions to
; exectute php code.
; Note: set an empty value to allow all extensions.
; Default Value: .php
;security.limit_extensions = .php .php3 .php4 .php5

; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
; the current environment.
; Default Value: clean env
;env[HOSTNAME] = $HOSTNAME
;env[PATH] = /usr/local/bin:/usr/bin:/bin
;env[TMP] = /tmp
;env[TMPDIR] = /tmp
;env[TEMP] = /tmp
  • clear_env = no：預設值是yes。開啟的情況下使子程式可以獲取到getenv，$_ENV，$_SERVER的值。
  • security.limit_extensions = .php .php3 .php4 .php5：預設值是.php。限制FPM可以解析的指令碼格式，如果設定為空表示可以解析所有格式的檔案。主要目的是限制惡意使用者透過一些擴充套件執行其他指令碼。
  • env：設定環境變數，預設是不設定。

其他一些php.ini的配置

; Additional php.ini defines, specific to this pool of workers. These settings
; overwrite the values previously defined in the php.ini. The directives are the
; same as the PHP SAPI:
;   php_value/php_flag             - you can set classic ini defines which can
;                                    be overwritten from PHP call 'ini_set'. 
;   php_admin_value/php_admin_flag - these directives won't be overwritten by
;                                     PHP call 'ini_set'
; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.

; Defining 'extension' will load the corresponding shared extension from
; extension_dir. Defining 'disable_functions' or 'disable_classes' will not
; overwrite previously defined php.ini values, but will append the new value
; instead.

; Note: path INI options can be relative and will be expanded with the prefix
; (pool, global or /usr)

; Default Value: nothing is defined by default except the values in php.ini and
;                specified at startup with the -d argument
;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
;php_flag[display_errors] = off
;php_admin_value[error_log] = /var/log/fpm-php.www.log
;php_admin_flag[log_errors] = on
;php_admin_value[memory_limit] = 32M

定義一些和php.ini配置相關的屬性，只對當前的子程式起作用。相關的配置會覆蓋php.ini的配置。

  • php_value/php_flag：可以被ini_set重定義。
  • php_admin_value/php_admin_flag：不可被ini_set重定義。不會覆蓋

    注意：php_*flag能夠接受的值：on, off, 1, 0, true, false, yes or no. 如果定義extension會從extension_dir讀取擴充套件。如果定義disable_functions或者disable_classes不會覆蓋原來的設定，但是會在原來的基礎上追加。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章