├── app-log-php-fpm-via-unix-pipe
    ├── bootstrap-php-log-tail.sh
    ├── Dockerfile-php-log-tail
    ├── nginx.conf
    ├── bootstrap-php-fpm.sh
    ├── index.php
    ├── Dockerfile-nginx
    ├── nginx-vhost.conf
    ├── docker-compose.yml
    └── Dockerfile-php
├── app-log-php-fpm-via-catch-workers-output
    ├── nginx.conf
    ├── index.php
    ├── Dockerfile-nginx
    ├── docker-compose.yml
    ├── nginx-vhost.conf
    └── Dockerfile-php
└── README.md


/app-log-php-fpm-via-unix-pipe/bootstrap-php-log-tail.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # Wait until the pipe - created by the PHP app container
 4 | # and shared via a tmp volume - is created
 5 | while [ ! -e /var/log/shared/pipe-from-app-to-stdout ]; do
 6 |     sleep 0.2
 7 | done
 8 | 
 9 | exec tail -f /var/log/shared/pipe-from-app-to-stdout
10 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/Dockerfile-php-log-tail:
--------------------------------------------------------------------------------
 1 | FROM alpine:3.8
 2 | 
 3 | # Create the directory that will hold the (shared) unix pipe
 4 | RUN mkdir /var/log/shared
 5 | 
 6 | # Add bootstrap script
 7 | ADD bootstrap-php-log-tail.sh /usr/local/bin/bootstrap-php-log-tail.sh
 8 | 
 9 | CMD [ "/usr/local/bin/bootstrap-php-log-tail.sh" ]
10 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/nginx.conf:
--------------------------------------------------------------------------------
 1 | # This is NOT a production-grade nginx vhost config. Do NOT use it in
 2 | # production. It's just the minimal setup to test PHP logging.
 3 | daemon off;
 4 | 
 5 | error_log /dev/stderr error;
 6 | 
 7 | events {
 8 |     worker_connections 1024;
 9 | }
