本頁面由 Cloud Translation API 翻譯而成。

nginx

nginx 整合服務會收集連線指標和存取記錄。連線指標會擷取連線的目前狀態：有效、讀取或等待。系統會剖析存取記錄的連線詳細資料，包括對應至要求、用戶端、伺服器和訊息的欄位。

如要進一步瞭解 nginx，請參閱 nginx 說明文件。

必要條件

如要收集 Nginx 遙測資料，請安裝 Ops Agent：

如要使用指標，請安裝 2.1.0 以上版本。
如要使用記錄功能，請安裝 2.1.0 以上版本。

這項整合作業支援 nginx 1.18 和 1.20 版。

設定 nginx 執行個體

您必須在 nginx 設定檔中啟用 stub_status 模組，才能設定可從本機存取的網址，例如狀態頁面的 http://www.example.com/nginx_status。如要啟用 stub_status 模組，請完成下列步驟：

編輯 status.conf 檔案，或建立檔案 (如果檔案不存在)。您可以在 nginx 設定目錄中找到這個檔案，通常位於 /etc/nginx/conf.d。

在 server 區段新增下列程式碼：

location /nginx_status {
    stub_status on;
    access_log off;
    allow 127.0.0.1;
    deny all;
}

設定檔可能類似以下範例：

server {
   listen 80;
   server_name 127.0.0.1;
   location /nginx_status {
       stub_status on;
       access_log off;
       allow 127.0.0.1;
       deny all;
   }
   location / {
       root /dev/null;
   }
}

重新載入 nginx 設定。
```
sudo service nginx reload
```

您可以執行下列指令，自動完成上述步驟。如果 status.conf 檔案不存在，就會建立該檔案；如果檔案存在，則會覆寫現有檔案。這個指令會開啟 stub_status、重新載入 nginx，並驗證預期資訊是否透過端點公開。

sudo tee /etc/nginx/conf.d/status.conf > /dev/null << EOF
server {
    listen 80;
    server_name 127.0.0.1;
    location /nginx_status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        deny all;
    }
    location / {
       root /dev/null;
    }
}
EOF
sudo service nginx reload
curl http://127.0.0.1:80/nginx_status

輸出範例如下：

Active connections: 1
server accepts handled requests
 23 23 74
Reading: 0 Writing: 1 Waiting: 0

或者，您也可以直接將這些行嵌入主要 nginx.conf 檔案，而不使用個別的 status.conf 檔案。主要 nginx.conf 檔案通常位於下列其中一個目錄：/etc/nginx、/usr/local/nginx/conf 或 /usr/local/etc/nginx。

設定 nginx 適用的作業套件代理程式

按照「設定作業套件代理程式」指南操作，新增必要元素，從 Nginx 執行個體收集遙測資料，然後重新啟動代理程式。

範例設定

下列指令會建立設定，以收集及擷取 NGINX 的遙測資料：

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    nginx:
      type: nginx
      stub_status_url: http://127.0.0.1:80/nginx_status
  service:
    pipelines:
      nginx:
        receivers:
          - nginx
logging:
  receivers:
    nginx_access:
      type: nginx_access
    nginx_error:
      type: nginx_error
  service:
    pipelines:
      nginx:
        receivers:
          - nginx_access
          - nginx_error
EOF

如要讓這些變更生效，請重新啟動 Ops Agent：

Linux

如要重新啟動代理程式，請在執行個體上執行下列指令：
```
sudo systemctl restart google-cloud-ops-agent
```
如要確定代理程式已重新啟動，請執行下列指令，並驗證「指標代理程式」和「Logging 代理程式」元件是否已啟動：
```
sudo systemctl status "google-cloud-ops-agent*"
```

Windows

使用遠端桌面協定或類似工具連線至執行個體，並登入 Windows。
以滑鼠右鍵按一下 PowerShell 圖示，然後選取「以系統管理員身分執行」，以管理員權限開啟 PowerShell 終端機。
如要重新啟動代理程式，請執行下列 PowerShell 指令：
```
Restart-Service google-cloud-ops-agent -Force
```
如要確定代理程式已重新啟動，請執行下列指令，並驗證「指標代理程式」和「Logging 代理程式」元件是否已啟動：
```
Get-Service google-cloud-ops-agent*
```

設定記錄檔收集作業

如要從 nginx 擷取記錄，您必須為 nginx 產生的記錄建立接收器，然後為新接收器建立管道。

