Metrics and Metadata

OS Metrics

• amplify.agent.status

• amplify.agent.cpu.system
• amplify.agent.cpu.user

• amplify.agent.mem.rss
• amplify.agent.mem.vms

• system.cpu.idle
• system.cpu.iowait
• system.cpu.system
• system.cpu.user

• system.cpu.stolen

• system.disk.free
• system.disk.total
• system.disk.used

• system.disk.in_use

• system.io.iops_r
• system.io.iops_w

• system.io.kbs_r
• system.io.kbs_w

• system.io.wait_r
• system.io.wait_w

• system.load.1
• system.load.5
• system.load.15

• system.mem.available
• system.mem.buffered
• system.mem.cached
• system.mem.free
• system.mem.shared
• system.mem.total
• system.mem.used

• system.mem.pct_used

• system.net.bytes_rcvd
• system.net.bytes_sent

• system.net.drops_in.count
• system.net.drops_out.count

• system.net.packets_in.count
• system.net.packets_out.count

• system.net.packets_in.error
• system.net.packets_out.error

• system.net.listen_overflows

• system.swap.free
• system.swap.total
• system.swap.used

• system.swap.pct_free

NGINX Metrics

HTTP Connections and Requests

• nginx.http.conn.accepted
• nginx.http.conn.dropped

• nginx.http.conn.active
• nginx.http.conn.current
• nginx.http.conn.idle

• nginx.http.request.count

• nginx.http.request.current
• nginx.http.request.reading
• nginx.http.request.writing

• nginx.http.request.malformed

• nginx.http.request.body_bytes_sent

HTTP Methods

• nginx.http.method.get
• nginx.http.method.head
• nginx.http.method.post
• nginx.http.method.put
• nginx.http.method.delete
• nginx.http.method.options

HTTP Status Codes

• nginx.http.status.1xx
• nginx.http.status.2xx
• nginx.http.status.3xx
• nginx.http.status.4xx
• nginx.http.status.5xx

• nginx.http.status.403
• nginx.http.status.404
• nginx.http.status.500
• nginx.http.status.502
• nginx.http.status.503
• nginx.http.status.504

• nginx.http.status.discarded

HTTP Protocol Versions

• nginx.http.v0_9
• nginx.http.v1_0
• nginx.http.v1_1
• nginx.http.v2

NGINX Process Metrics

• nginx.workers.count

• nginx.workers.cpu.system
• nginx.workers.cpu.total
• nginx.workers.cpu.user

• nginx.workers.fds_count

• nginx.workers.io.kbs_r
• nginx.workers.io.kbs_w

• nginx.workers.mem.rss
• nginx.workers.mem.vms

• nginx.workers.mem.rss_pct

• nginx.workers.rlimit_nofile

Additional NGINX Metrics

• The access.log log format should include an extended set of NGINX variables. Please add a new log format or modify the existing one — and use it with the access_log directives in your NGINX configuration.
  log_format main_ext '$remote_addr - $remote_user [$time_local] "$request" ' '$status $body_bytes_sent "$http_referer" ' '"$http_user_agent" "$http_x_forwarded_for" ' '"$host" sn="$server_name" ' 'rt=$request_time ' 'ua="$upstream_addr" us="$upstream_status" ' 'ut="$upstream_response_time" ul="$upstream_response_length" ' 'cs=$upstream_cache_status' ;
• Here's how you may use the extended log format with your access log configuration:
  access_log /var/log/nginx/access.log main_ext;
  Note. Please bear in mind that by default the agent will process all access logs that are found in your log directory. If you define a new log file with the extended log format that will contain the entries being already logged to another access log, your metrics might be counted twice. Please refer to the agent configuration section above to learn how to exclude specific log files from processing.
• The error.log log level should be set to warn.
  error_log /var/log/nginx/error.log warn;
  Note. Don't forget to reload your NGINX configuration with either kill -HUP or service nginx reload.

• nginx.http.request.bytes_sent

• nginx.http.request.length

• nginx.http.request.time
• nginx.http.request.time.count
• nginx.http.request.time.max
• nginx.http.request.time.median
• nginx.http.request.time.pctl95

• nginx.http.request.buffered

• nginx.http.gzip.ratio

Upstream Metrics

Cache Metrics

NGINX Plus Metrics

Server Zone Metrics

Upstream Zone Metrics

Cache Zone Metrics

Stream Zone Metrics

Slab Zone Metrics

Other metrics

PHP-FPM metrics

1. Make sure that your PHP-FPM status is enabled for at least one pool — if it's not, uncomment the pm.status_path directive for the pool. For PHP7 on Ubuntu, look inside the /etc/php/7.0/fpm/pool.d directory to find the pool configuration files. After you've uncommented the pm.status_path, please make sure to restart PHP-FPM.
   # service php7.0-fpm restart