10 | 
11 | http {
12 |     access_log /dev/stdout;
13 |     include sites-enabled/*.conf;
14 | }
15 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-catch-workers-output/nginx.conf:
--------------------------------------------------------------------------------
 1 | # This is NOT a production-grade nginx vhost config. Do NOT use it in
 2 | # production. It's just the minimal setup to test PHP logging.
 3 | daemon off;
 4 | 
 5 | error_log /dev/stderr error;
 6 | 
 7 | events {
 8 |     worker_connections 1024;
 9 | }
10 | 
11 | http {
12 |     access_log /dev/stdout;
13 |     include sites-enabled/*.conf;
14 | }
15 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/bootstrap-php-fpm.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | # Create a pipe used by the PHP app to write logs
 4 | if [ ! -p /var/log/shared/pipe-from-app-to-stdout ]; then
 5 |     mkfifo      /var/log/shared/pipe-from-app-to-stdout
 6 |     chmod 777   /var/log/shared/pipe-from-app-to-stdout
 7 | fi
 8 | 
 9 | exec php-fpm7 --fpm-config /etc/php7/php-fpm.conf --php-ini /etc/php7/php.ini
10 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-catch-workers-output/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Log a message longer than 1024 chars to stdout
 4 | file_put_contents("php://stdout", str_repeat("0", 1020) .  "Log message to stdout\n");
 5 | 
 6 | // Log a message to stderr
 7 | file_put_contents("php://stderr", "Log message to stderr\n");
 8 | 
 9 | // Send response
10 | header('Content-Type: text/plain');
11 | echo "This is the HTTP response content.";
12 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Log a message longer than 1024 chars
 4 | file_put_contents("/var/log/shared/pipe-from-app-to-stdout", str_repeat("0", 1020) .  " Log message\n");
 5 | 
 6 | // Log a shorter message
 7 | file_put_contents("/var/log/shared/pipe-from-app-to-stdout", "Log message\n");
 8 | 
 9 | // Send response
10 | header('Content-Type: text/plain');
11 | echo "This is the HTTP response content.";
12 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/Dockerfile-nginx:
--------------------------------------------------------------------------------
 1 | FROM alpine:3.8
 2 | 
 3 | # Install nginx
 4 | RUN apk add --update --no-cache nginx && \
 5 |     mkdir -p /run/nginx
 6 | 
 7 | # Add nginx config files
 8 | ADD nginx.conf          /etc/nginx/nginx.conf
 9 | ADD nginx-vhost.conf    /etc/nginx/sites-enabled/nginx-vhost.conf
10 | 
11 | # Add application code
12 | ADD index.php /app/index.php
13 | 
14 | CMD [ "nginx", "-c", "/etc/nginx/nginx.conf" ]
15 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-catch-workers-output/Dockerfile-nginx:
--------------------------------------------------------------------------------
 1 | FROM alpine:3.8
 2 | 
 3 | # Install nginx
 4 | RUN apk add --update --no-cache nginx && \
 5 |     mkdir -p /run/nginx
 6 | 
 7 | # Add nginx config files
 8 | ADD nginx.conf          /etc/nginx/nginx.conf
 9 | ADD nginx-vhost.conf    /etc/nginx/sites-enabled/nginx-vhost.conf
10 | 
11 | # Add application code
12 | ADD index.php /app/index.php
13 | 
14 | CMD [ "nginx", "-c", "/etc/nginx/nginx.conf" ]
15 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-catch-workers-output/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | version: '3.2'
 2 | services:
 3 |   nginx:
 4 |     build:
 5 |       context:    .
 6 |       dockerfile: Dockerfile-nginx
 7 |     image:      test-logging-nginx
 8 |     depends_on:
 9 |       - php
10 |     ports:
11 |       - "9080:9080"
12 |     links:
13 |       - php
14 | 
15 |   php:
16 |     build:
17 |       context:    .
18 |       dockerfile: Dockerfile-php
19 |     image:      test-logging-php
20 |     expose:
21 |       - 9000
22 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/nginx-vhost.conf:
--------------------------------------------------------------------------------
 1 | # This is NOT a production-grade nginx vhost config. Do NOT use it in
 2 | # production. It's just the minimal setup to test PHP logging.
 3 | server {
 4 |     root        /app;
 5 |     listen      9080;
 6 |     server_name localhost;
 7 | 
 8 |     location / {
 9 |         try_files $uri /index.php$is_args$args;
10 |     }
11 | 
12 |     location ~ ^/index\.php$ {
13 |         fastcgi_pass            php:9000;
14 |         fastcgi_split_path_info ^(.+\.php)(/.*)$;
15 |         include                 fastcgi_params;
16 | 
17 |         fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
18 |         fastcgi_param DOCUMENT_ROOT $realpath_root;
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-catch-workers-output/nginx-vhost.conf:
--------------------------------------------------------------------------------
 1 | # This is NOT a production-grade nginx vhost config. Do NOT use it in
 2 | # production. It's just the minimal setup to test PHP logging.
 3 | server {
 4 |     root        /app;
 5 |     listen      9080;
 6 |     server_name localhost;
 7 | 
 8 |     location / {
 9 |         try_files $uri /index.php$is_args$args;
10 |     }
11 | 
12 |     location ~ ^/index\.php$ {
13 |         fastcgi_pass            php:9000;
14 |         fastcgi_split_path_info ^(.+\.php)(/.*)$;
15 |         include                 fastcgi_params;
16 | 
17 |         fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
18 |         fastcgi_param DOCUMENT_ROOT $realpath_root;
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | version: '3.2'
 2 | services:
 3 |   nginx:
 4 |     build:
 5 |       context:    .
 6 |       dockerfile: Dockerfile-nginx
 7 |     image:      test-logging-nginx
 8 |     depends_on:
 9 |       - php
10 |     ports:
11 |       - "9080:9080"
12 |     links:
13 |       - php
14 | 
15 |   php:
16 |     build:
17 |       context:    .
18 |       dockerfile: Dockerfile-php
19 |     image:      test-logging-php
20 |     expose:
21 |       - 9000
22 |     volumes:
23 |       - logs:/var/log/shared
24 | 
25 |   php-log-tail:
26 |     build:
27 |       context:    .
28 |       dockerfile: Dockerfile-php-log-tail
29 |     image:      test-logging-php-log-tail
30 |     volumes:
31 |       - logs:/var/log/shared
32 | 
33 | volumes:
34 |     # Volume used to share the pipe between php app and tail (running
35 |     # in a sidecar container)
36 |     logs:
37 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-catch-workers-output/Dockerfile-php:
--------------------------------------------------------------------------------
 1 | FROM alpine:3.8
 2 | 
 3 | # Install php-fpm
 4 | RUN apk add --update --no-cache \
 5 |     php7 \
 6 |     php7-fpm
 7 | 
 8 | # In-line edit the config files. Don't do this for your Docker images,
 9 | # here we picked this approach to easily show what settings are edited.
10 | RUN sed -i -e 's/^;\?daemonize\s*=.*/daemonize = no/g'                          /etc/php7/php-fpm.conf && \
11 |     sed -i -e 's/^;\?error_log\s*=.*/error_log = \/proc\/self\/fd\/2/g'         /etc/php7/php-fpm.conf && \
12 |     sed -i -e 's/^;\?listen\s*=.*/listen = 0.0.0.0:9000/g'                      /etc/php7/php-fpm.d/www.conf && \
13 |     sed -i -e 's/^;\?catch_workers_output\s*=.*/catch_workers_output = yes/g'   /etc/php7/php-fpm.d/www.conf
14 | 
15 | # Add application code
16 | ADD index.php /app/index.php
17 | 
18 | CMD [ "php-fpm7", "--fpm-config", "/etc/php7/php-fpm.conf", "--php-ini", "/etc/php7/php.ini" ]
19 | 


--------------------------------------------------------------------------------
/app-log-php-fpm-via-unix-pipe/Dockerfile-php:
--------------------------------------------------------------------------------
 1 | FROM alpine:3.8
 2 | 
 3 | # Install php-fpm
 4 | RUN apk add --update --no-cache \
 5 |     php7 \
 6 |     php7-fpm
 7 | 
 8 | # Create the directory that will hold the (shared) unix pipe
 9 | RUN mkdir /var/log/shared
10 | 
11 | # In-line edit the config files. Don't do this for your Docker images,
12 | # here we picked this approach to easily show what settings are edited.
13 | RUN sed -i -e 's/^;\?daemonize\s*=.*/daemonize = no/g'                          /etc/php7/php-fpm.conf && \
14 |     sed -i -e 's/^;\?error_log\s*=.*/error_log = \/proc\/self\/fd\/2/g'         /etc/php7/php-fpm.conf && \
15 |     sed -i -e 's/^;\?pid\s*=.*/pid = \/var\/run\/php-fpm.pid/g'                 /etc/php7/php-fpm.conf && \
16 |     sed -i -e 's/^;\?listen\s*=.*/listen = 0.0.0.0:9000/g'                      /etc/php7/php-fpm.d/www.conf && \
17 |     sed -i -e 's/^;\?catch_workers_output\s*=.*/catch_workers_output = no/g'   /etc/php7/php-fpm.d/www.conf
18 | 
19 | # Add bootstrap script
20 | ADD bootstrap-php-fpm.sh /usr/local/bin/bootstrap-php-fpm.sh
21 | 
22 | # Add application code
23 | ADD index.php /app/index.php
24 | 
25 | CMD [ "/usr/local/bin/bootstrap-php-fpm.sh" ]
26 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # PHP on Kubernetes
 2 | 
 3 | There's no single way to run and operate an application on Kubernetes. As a general purpose and flexible containers orchestrator, different people ends up with different solutions and it's usually a trade-off between features, complexity, performances, which you balance based on your needs.
 4 | 
 5 | This repository doesn't aim to provide a one-fits-all solution, but offering options with pros and cons from which you can pick the one that works better to your use case and business.
 6 | 
 7 | 
 8 | ## Application Logs
 9 | 
10 | For a comparison between the following approaches, please see the blog post:<br />
11 | [PHP on Kubernetes: application logging via unix pipe](https://pracucci.com/php-on-kubernetes-application-logging-via-unix-pipe.html)
12 | 
13 | ### Option 1: log to `php://stdout` or `php://stderr` and enable `catch_workers_output` in php-fpm
14 | 
15 | ![](https://pracucci.com/assets/2019-01-24-php-on-kubernetes-php-fpm-catch-workers-output-b470128db4fbe35b4b68b0980076dec9e95be49c1b3dae929ec5ddb9f92aecb3.png)
16 | 
17 | - **Pro**: easy.
18 | - **Con**: application logs are wrapped by php-fpm and it makes parsing more complicated.
19 | - **Con**: application logs are truncated to 1024 bytes and splitted into multiple messages. Long logs are not unusual if you use structured logging and you log contextual information on errors (ie. stack trace).
20 | - **Con**: application logs are mixed with php-fpm logs into the same stream.
21 | 
22 | See a working example at [`app-log-php-fpm-via-catch-workers-output/`](app-log-php-fpm-via-catch-workers-output/).
23 | 
24 | ### Option 2: log to unix pipe and tail it in a sidecar container<br />
25 | 
26 | ![](https://pracucci.com/assets/2019-01-24-php-on-kubernetes-unix-pipe-148f44c75d4bf6babed6a4effbd2f3f2a542a62563d3288ac5e2fd67c407c85a.png)
27 | 
28 | See a working example at [`app-log-php-fpm-via-unix-pipe/`](app-log-php-fpm-via-unix-pipe/).
29 | 
30 | - **Pro**: application logs are not wrapped by php-fpm.
31 | - **Pro**: application logs are not limited by length (no splitting / truncating).
32 | - **Pro**: application logs and php-fpm error logs are not mixed together in the same stream.
33 | 


--------------------------------------------------------------------------------