Serverless App Engine:PHP runtime environment

Overview

Web applications: NGINX and PHP-FPM

Application monitoring: ARMS

You can use Application Real-Time Monitoring Service (ARMS) to monitor SAE applications that run PHP of a version between 5.4 and 7.3. ARMS allows you to obtain application information, such as application traces, and the latency when you access ApsaraDB RDS for MySQL resources and Tair (Redis OSS-Compatible) resources. For more information, see ARMS overview.

PHP runtime environments

Software versions

The following table describes the available PHP runtime environments. If you require an environment of later versions, submit a ticket or join the DingTalk group 32874633 for technical support.

Default Directories

SAE allows you to deploy application packages in PHP runtime environments by using the following directories.

The following table describes the default configurations of PHP-FPM.

The following table describes the default configurations of NGINX.

Built-in extensions

Related permissions

By default, PHP-FPM and NGINX use the www-data user to run applications. The following table describes the permissions.

www-data www-data

www-data www-data

root root

drwxrwxrwx 2 root root 4096 May 13  2021 nginx
drwxrwxrwx 1 root root 4096 Apr  8 11:45 php

Support for PHP extensions

Default and PECL extensions

You can configure the php.ini file to specify built-in extensions when you deploy an application, including the default PHP extensions and PECL extensions. For more information, see Configure a configuration file for a PHP application.

php -m

Examples of built-in extensions supported by different runtime environments:

Install extensions by using the console or API

You can enable the default PHP extensions or install specific PECL extensions in the SAE console or by calling the API based on your business requirements. For more information, see Deploy a PHP application by using a ZIP package in the SAE console.

Install third-party extensions

This section describes how to install a third-party extension by compiling the YAML file that contains the source code in PHP-FPM 7.3.

1. Create an SAE application that runs in PHP 7.3.

2. Allow the application to access the Internet.

3. Log on to the instance by using the webshell, and run the following command to compile and install the extension:

   # Obtain the source code.
   wget https://pecl.php.net/get/yaml-2.2.2.tgz
   tar -zxvf yaml-2.2.2.tgz
   # Compile and install the extension.
   cd yaml-2.2.2 && \
   phpize && \
   ./configure && \
   make && make install

4. Download the extension to your on-premises machine. For more information, see Upload and download logs to check the health status of applications.

   The directory of the extension:

   /home/admin/yaml-2.2.2/modules/yaml.so

5. Include the extension in the ZIP package of the application. ZIP package structure:

   .
   ├── nginx
   │   ├── default.conf
   │   ├── fastcgi_params
   │ ├── global
   │ └── root.dir
   ├── php
   │   ├── index.php
   └── extensions
       └── yaml.so

6. Deploy the application, upload the ZIP package that contains the extension, and then add the extension configuration to the php.ini file to enable the extension.

   extension=/home/admin/app/extensions/yaml.so

7. Log on to the instance by using the webshell and check whether the extension is loaded.

   # php -m | grep yaml
   yaml

Extension enhancement

PHP can optimize the following extensions: WebP, JPEG, PNG, zlib, XPM, and FreeType. For more information, see Image Processing and GD.

Common configurations

Default service ports

The following table describes the default service ports that are configured in SAE for NGINX and PHP-FPM.

PHP-FPM logs: standard output

• PHP-FPM logs are contained in real-time logs. The following sample code provides an example of the log configurations. The configuration file is stored in the /usr/local/etc/php-fpm.d/docker.conf directory.

  [global]
  error_log = /proc/self/fd/2
  log_limit = 8192
  
  [www]
  access.log = /proc/self/fd/2

• The PHP error logs that are not displayed. The following sample code provides an example of the log configuration in the php.ini file.

  error_log => no value => no value
  log_errors => Off => Off
  log_errors_max_len => 1024 => 1024

• If you want to include the error logs in real-time logs, you must configure the php.ini file when you create or deploy an application. You must specify the following directory to store the error logs.

  log_errors = on
  error_log = /proc/self/fd/2

NGINX logs: standard output

• NGINX logs are contained in real-time logs. The following sample code provides an example of the log configurations. The configuration file is stored in the ./nginx/default.conf directory.

  #access_log /dev/stdout;
  error_log stderr;

• You can configure access_log to determine whether to include access logs in the real-time logs.

File caching: static files, images, and media

; Enable OPcache.
opcache.enable=1
; Disable OPcache.
;opcache.enable=0

File caching: PHP code

You can enable or disable caching in NGINX for a large number of static files, such as images, videos, Cascading Style Sheets (CSS) files, and JavaScript files. For more information, see the sample code and Module ngx_http_headers_module.

• Enable static resource caching: This option is suitable for online services and websites that load a large number of media files. This improves traffic throughput and reduces read input/output operations per second (IOPS).

• Disable static resource caching: This option is suitable for remote debugging, upload and download, and other usage scenarios. You can access the files in real time.

    # Static resource caching
    location ~* \.(?:jpg|jpeg|gif|png|ico|cur|gz|svg|svgz|mp4|ogg|ogv|webm|htc)$ {
        # Disable caching.
        #expires off;
        # Enable caching.
        expires 1s;
    }

Enhancement

Hot restart

• ConfigMap allows you to modify the configurations without interrupting services.

• Webshell allows you to restart services without interrupting services.

  • Hot restart of NGINX

    # Check the validity of the configuration file.
    nginx -t
    # Restart NGINX without service interruptions.
    nginx -s reload

  • Hot restart of PHP-FPM (The services may be interrupted. You must make sure that the php.ini file is valid.)

    ps uax | grep 'php-fpm: master' | grep -v grep | awk '{print $2}' | xargs kill -USR2

Upload and download

SAE provides multiple methods to allow you to upload and download files. You can select one of the following methods based on your business requirements.

• Use the SAE console: You can upload and download files whose size does not exceed 10 MB for debugging.

  For more information, see Use the webshell feature to upload and download files.

• Use the SAE console: You can perform remote debugging.

• Use the persistence storage: File Storage NAS or Object Storage Service (OSS).

  • When you deploy an application, you can mount NAS or OSS and share file directories.

  • Upload and download files in NAS: You can use Serverless Devs.

  • Upload and download files in OSS: You can use the OSS console.

  • Upload and download files in OSS: You can use ossutil.