想使用 Nginx Upstream Proxy 到外部服務，並帶入對應的 header 該怎麼做？

此文章要來記錄一下最近在公司服務入口遇到的一些小問題，以及解決的方法。簡單說明一下，我們的服務入口是用 Nginx 來當作 proxy server，將不同路徑或是 servername 導到對應的後端程式，或是外部的服務上(例如 AWS cloudfront.net)，本篇要測試的是如果使用要同時使用 upstream 到外部服務，且需要帶 host header 該怎麼做。

location /aaa {
    proxy_pass http://aaa.example.com;
}

upstream backend_hosts {
  server aaa.example.com;
  server bbb.example.com;
  server ccc.example.com;
}

location /aaa {
  proxy_pass http://backend_hosts;
}

問題

那如果我們使用 Nginx upstream 時，還想要同時帶 host 的 header 到後端該怎麼做呢？我們先來看一下目前的寫法：

( 測試範例是使用 docker 來模擬，可以參考程式碼 > 點我前往 github，會有三個 nginx，其中一個是負責 proxy 的 nginx 名為 proxy，另外兩台是 upstream 後的服務，名為 upstream_server1、upstream_server2 )

    upstream upstream_server {
        server upstream_server1;
        server upstream_server2;
    }

    server {
        listen 80;
        server_name localhost;

        location /upstream_server/ {
            proxy_pass http://upstream_server;
            proxy_set_header Host "upstream_server1";
            proxy_set_header Host "upstream_server2";
            access_log /var/log/nginx/access.log upstream_log;
        }
    }
}

可以看到我們希望 Nginx 收到 request 是 /upstream_server 時，將 request 轉發到 http://upstream_server，而 upstream_server 後面有兩個 server，並且在 proxy 時，帶入兩個不同的 host header。但如果真的這樣寫，可以達到我們想要得效果嗎？我們實際跑看看程式 (範例可以使用 nginx-old.conf)：

從上面的 LOG 可以發現，我們 call /upstream_server 時，後端的 upstream_server1、upstream_server2 收到的 host 只會收到第一個設定的 Host，且服務會出現 400 Bad Request，查了一下網路文章，發現出現 400 Bad Request，可能跟 header 送太多資訊過去，詳細可以參考 解決網站出現 400 Bad Request 狀態的方法。

這邊推測應該是後端如果也是用 nginx 直接接收才會遇到 400 的問題，還好目前公司服務還是正常的 xDD，檢查一下後發現，其實後端根本沒有要求對應 header 才能接收(應該是對方忘記加上此限制)。

解決

好，不管是否需要對應 header，我們還是找看看有沒有辦法同時使用 upstream，並帶入對應 host 的方法呢？

最後參考網路上的文章，似乎只能使用兩層的 proxy，才能完成這兩個需求，我們來看看要怎麼寫吧 (範例可以使用 nginx.conf)：

    server {
        listen 777;
        server_name localhost;

        location / {
            proxy_pass http://upstream_server1;
            proxy_set_header Host "upstream_server1";
            access_log /var/log/nginx/access.log upstream_log;
        }
    }

    server {
        listen 888;
        server_name localhost;

        location / {
            proxy_pass http://upstream_server2;
            proxy_set_header Host "upstream_server2";
            access_log /var/log/nginx/access.log upstream_log;
        }
    }

    upstream upstream_server {
        server 127.0.0.1:777;
        server 127.0.0.1:888;
    }

    server {
        listen 80;
        server_name localhost;

        location /upstream_server/ {
            proxy_pass http://upstream_server;
            access_log /var/log/nginx/access.log upstream_log;
        }
    }

可以看到上面的程式碼，我們透過兩層的 proxy，來達到我們想要的效果，這樣子就可以同時使用 upstream，並且帶入對應的 host header。

首先在 28 ~ 36 行，我們一樣如果 Nginx 收到 request 是 /upstream_server 時，會 proxy 到 upstream_server 這個 upstream 中，而 upstream_server 有兩個 server，分別是 127.0.0.1:777、127.0.0.1:888，但實際上沒有這兩個 port，所以我們需要再寫一層一般的 proxy 設定，分別是 1 ~ 10 行、12 ~ 21 行，這樣子就可以達到我們想要的效果。

但這個方法比較適用於 upstream 後端沒有太多個服務或是機器的情況，如果有很多個服務或是機器，就需要寫很多的 proxy，這樣子會變得很麻煩，所以如果有更好的方法，也歡迎留言跟我分享 🤣。

最後我們來看一下實際執行的結果：

參考資料

Make nginx to pass hostname of the upstream when reverseproxying：https://serverfault.com/questions/598202/make-nginx-to-pass-hostname-of-the-upstream-when-reverseproxying