2. This step is very important! Check that NGINX, the Amplify Agent, and the PHP-FPM workers are all run under the same user ID (e.g. www-data). You may have to change the used ID for the nginx workers, fix the nginx directories permissions, and then restart the agent too. If there are multiple PHP-FPM pools configured with different user IDs, make sure the agent's user ID is included in the group IDs of the PHP-FPM workers. This is required in order for the agent to access the PHP-FPM pool socket when querying for metrics.
3. Check that the listen socket for the PHP-FPM pool you want to monitor, and for which you enabled pm.status_path, is properly configured with listen.owner and listen.group. Look for the following directives inside the pool configuration file.
   listen.owner = www-data listen.group = www-data listen.mode = 0660
4. Check that the PHP-FPM listen socket for the pool exists and has the right permissions.
   # ls -la /var/run/php/php7.0-fpm.sock srw-rw---- 1 www-data www-data 0 May 18 14:02 /var/run/php/php7.0-fpm.sock
5. Check that you can query the PHP-FPM status for the pool from the command line:
   # SCRIPT_NAME=/status SCRIPT_FILENAME=/status QUERY_STRING= REQUEST_METHOD=GET cgi-fcgi -bind -connect /var/run/php/php7.0-fpm.sock
   and that the above command returns a valid set of PHP-FPM metrics.
   Note. The cgi-fcgi tool has to be installed separately, usually from the libfcgi-dev package. This tool is not required for the agent to collect and report PHP-FPM metrics, however it can be used to quickly diagnose possible issues with PHP-FPM metric collection.
6. If your PHP-FPM is configured to use a TCP socket instead of a Unix domain socket, make sure you can query the PHP-FPM metrics manually with cgi-fcgi. Double check that your TCP socket configuration is secure (ideally, PHP-FPM pool listening on 127.0.0.1, and listen.allowed_clients enabled as well).
7. Update the agent to the most recent version.
8. Check that the following options are set in /etc/amplify-agent/agent.conf
   [extensions] phpfpm = True
9. Restart the agent.
   # service amplify-agent restart

• No status enabled for any of the pools.
• Different user IDs used by the agent and the PHP-FPM workers, or lack of a single group (when using PHP-FPM with a Unix domain socket).
• Wrong permissions configured for the PHP-FPM listen socket (when using PHP-FPM with a Unix domain socket).
• Agent can't connect to the TCP socket (when using PHP-FPM with a TCP socket).
• Agent can't parse the PHP-FPM configuration. A possible workaround is to not have any ungrouped directives. Try to move any ungrouped directives under [global] and pool section headers.

• php.fpm.conn.accepted

• php.fpm.queue.current

• php.fpm.queue.max

• php.fpm.queue.len

• php.fpm.proc.idle

• php.fpm.proc.active

• php.fpm.proc.total

• php.fpm.proc.max_active

• php.fpm.proc.max_child

• php.fpm.slow_req

MySQL metrics

1. Create a new user for the Amplify agent.
   $ mysql -u root -p [..] mysql> CREATE USER 'amplify-agent'@'localhost' IDENTIFIED BY 'xxxxxx'; Query OK, 0 rows affected (0.01 sec)
2. Check that the user can read MySQL metrics.
   $ mysql -u amplify-agent -p .. mysql> show global status; +-----------------------------------------------+--------------------------------------------------+ | Variable_name | Value | +-----------------------------------------------+--------------------------------------------------+ | Aborted_clients | 0 | .. | Uptime_since_flush_status | 1993 | +-----------------------------------------------+--------------------------------------------------+ 353 rows in set (0.01 sec)
   Note. The agent doesn't use mysql(1) for metric collection, however it implements a similar query mechanism via a Python module.
3. Update the agent to the most recent version.
4. Add the following to /etc/amplify-agent/agent.conf
   [extensions] .. mysql = True [mysql] #host = #port = unix_socket = /var/run/mysqld/mysqld.sock user = amplify-agent password = xxxxxx
   where the password option mirrors the password from the step #1 above.
5. Restart the agent.
   # service amplify-agent restart

• mysql.global.connections

• mysql.global.questions

• mysql.global.select

• mysql.global.insert

• mysql.global.update

• mysql.global.delete

• mysql.global.writes

• mysql.global.commit

• mysql.global.slow_queries

• mysql.global.uptime

• mysql.global.aborted_connects

• mysql.global.innodb_buffer_pool_read_requests

• mysql.global.innodb_buffer_pool_reads

• mysql.global.innodb_buffer_pool.hit_ratio

• mysql.global.innodb_buffer_pool_pages_total

• mysql.global.innodb_buffer_pool_pages_free

• mysql.global.innodb_buffer_pool_util

• mysql.global.threads_connected

• mysql.global.threads_running