<h1 id="%22melbourne%22%3A-wsgi-with-gunicorn">
<a class="header-anchor-link" href="#%22melbourne%22%3A-wsgi-with-gunicorn" aria-hidden="true"></a> "Melbourne": WSGI with Gunicorn</h1>
<p>SadServersの <a href="https://sadservers.com/newserver/melbourne#" target="_blank" rel="nofollow noopener noreferrer">"Melbourne": WSGI with Gunicorn</a> の解説です。</p>
<p>SadServers って何？ って人は、 <a href="https://zenn.dev/kenma/articles/373d382bf4f1db" target="_blank">SadServers解説</a> を見てください。<br>
一言でいうと、LeetCode (コーディング問題集) の Linuxサーバ設定版のようなものです。</p>
<h2 id="%E5%95%8F%E9%A1%8C">
<a class="header-anchor-link" href="#%E5%95%8F%E9%A1%8C" aria-hidden="true"></a> 問題</h2>
<p>問題を見ていきます。 <code>&gt;</code> の箇所は <a href="https://www.deepl.com/ja/translator" target="_blank" rel="nofollow noopener noreferrer">DeepL</a>での翻訳です。</p>
<div class="code-block-container"><pre><code>Scenario: "Melbourne": WSGI with Gunicorn

Level: Medium

Description: There is a Python WSGI web application file at /home/admin/wsgi.py , the purpose of which is to serve the string "Hello, world!". This file is served by a Gunicorn server which is fronted by an nginx server (both servers managed by systemd). So the flow of an HTTP request is: Web Client (curl) -&gt; Nginx -&gt; Gunicorn -&gt; wsgi.py . The objective is to be able to curl the localhost (on default port :80) and get back "Hello, world!", using the current setup.
&gt; /home/admin/wsgi.py に Python WSGI ウェブアプリケーションファイルがあり、その目的は "Hello, world!" という文字列を提供することです。このファイルは、nginxサーバをフロントとするGunicornサーバによって提供されます（両サーバはsystemdによって管理されています）。つまり、HTTPリクエストの流れはWeb Client (curl) -&gt; Nginx -&gt; Gunicorn -&gt; wsgi.py .目標は、現在の設定で、localhost (on default port :80) を curl して "Hello, world!" を返せるようにすることです。

Test: curl -s http://localhost returns Hello, world! (serving the wsgi.py file via Gunicorn and Nginx)
&gt; curl -s http://localhost return Hello, world!(wsgi.pyファイルをGunicornとNginxで提供する)


Time to Solve: 20 minutes.