如要設定 nginx_access 記錄的接收器，請指定下列欄位：

欄位	預設	說明
`exclude_paths`		要從 `include_paths` 比對的集合中排除的檔案系統路徑模式清單。
`include_paths`	`[/var/log/nginx/access.log]`	要讀取的檔案系統路徑清單，方法是追蹤每個檔案。路徑中可以使用萬用字元 (`*`)。
`record_log_file_path`	`false`	如果設為 `true`，輸出記錄項目中就會顯示路徑，指出記錄項目是從哪個特定檔案取得，並做為 `agent.googleapis.com/log_file_path` 標籤的值。使用萬用字元時，系統只會記錄取得記錄的檔案路徑。
`type`		這個值必須是 `nginx_access`。
`wildcard_refresh_interval`	`60s`	`include_paths` 中萬用字元檔案路徑的重新整理間隔。以時間長度表示，例如 `30s` 或 `2m`。在記錄吞吐量較高的情況下，記錄檔的輪替速度會比預設間隔更快，這時這個屬性就可能派上用場。

如要設定 nginx_error 記錄的接收器，請指定下列欄位：

欄位	預設	說明
`exclude_paths`		要從 `include_paths` 比對的集合中排除的檔案系統路徑模式清單。
`include_paths`	`[/var/log/nginx/error.log]`	要讀取的檔案系統路徑清單，方法是追蹤每個檔案。路徑中可以使用萬用字元 (`*`)。
`record_log_file_path`	`false`	如果設為 `true`，輸出記錄項目中就會顯示路徑，指出記錄項目是從哪個特定檔案取得，並做為 `agent.googleapis.com/log_file_path` 標籤的值。使用萬用字元時，系統只會記錄取得記錄的檔案路徑。
`type`		這個值必須是 `nginx_error`。
`wildcard_refresh_interval`	`60s`	`include_paths` 中萬用字元檔案路徑的重新整理間隔。以時間長度表示，例如 `30s` 或 `2m`。在記錄吞吐量較高的情況下，記錄檔的輪替速度會比預設間隔更快，這時這個屬性就可能派上用場。

記錄內容

logName 是從設定中指定的接收器 ID 衍生而來。LogEntry 內的詳細欄位如下。

nginx_access 記錄包含 LogEntry 中的下列欄位：

欄位	類型	說明
`httpRequest`	物件	查看`HttpRequest`
`jsonPayload.host`	字串	Host 標頭的內容 (通常不會由 nginx 回報)
`jsonPayload.level`	字串	記錄項目層級
`jsonPayload.user`	字串	要求中經過驗證的使用者名稱
`severity`	字串 (`LogSeverity`)	記錄項目層級 (已翻譯)。

nginx_error 記錄包含 LogEntry 中的下列欄位：

欄位	類型	說明
`jsonPayload.client`	字串	用戶端 IP 位址 (選填)
`jsonPayload.connection`	數字	連線 ID
`jsonPayload.host`	字串	主機標頭 (選填)
`jsonPayload.level`	字串	記錄項目層級
`jsonPayload.message`	字串	記錄訊息
`jsonPayload.pid`	數字	核發記錄的程序 ID
`jsonPayload.referer`	字串	Referer 標頭 (選填)
`jsonPayload.request`	字串	原始 HTTP 要求 (選填)
`jsonPayload.server`	字串	Nginx 伺服器名稱 (選用)
`jsonPayload.subrequest`	字串	Nginx 子要求 (選用)
`jsonPayload.tid`	數字	記錄的來源討論串 ID
`jsonPayload.upstream`	字串	上游要求 URI (選用)
`severity`	字串 (`LogSeverity`)	記錄項目層級 (已翻譯)。

設定指標收集

如要從 nginx 擷取指標，請為 nginx 產生的指標建立接收器，然後為新接收器建立管道。

這個接收器不支援在設定中使用多個執行個體，例如監控多個端點。所有這類執行個體都會寫入相同的時間序列，而 Cloud Monitoring 無法區分這些執行個體。

如要為 nginx 指標設定接收器，請指定下列欄位：

欄位	預設	說明
`collection_interval`	`60s`	時間長度值，例如 `30s` 或 `5m`。
`server_status_url`	`http://localhost/status`	nginx 存根狀態模組公開的網址。
`type`		這個值必須是 `nginx`。

監控的內容

下表列出作業套件代理程式從 nginx 執行個體收集的指標。

