
ZabbixでNginxを監視する設定のテンプレートを追加しました。
その備忘録です。

## 環境

- CentOS 7
- Zabbix : v5.0
- nginx : v1.19.6

## 導入方法

https://www.zabbix.com/integrations/nginx




ZabbixがNginxを監視するための導入手順は３つあります。
- [Template App Nginx By HTTP](https://www.zabbix.com/integrations/nginx#tab:official1)  
  HTTP経由でリソースを取得する。
- [Template App Nginx By Zabbix Agent](https://www.zabbix.com/integrations/nginx#tab:official2)  
  ローカルのエージェントがメトリックを収集する。
- [3rd Party Solutions](https://www.zabbix.com/integrations/nginx#tab:3rd_party)  
  PHP-FPM 向けのものやメトリクスを拡張するモジュールを紹介しています。

上２つはZabbixエージェントがサーバの中か外かの違いだけで。
どちらもNginxのステータスを返すエンドポイントを設定します。


## モジュールの確認とNginxの設定

### ngx_http_stub_status_module

[Nginx Module ngx_http_stub_status_module](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)

`ngx_http_stub_status_module`モジュールは、基本的なステータス情報へのアクセスを提供します。
Zabbixエージェントはこれをメトリクスとして収集します。

▼ のコマンドで`ngx_http_stub_status_module`モジュールが利用可能か確認します。
```sh
$ nginx -V 2>&1 | grep -o with-http_stub_status_module
with-http_stub_status_module
```


▼次のステータス情報が提供されています。

| ステータス   | 概要                                                |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Active connections | 接続待ちを含むアクティブなクライアント接続の現在の数。 |
| accepts    | 受け入れられたクライアント接続の総数。                                    |
| handled    | 処理されたコネクションの総数。一般的にリソースの制限 (たとえば worker_connections の制限) に達していない限りパラメータの値は accepts と同じになります。 |
| requests     | クライアント要求の総数。                                          |
| Reading    | nginxがリクエストヘッダーを読み取っている現在の接続数。                               |
| Writing    | nginxがクライアントに応答を書き戻している現在の接続数。                               |
| Waiting    | 要求を待機しているアイドル状態のクライアント接続の現在の数。                              |

▼レスポンスの例
```bash
$ curl http://localhost/basic_status
Active connections: 11
server accepts handled requests
 47 47 160
Reading: 0 Writing: 1 Waiting: 10
```

### Nginxの設定

メトリックを収集するためのHTTPの設定をNginxのconfに追加します。
```bash:/etc/nginx/conf.d/default.conf
server {
  listen   80;
  server_name  localhost;

  location / {
    root /var/www/public;
    index  index.html index.htm;
  }

  # 追加したパス
  location /basic_status {
    stub_status;
    allow 127.0.0.1;
    allow ::1;
    deny all;
  }

  省略
}
```
ローカルホストから80ポートのアクセスに対してのみステータスを返します。
`127.0.0.1`と`::1`はどちらもローカルホストです。
どちらか片方を消しても同じです。

別のサーバからアクセスする場合は、`allow <IP of your Zabbix server/proxy>;`と変えてください。

▼ローカルからのアクセスはOK。  
```bash
$ curl http://localhost/basic_status
Active connections: 11
server accepts handled requests
 47 47 160
Reading: 0 Writing: 1 Waiting: 10
```

▼外からのアクセスは403になることを確認しました。  
![403](/images/posts/270/279/403.png)

## テンプレートについて

テンプレートの追加と項目について。

### テンプレートの追加
Zabbixの「設定」→「ホスト」からNginxのホストに対してテンプレートを追加します。
「新規テンプレートをリンク」からテンプレートを探して更新をする。

![template](/images/posts/270/279/template-nginx-agent.png)



ZabbixでNginxを監視する設定


サーバの監視を始めるためにZabbixを導入しました。
**Zabbix + CentOS7 + Nginx + MySQLの構成**です。
意外とつまずいたので手順を残す。

Zabbixについては[Zabbixのコンセプト](https://www.zabbix.com/documentation/5.0/manual/concepts/server)を読みました。

## Table of Contents

## 環境とバージョン

[zabbixダウンロードページ](https://www.zabbix.com/jp/download?zabbix=5.0&os_distribution=centos&os_version=7&db=mysql&ws=nginx)でバージョンと環境を選ぶとそれに沿ったインストール手順を示してくれます。

[以前作ったさくらのVPSの環境](https://www.suzu6.net/posts/267-new-blog/)に合わせて選択しました。
- ZABBIXバージョン: 5.0 LTS
- OSディストリビューション: CentOS
- OSバージョン: 7
- データベース: MySQL (8.0)
- WEB SERVER: Nnginx (1.19.6)

![ver](/images/posts/270/zabbix_version.png)

また、`zabbix-server`（管理画面）はPHPで動くため
`rh-php72-php-fpm` (php v7.2)もインストールされます。

## MySQLを準備する

MySQLがない場合は手戻りが発生するため先にインストールしておきます。
バージョンはMySQL 8.0です。

前にブログに書いたのでそちらの手順でインストールします。
後でZabbix用のDBとユーザを作ります。
- [CentOS7にMySQL8をインストールして初期パスワードを変更する](https://www.suzu6.net/posts/196-mysql/)

公式では[こちら](https://dev.mysql.com/doc/refman/8.0/en/linux-installation-yum-repo.html)でyumリポジトリからのインストールする手順が載ってます。

※ 先にZabbixのインストールを進めていると、MariaDBを削除した際に`zabbix-server-mysql`が消されます。一緒に`postfix`も消えた。

```bash
Removed:
  mariadb-libs.x86_64 1:5.5.68-1.el7

Dependency Removed:
  postfix.x86_64 2:2.10.1-9.el7         zabbix-server-mysql.x86_64 0:5.0.7-1.el7
```

消しちゃった場合は▼でインストールし直すことができます。
```bash
$ sudo yum install -y zabbix-server-mysql postfix
```

## Zabbix インストール

Zabbixをインストールします。
サーバにSSHしてコマンドを実行していきます。


### a. Install Zabbix repository
RPMのパッケージをアップグレードします。
そのあとキャシュを消します。
```bash
# RPMのパッケージをアップグレード
$ sudo rpm -Uvh https://repo.zabbix.com/zabbix/5.0/rhel/7/x86_64/zabbix-release-5.0-1.el7.noarch.rpm
Retrieving https://repo.zabbix.com/zabbix/5.0/rhel/7/x86_64/zabbix-release-5.0-1.el7.noarch.rpm
warning: /var/tmp/rpm-tmp.jVb3gM: Header V4 RSA/SHA512 Signature, key ID a14fe591: NOKEY
Preparing...                          ################################# [100%]
Updating / installing...
   1:zabbix-release-5.0-1.el7         ################################# [100%]

# キャシュクリーン
$ sudo yum clean all
Loaded plugins: fastestmirror, langpacks
Cleaning repos: base epel extras nginx-mainline nginx-stable updates zabbix
              : zabbix-non-supported
Cleaning up list of fastest mirrors
```

| オプション | 説明                                        |
| ---------- | ------------------------------------------- |
| `U`        | パッケージをアップグレードする              |
| `v`        | 情報表示を増やす                            |
| `h`        | インストール時の経過を「#」マークで表示する |

### b. Install Zabbix server and agent

Zabbixサーバとエージェントをインストールします。
```bash
$ sudo yum install zabbix-server-mysql zabbix-agent -y
```

### c. Install Zabbix frontend

Zabbixの管理画面をインストールするために[Red Hat Software Collections](https://wiki.centos.org/AdditionalResources/Repositories/SCL)を有効化します。

```bash
$ sudo yum install centos-release-scl
```

`/etc/yum.repos.d/zabbix.repo`を編集して`zabbix-frontend`のリポジトリを有効化します。
```bash
$ sudo vi /etc/yum.repos.d/zabbix.repo
[zabbix-frontend]
...
enabled=1
...
```
`zabbix-frontend`のパッケージをインストールする。

```bash
$ sudo yum install zabbix-web-mysql-scl zabbix-nginx-conf-scl
```

### d. Create initial database
Zabbix用のデータベースとユーザを作成します。
ユーザはローカルホストからのみアクセス出来るようにする。
```bash
$ mysql -uroot -p
password
# データベースを作成して文字コードをUTF-8にセット
mysql> create database zabbix character set utf8 collate utf8_bin;
# ユーザを追加
mysql> create user zabbix@localhost identified by 'password';
mysql> grant all privileges on zabbix.* to zabbix@localhost;

# zabbix ユーザが追加できた
mysql> select user, host from mysql.user;
+------------------+-----------+
| user             | host      |
+------------------+-----------+
| mysql.infoschema | localhost |
| mysql.session    | localhost |
| mysql.sys        | localhost |
| root             | localhost |
| zabbix           | localhost |
+------------------+-----------+
5 rows in set (0.00 sec)
mysql> quit;
```

Zabbixサーバーホストで初期スキーマとデータをインポートします。
新しく作成したパスワードを入力するように求められます。

```bash
$ sudo zcat /usr/share/doc/zabbix-server-mysql*/create.sql.gz | mysql -uzabbix -p zabbix
```

### e. Configure the database for Zabbix server
Zabbixサーバー用にデータベースを設定します。
ファイル`/etc/zabbix/zabbix_server.conf`を編集する。

```bash
$ sudo vi /etc/zabbix/zabbix_server.conf
...
# パスワードをセット
DBPassword=your-password
```
 
### f. Configure PHP for Zabbix frontend

Zabbixフロントエンドをインストールする中でNginxとPHP-fpmもインストールされてます。
今回はNginxはインストール済のモノを使うため、その設定をします。
php-fpmはそのまま利用します。

```bash
# zabbix.confをインストール済のNginxのディレクトリにコピー
$ sudo cp /etc/opt/rh/rh-nginx116/nginx/conf.d/zabbix.conf /etc/nginx/conf.d/
# ホスト名にリネーム
$ sudo mv /etc/nginx/conf.d/zabbix.conf /etc/nginx/conf.d/zabbix.suzu6.net.conf 
$ ls /etc/nginx/conf.d/
default.conf     nuxt-content-sample.suzu6.net.conf  www.suzu6.net.conf
https.conf.back  suzu6.net.conf                      zabbix.suzu6.net.conf

# 設定を編集する
$ sudo vi etc/nginx/conf.d/zabbix.suzu6.net.conf
server {
#        listen          80;
        listen          80;
#        server_name     example.com;
        server_name     zabbix.suzu6.net;
```
私のルールとしてファイル名をホスト名で管理しているので、そのようにファイルをリネームした。
設定はポートとホスト名を変更しました。（SSL対応は後でやります）


<details><summary>設定のオリジナルを載せます</summary>

```conf:/etc/opt/rh/rh-nginx116/nginx/conf.d/zabbix.conf
server {
#        listen          80;
        listen          80;
#        server_name     example.com;
        server_name     zabbix.suzu6.net;

        root    /usr/share/zabbix;

        index   index.php;

        location = /favicon.ico {
                log_not_found   off;
        }

        location / {
                try_files       $uri $uri/ =404;
        }

        location /assets {
                access_log      off;
                expires         10d;
        }

        location ~ /\.ht {
                deny            all;
        }

        location ~ /(api\/|conf[^\.]|include|locale) {
                deny            all;
                return          404;
        }

        location ~ [^/]\.php(/|$) {
                fastcgi_pass    unix:/var/opt/rh/rh-php72/run/php-fpm/zabbix.sock;
                fastcgi_split_path_info ^(.+\.php)(/.+)$;
                fastcgi_index   index.php;

                fastcgi_param   DOCUMENT_ROOT   /usr/share/zabbix;
                fastcgi_param   SCRIPT_FILENAME /usr/share/zabbix$fastcgi_script_name;        
                fastcgi_param   PATH_TRANSLATED /usr/share/zabbix$fastcgi_script_name;        

                include fastcgi_params;
                fastcgi_param   QUERY_STRING    $query_string;
                fastcgi_param   REQUEST_METHOD  $request_method;
                fastcgi_param   CONTENT_TYPE    $content_type;
                fastcgi_param   CONTENT_LENGTH  $content_length;

                fastcgi_intercept_errors        on;
                fastcgi_ignore_client_abort     off;
                fastcgi_connect_timeout         60;
                fastcgi_send_timeout            180;
                fastcgi_read_timeout            180;
                fastcgi_buffer_size             128k;
                fastcgi_buffers                 4 256k;
                fastcgi_busy_buffers_size       256k;
                fastcgi_temp_file_write_size    256k;
        }
}
```

</details>


Zabbixを起動して自動起動も有効化する。
```sh
$ sudo systemctl restart zabbix-server zabbix-agent nginx rh-php72-php-fpm
$ sudo systemctl enable zabbix-server zabbix-agent nginx rh-php72-php-fpm
```

## DNSの設定
zabbixがみられるように設定しにいきます。
Route53にドメインがあり[zabbix.suzu6.net](https://zabbix.suzu6.net) としました。

## Permission Errorを解決する

ここまで進めてZabbixのHTTPにアクセスすると`502 Bad Gateway`が出ました。
出てない方は次へ進めてください。

このエラーの解決方法は[こちら](https://www.suzu6.net/posts/272-isntall-zabbix-permission-error)に詳しく書きました。
ここではコマンドと設定だけ載せます。

▼`zabbix.conf`のユーザをnginxに変更します。
```bash
$ sudo vi /etc/opt/rh/rh-php72/php-fpm.d/zabbix.conf
[zabbix]
# user = apache
# group = apache
user = nginx
group = nginx

listen = /var/opt/rh/rh-php72/run/php-fpm/zabbix.sock
# listen.acl_users = apache
listen.acl_users = nginx
listen.allowed_clients = 127.0.0.1
```

▼PHPの権限を変更します。
```bash
# 実行権限を与える
$ sudo chmod 755 -R /usr/share/zabbix
# Nginxユーザを設定
$ sudo chown -R root:nginx /usr/share/zabbix

# ライブラリもNginxユーザを設定
$ sudo chown -R root:nginx /var/opt/rh/rh-php72/lib/php/*
```

Zabbixを再起動する。
```bash
$ sudo systemctl restart zabbix-server zabbix-agent nginx rh-php72-php-fpm
```

Welcome Zabbixがでた！会いたかったよZabbix！

![zabbix](/images/posts/270/zabbix.png)

## Zabbixの初期設定
Zabbixの初期設定を進めていきます。

### Time zone for PHP is not set (configuration parameter "date.timezone").
Zabbixの画面でこのメッセージが出ました。
PHPのタイムゾーンの設定が必要みたいです。

php-fpmの設定を`Asia/Tokyo`に変更します。

```conf:/etc/opt/rh/rh-php72/php-fpm.d/zabbix.conf
php_value[date.timezone] = Asia/Tokyo
```

### サーバとMySQLの設定

▼ ここでしたMySQLの設定を記入します。
![mysql](/images/posts/270/zabbix_mysql.png)

▼ ホスト名とポートを設定する（これであっているか自信ない）。
![server](/images/posts/270/zabbix_server.png)


進めていくと設定ファイルを吐き出そうとします。
ディレクトリの権限がないと保存できず進めないため`/etc/zabbix/web/zabbix.conf.php`が保存できるよう権限を変更する。

その後セットアップが進んでログイン画面に行きます。
- 初期ユーザ: Admin
- 初期パスワード: zabbix

ログイン後は「管理」→「ユーザ」からパスワードと言語の変更をしました。

## certbotでSSL化する（オプション）

[certbot](https://certbot.eff.org/lets-encrypt/centosrhel7-nginx)をインストールしていたのでこれでSSL対応します。

`certbot --nginx`で追加する。
```bash
# certbot --nginx
Saving debug log to /var/log/letsencrypt/letsencrypt.log
Plugins selected: Authenticator nginx, Installer nginx

Which names would you like to activate HTTPS for?
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1: suzu6.net
2: nuxt-content-sample.suzu6.net
3: www.suzu6.net
4: zabbix.suzu6.net
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Select the appropriate numbers separated by commas and/or spaces, or leave input  
blank to select all options shown (Enter 'c' to cancel): 4
Requesting a certificate for zabbix.suzu6.net
Performing the following challenges:
http-01 challenge for zabbix.suzu6.net
Waiting for verification...
Cleaning up challenges
Deploying Certificate to VirtualHost /etc/nginx/conf.d/zabbix.suzu6.net.conf
Redirecting all traffic on port 80 to ssl in /etc/nginx/conf.d/zabbix.suzu6.net.conf

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   
Congratulations! You have successfully enabled https://zabbix.suzu6.net
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   

IMPORTANT NOTES:
 - Congratulations! Your certificate and chain have been saved at:
   /etc/letsencrypt/live/zabbix.suzu6.net/fullchain.pem
   Your key file has been saved at:
   /etc/letsencrypt/live/zabbix.suzu6.net/privkey.pem
   Your certificate will expire on 2021-04-16. To obtain a new or
   tweaked version of this certificate in the future, simply run
   certbot again with the "certonly" option. To non-interactively
   renew *all* of your certificates, run "certbot renew"
 - If you like Certbot, please consider supporting our work by:

   Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
   Donating to EFF:                    https://eff.org/donate-le
```


```conf:/etc/nginx/conf.d/zabbix.suzu6.net.conf 
    listen 443 ssl; # managed by Certbot
    ssl_certificate /etc/letsencrypt/live/zabbix.suzu6.net/fullchain.pem; # managed by Certbot
    ssl_certificate_key /etc/letsencrypt/live/zabbix.suzu6.net/privkey.pem; # managed by Certbot
    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
```

` systemctl restart nginx`再起動。


Zabbixのインストール@CentOS7


サーバの監視を始めるためにZabbixを導入しました。
**Zabbix + CentOS7 + Nginx + MySQLの構成**です。

Zabbix Frontendのパーミッションでエラーの内容と解決方法を残します。
無理やりなところもあるため参考程度に見てください。

類似のエラーを検索して来られた方は、Permissionの確認をされると解決するかもしれません。

### 502 Bad Gateway
諸々インストールしてZabbixの管理画面を表示したときのエラー

```bash
$ tail /var/log/nginx/error.log | grep zabbix
2021/01/16 20:44:30 [crit] 21109#21109: *11 connect() to unix:/var/opt/rh/rh-php72/run/php-fpm/zabbix.sock 
failed (13: Permission denied) while connecting to upstream, client: 220.213.202.52, server: zabbix.suzu6.net, request: "GET / HTTP/1.1", upstream: "fastcgi://unix:/var/opt/rh/rh-php72/run/php-fpm/zabbix.sock:", host: "zabbix.suzu6.net"
```

これはNginxがphp-fpmを動かそうとしたけど権限がないって感じのエラーです。

php-fpmのPermissionをどうにかする必要があるけど、どうするのかわからなかったので調べた。
php-fpmの設定で`listen.owner`と`listen.group`を`nginx`にすればよいらしい。
参考: [Nginx で「502 Bad Gateway」とか、なんだかエラーログがでるよって時](https://qiita.com/madaran0805/items/a5b064105852656cca0e)

ということでphp-fpmのユーザの設定を書き換える。
`php-fpm.conf`のパスはstatusを確認するとわかる。

```bash
# systemctl status rh-php72-php-fpm
* rh-php72-php-fpm.service - The PHP FastCGI Process Manager
   Loaded: loaded (/usr/lib/systemd/system/rh-php72-php-fpm.service; enabled; vendor preset: disabled)     
   Active: active (running) since Sat 2021-01-16 20:41:35 JST; 37min ago
 Main PID: 21104 (php-fpm)
   Status: "Processes active: 0, idle: 10, Requests: 0, slow: 0, Traffic: 0req/sec"
   CGroup: /system.slice/rh-php72-php-fpm.service
           |-21104 php-fpm: master process (/etc/opt/rh/rh-php72/php-fpm.conf)
           |-21110 php-fpm: pool www
```

`/etc/opt/rh/rh-php72/php-fpm.conf`だとわかりました。
ただし、ユーザの設定は`/etc/opt/rh/rh-php72/php-fpm.d/zabbix.conf`のファイルで設定します。

一応、Nginxのユーザ名を確認しておく。
`/etc/nginx/nginx.conf`の最初の行に`user nginx;`とあるのでユーザ名が`nginx`であるとわかりました。

▼`zabbix.conf`のユーザを変更します。
```bash
$ sudo vi /etc/opt/rh/rh-php72/php-fpm.d/zabbix.conf
[zabbix]
# user = apache
# group = apache
user = nginx
group = nginx

listen = /var/opt/rh/rh-php72/run/php-fpm/zabbix.sock
# listen.acl_users = apache
listen.acl_users = nginx
listen.allowed_clients = 127.0.0.1
```
どうやら初期設定がApache用になっていたようです。
これでこのエラーは解決出来ましたが、他にもApacheユーザになっていそうです。

### HTTP ERROR 500
```bash
# tail /var/log/nginx/error.log | grep zabbix
2021/01/16 22:45:03 [error] 21109#21109: *865 FastCGI sent in stderr: "PHP message: PHP Warning:  session_start(): open(/var/opt/rh/rh-php72/lib/php/session//sess_qa6cgi9qqr3al256qeslgjef4s, O_RDWR) failed: Permission denied (13) in /usr/share/zabbix/include/classes/core/CSession.php on line 45
PHP message: PHP Warning:  session_start(): Failed to read session data: files (path: /var/opt/rh/rh-php72/lib/php/session/) in /usr/share/zabbix/include/classes/core/CSession.php on line 45
PHP message: PHP Fatal error:  Uncaught Exception: Cannot start session. in /usr/share/zabbix/include/classes/core/CSession.php:46
#0 /usr/share/zabbix/setup.php(67): CSession::start()
  thrown in /usr/share/zabbix/include/classes/core/CSession.php on line 46" while reading response header from upstream, client: 220.213.202.52, server: zabbix.suzu6.net, request: "GET /setup.php HTTP/1.1", upstream: "fastcgi://unix:/var/opt/rh/rh-php72/run/php-fpm/zabbix.sock:", host: "zabbix.suzu6.net"
```

PHPのクラスでエラーが起きているようです。

▼権限を確認します。
```bash
# ll /usr/share/zabbix/include/classes/core/CSession.php
-rw-r--r-- 1 root root 3212 Dec 21 18:38 /usr/share/zabbix/include/classes/core/CSession.php
```

`/usr/share/zabbix`以下が644になっているので実行権限を与えて755にする。

```bash
# 実行権限を与える
$ sudo chmod 755 -R /usr/share/zabbix
# Nginxユーザを設定
$ sudo chown -R root:nginx /usr/share/zabbix
```

また確認すると、`# ll -al /var/opt/rh/rh-php72/lib/php/`も`drwxrwx--- 2 root apache`となっていました。こちらもユーザを変更します。

```bash
$ sudo chown -R root:nginx /var/opt/rh/rh-php72/lib/php/*
```

以上でZabbixがエラーなしで動くようになりました！


ZabbixでNginxを監視する設定

Zabbixのインストール@CentOS7

Zabbixのインストール時のエラー