OS: Debian 11
</code></pre></div><p>Python WSGIというのは、Webサーバと Pythonアプリケーションサーバを結びつける規格です。<br>
[Gunicorn]（<a href="https://github.com/benoitc/gunicorn%EF%BC%89%E3%81%A8%E3%81%84%E3%81%86%E3%81%AE%E3%81%AF%E3%80%81Python" target="_blank" rel="nofollow noopener noreferrer">https://github.com/benoitc/gunicorn）というのは、Python</a> WSGIを実装している、アプリケーションサーバで、<code>wsgi.py</code>を実行しています。<br>
Webサーバ<code>Nginx</code>は、Python WSGIに対応しているので、WSGI対応の<code>Gunicorn</code>と連携することができます。<br>
つまり、次のような関係となっています。<br>
<img src="https://storage.googleapis.com/zenn-user-upload/e7c82febab7f-20230119.png" alt loading="lazy" class="md-img"></p>
<h2 id="%E8%A7%A3%E8%AA%AC">
<a class="header-anchor-link" href="#%E8%A7%A3%E8%AA%AC" aria-hidden="true"></a> 解説</h2>
<p>早速、curlを実行します。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:/$ curl -s http://localhost
# 何も返ってこない。
# 詳細を見るために、-s の代わりに -v を指定する。
admin@ip-172-31-43-152:/$ curl -v http://localhost
*   Trying 127.0.0.1:80...
* connect to 127.0.0.1 port 80 failed: Connection refused
* Failed to connect to localhost port 80: Connection refused
* Closing connection 0
curl: (7) Failed to connect to localhost port 80: Connection refused
</code></pre></div><p>port 80に接続できていません。 port 80 で待ち受けるアプリは、Nginxなので、Nginxが正しく動作しているかを確認します。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:/$ systemctl status nginx
● nginx.service - A high performance web server and a reverse prox&gt;
     Loaded: loaded (/lib/systemd/system/nginx.service; disabled; &gt;
     Active: inactive (dead)
       Docs: man:nginx(8)
</code></pre></div><blockquote>
<pre><code>Active: inactive (dead)
</code></pre>
</blockquote>
<p>となっているので、Nginxは起動していません。 なので、起動します。</p>
<div class="code-block-container"><pre><code># nginxの起動
admin@ip-172-31-43-152:/var/log/nginx$ sudo systemctl  start nginx

# 起動したか確認する。
admin@ip-172-31-43-152:/var/log/nginx$ sudo systemctl  status nginx
● nginx.service - A high performance web server and a reverse proxy server
     Loaded: loaded (/lib/systemd/system/nginx.service; disabled; vendor preset: enabled)
     Active: active (running) since Thu 2023-01-19 07:48:03 UTC; 6s ago
       Docs: man:nginx(8)
    Process: 964 ExecStartPre=/usr/sbin/nginx -t -q -g daemon on; master_process on; (code=exited&gt;
    Process: 965 ExecStart=/usr/sbin/nginx -g daemon on; master_process on; (code=exited, status=&gt;
   Main PID: 966 (nginx)
      Tasks: 3 (limit: 524)
     Memory: 11.2M
        CPU: 41ms
     CGroup: /system.slice/nginx.service
             ├─966 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;
             ├─967 nginx: worker process
             └─968 nginx: worker process

Jan 19 07:48:03 ip-172-31-43-152 systemd[1]: Starting A high performance web server and a reverse&gt;
Jan 19 07:48:03 ip-172-31-43-152 systemd[1]: Started A high performance web server and a reverse &gt;
</code></pre></div><p>正しく起動しました。では、curlを再度実行します。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:/etc/nginx$ curl -v http://localhost
*   Trying 127.0.0.1:80...
* Connected to localhost (127.0.0.1) port 80 (#0)
&gt; GET / HTTP/1.1
&gt; Host: localhost
&gt; User-Agent: curl/7.74.0
&gt; Accept: */*
&gt; 
* Mark bundle as not supporting multiuse
&lt; HTTP/1.1 502 Bad Gateway
&lt; Server: nginx/1.18.0
&lt; Date: Thu, 19 Jan 2023 08:53:46 GMT
&lt; Content-Type: text/html
&lt; Content-Length: 157
&lt; Connection: keep-alive
&lt; 
&lt;html&gt;
&lt;head&gt;&lt;title&gt;502 Bad Gateway&lt;/title&gt;&lt;/head&gt;
&lt;body&gt;
&lt;center&gt;&lt;h1&gt;502 Bad Gateway&lt;/h1&gt;&lt;/center&gt;
&lt;hr&gt;&lt;center&gt;nginx/1.18.0&lt;/center&gt;
&lt;/body&gt;
&lt;/html&gt;
* Connection #0 to host localhost left intact
</code></pre></div><p>port 80には接続できましたが、502エラーとなっています。<br>
Gunicornとの接続ができているか確認するために、Nginxの設定を見ます。</p>
<div class="code-block-container"><pre><code># Nginx の設定ファイルのあるフォルダに移動
admin@ip-172-31-43-152:/$ cd /etc/nginx

# gunicorn関連の設定があるか確認。
admin@ip-172-31-43-152:/etc/nginx$ grep guni *
grep: conf.d: Is a directory
grep: modules-available: Is a directory
grep: modules-enabled: Is a directory
grep: sites-available: Is a directory
grep: sites-enabled: Is a directory
grep: snippets: Is a directory

# 無いので、サブフォルダを確認
admin@ip-172-31-43-152:/etc/nginx$ grep guni */*
sites-available/default:        proxy_pass http://unix:/run/gunicorn.socket;
sites-enabled/default:        proxy_pass http://unix:/run/gunicorn.socket;
</code></pre></div><p><code>/etc/nginx/sites-available/default</code> と <code>/etc/nginx/sites-enable/default</code>の ２ファイルにgunicorn関連の設定があります。 どうやら、Unixドメインソケット <code>unix:/run/gunicorn.socket</code> に接続しているようです。</p>
<p>Gunicorn側の設定を見てみます。設定ファイルなどよくわからないので、とりあえず、ps で 実行時の引数を見てみます。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:/etc/nginx$ ps auxww | grep guni
admin        592  0.0  4.7  27480 21980 ?        Ss   07:43   0:00 /usr/bin/python3 /usr/local/bin/gunicorn --bind unix:/run/gunicorn.sock wsgi
admin        653  0.0  4.1  27560 19308 ?        S    07:43   0:00 /usr/bin/python3 /usr/local/bin/gunicorn --bind unix:/run/gunicorn.sock wsgi
</code></pre></div><p>どうやら、 Gunicornは、 Unixドメインソケット <code>unix:/run/gunicorn.sock</code> で待ち受けているようです。</p>
<p><code>unix:/run/gunicorn.sock</code> と <code>unix:/run/gunicorn.socket</code> で違いがありますね。こちらを修正します。</p>
<p><code>/etc/nginx/sites-available/default</code> を <code>vi</code>で開いて、</p>
<div class="code-block-container"><pre><code>proxy_pass http://unix:/run/gunicorn.socket;
</code></pre></div><p>を</p>
<div class="code-block-container"><pre><code>proxy_pass http://unix:/run/gunicorn.sock;
</code></pre></div><p>に修正します。<code>/etc/nginx/sites-enable/default</code> は <code>/etc/nginx/sites-available/default</code>のシンボリックリンクなので修正不要です。</p>
<p>Nginxの設定を変更したので、Nginxを再起動して、<code>curl</code>を実行します。</p>
<div class="code-block-container"><pre><code># Nginxの再起動
admin@ip-172-31-43-152:/$ sudo systemctl restart  nginx

# curl実行
admin@ip-172-31-43-152:/etc/nginx/sites-available$ curl -v http://localhost
*   Trying 127.0.0.1:80...
* Connected to localhost (127.0.0.1) port 80 (#0)
&gt; GET / HTTP/1.1
&gt; Host: localhost
&gt; User-Agent: curl/7.74.0
&gt; Accept: */*
&gt; 
* Mark bundle as not supporting multiuse
&lt; HTTP/1.1 200 OK
&lt; Server: nginx/1.18.0
&lt; Date: Thu, 19 Jan 2023 07:56:53 GMT
&lt; Content-Type: text/html
&lt; Content-Length: 0
&lt; Connection: keep-alive
&lt; 
* Connection #0 to host localhost left intact
</code></pre></div><p>200が返ってくるようになりました。ただ、<code>Hello, world!</code>は返ってきていません。</p>
<p><code>/home/admin/wsgi.py</code> ファイルを見ます。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:~$ cd /home/admin/
admin@ip-172-31-43-152:~$ cat wsgi.py 
def application(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/html'), ('Content-Length', '0'), ])
    return [b'Hello, world!']
</code></pre></div><p><code>Content-Length:0</code>となっています。 返す文字列 <code>Hello, world!</code>は 13バイト (13文字)なので、ここを <code>13</code>に <code>vi</code>で修正します。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:~$ cat wsgi.py 
def application(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/html'), ('Content-Length', '13'), ])
    return [b'Hello, world!']
</code></pre></div><p>curlを再度実行します。</p>
<div class="code-block-container"><pre><code># curl実行
admin@ip-172-31-43-152:/etc/nginx/sites-available$ curl -v http://localhost
*   Trying 127.0.0.1:80...
* Connected to localhost (127.0.0.1) port 80 (#0)
&gt; GET / HTTP/1.1
&gt; Host: localhost
&gt; User-Agent: curl/7.74.0
&gt; Accept: */*
&gt; 
* Mark bundle as not supporting multiuse
&lt; HTTP/1.1 200 OK
&lt; Server: nginx/1.18.0
&lt; Date: Thu, 19 Jan 2023 07:56:53 GMT
&lt; Content-Type: text/html
&lt; Content-Length: 0
&lt; Connection: keep-alive
&lt; 
* Connection #0 to host localhost left intact
</code></pre></div><p>おや、 <code>Content-Length: 0</code> のままです。 <code>wsgi.py</code>の修正が反映されていないようなので、Gunicornの再起動します。</p>
<p>[update] Gunicornをsystemctlで再起動するように修正。</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-44-185:~$ sudo systemctl restart gunicorn 
admin@ip-172-31-44-185:~$ sudo systemctl status  gunicorn 
● gunicorn.service - gunicorn daemon
     Loaded: loaded (/etc/systemd/system/gunicorn.service; enabled; vendor preset: enabled)
     Active: active (running) since Sun 2023-02-05 14:06:19 UTC; 5s ago
TriggeredBy: ● gunicorn.socket
   Main PID: 962 (gunicorn)
      Tasks: 2 (limit: 524)
     Memory: 16.8M
        CPU: 198ms
     CGroup: /system.slice/gunicorn.service
             ├─962 /usr/bin/python3 /usr/local/bin/gunicorn --bind unix:/run/gunicorn.sock wsgi
             └─963 /usr/bin/python3 /usr/local/bin/gunicorn --bind unix:/run/gunicorn.sock wsgi

Feb 05 14:06:19 ip-172-31-44-185 systemd[1]: Started gunicorn daemon.
Feb 05 14:06:20 ip-172-31-44-185 gunicorn[962]: [2023-02-05 14:06:20 +0000] [962] [INFO] Starting gunico&gt;
Feb 05 14:06:20 ip-172-31-44-185 gunicorn[962]: [2023-02-05 14:06:20 +0000] [962] [INFO] Listening at: u&gt;
Feb 05 14:06:20 ip-172-31-44-185 gunicorn[962]: [2023-02-05 14:06:20 +0000] [962] [INFO] Using worker: s&gt;
Feb 05 14:06:20 ip-172-31-44-185 gunicorn[963]: [2023-02-05 14:06:20 +0000] [963] [INFO] Booting worker &gt;
a
</code></pre></div><p>再起動したら、 <code>curl</code>を実行</p>
<div class="code-block-container"><pre><code>admin@ip-172-31-43-152:~$ curl -v http://localhost
*   Trying 127.0.0.1:80...
* Connected to localhost (127.0.0.1) port 80 (#0)
&gt; GET / HTTP/1.1
&gt; Host: localhost
&gt; User-Agent: curl/7.74.0
&gt; Accept: */*
&gt; 
* Mark bundle as not supporting multiuse
&lt; HTTP/1.1 200 OK
&lt; Server: nginx/1.18.0
&lt; Date: Thu, 19 Jan 2023 08:00:51 GMT
&lt; Content-Type: text/html
&lt; Content-Length: 13
&lt; Connection: keep-alive
&lt; 
* Connection #0 to host localhost left intact
Hello, world!admin@ip-172-31-43-152:~$ 
</code></pre></div><p>正しく、 <code>Hello, world!</code>が返ってきました。</p>
<p><code>Check My Solution</code>で確認して終わりです。</p>


[SadServers] 解説 "Melbourne": WSGI with Gunicorn

Discussion