指標類型
類型受監控資源	標籤
`workload.googleapis.com/nginx.connections_accepted`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/nginx.connections_current`
`GAUGE`, `INT64` gce_instance	`state`
`workload.googleapis.com/nginx.connections_handled`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/nginx.requests`
`CUMULATIVE`, `INT64` gce_instance

驗證設定

本節說明如何確認您已正確設定 nginx 接收器。作業套件代理程式可能需要一到兩分鐘，才會開始收集遙測資料。

如要確認 nginx 記錄是否已傳送至 Cloud Logging，請按照下列步驟操作：

前往 Google Cloud 控制台的「Logs Explorer」頁面：
前往「Logs Explorer」(記錄檔探索工具)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Logging」的結果。

在編輯器中輸入下列查詢，然後按一下「執行查詢」：

resource.type="gce_instance"
(log_id("nginx_access") OR log_id("nginx_error"))

如要確認 nginx 指標是否已傳送至 Cloud Monitoring，請執行下列操作：

前往 Google Cloud 控制台的「Metrics Explorer」頁面：
前往 Metrics Explorer

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在查詢建構工具窗格的工具列中，選取名稱為 MQL 或 PromQL 的按鈕。
確認已在「Language」(語言) 切換按鈕中選取「PromQL」。語言切換按鈕位於同一工具列，可供你設定查詢格式。

在編輯器中輸入下列查詢，然後按一下「執行查詢」：

fetch gce_instance
| metric 'workload.googleapis.com/nginx.requests'
| every 1m

查看資訊主頁

如要查看 Nginx 指標，您必須設定圖表或資訊主頁。 nginx 整合服務包含一或多個資訊主頁。設定整合功能後，Ops Agent 就會開始收集指標資料，並自動安裝所有資訊主頁。

您也可以查看資訊主頁的靜態預覽畫面，不必安裝整合服務。

如要查看已安裝的資訊主頁，請按照下列步驟操作：

在 Google Cloud 控制台中，前往「Dashboards」(資訊主頁) 頁面：
前往「Dashboards」(資訊主頁)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
選取「資訊主頁清單」分頁，然後選擇「整合」類別。
按一下要查看的資訊主頁名稱。

如果您已設定整合功能，但尚未安裝資訊主頁，請檢查作業套件代理程式是否正在執行。如果資訊主頁中的圖表沒有指標資料，資訊主頁安裝作業就會失敗。作業套件代理程式開始收集指標後，系統就會為您安裝資訊主頁。

如要查看資訊主頁的靜態預覽畫面，請按照下列步驟操作：

前往 Google Cloud 控制台的「Integrations」(整合) 頁面：
前往「整合」

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
按一下「Compute Engine」部署平台篩選器。
找出「nginx」的項目，然後按一下「查看詳細資料」。
選取「資訊主頁」分頁標籤，即可查看靜態預覽畫面。如果已安裝資訊主頁，請點選「查看資訊主頁」前往。

如要進一步瞭解 Cloud Monitoring 中的資訊主頁，請參閱「資訊主頁和圖表」。

如要進一步瞭解如何使用「整合」頁面，請參閱「管理整合」一文。

安裝快訊政策

快訊政策會指示 Cloud Monitoring 在發生指定情況時通知您。 nginx 整合功能包含一或多項快訊政策，供您使用。您可以在 Monitoring 的「Integrations」(整合) 頁面中查看及安裝這些快訊政策。

如要查看可用快訊政策的說明並安裝，請按照下列步驟操作：

前往 Google Cloud 控制台的「Integrations」(整合) 頁面：
前往「整合」

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
找出 nginx 的項目，然後按一下「查看詳細資料」。
選取「快訊」分頁標籤。這個分頁會說明可用的快訊政策，並提供安裝介面。
安裝快訊政策。快訊政策需要知道在觸發快訊時，要將通知傳送至何處，因此需要您提供安裝資訊。如要安裝快訊政策，請按照下列步驟操作：
1. 從可用的警報政策清單中，選取要安裝的政策。
2. 在「設定通知」部分，選取一或多個通知管道。您可以選擇停用通知管道，但這麼做的話，快訊政策會以無聲方式觸發。您可以在「監控」中查看狀態，但不會收到任何通知。
  
  如要進一步瞭解通知管道，請參閱「管理通知管道」。
3. 按一下「建立政策」。

如要進一步瞭解 Cloud Monitoring 中的快訊政策，請參閱快訊簡介。