无人机蜂群>> nginx-stat-module>> 返回
项目作者： dedok

项目描述 ：
A nginx module for collecting location stats into a specified engine.
高级语言： C
项目地址: git://github.com/dedok/nginx-stat-module.git
创建时间： 2018-05-23T11:15:53Z
项目社区：https://github.com/dedok/nginx-stat-module
开源协议：Other
下载


nginx-stat-module

A nginx module for collecting location stats into a specified engine.

This module use shared memory segment to collect aggregated stats from all workers
and send calculated values for last minute to a specefied engine every 60s (default)
over UDP or TCP in non-blocking way.

Stats aggegation made on the fly in fixed size buffer allocated on server
start and does’t affect server perfomance.

You can build this module as a dynamic one.

Some parts are based on graphite-nginx-module

Note. This module is not distributed with the Nginx source.

Requirements

  • nginx: 1.2.0 - 1.x.x

Features

  • Aggregation of location, server or http metrics
  • Calculation of percentiles
  • Sending data to:
  • Influx over UDP or TCP in non-blocking way

Versions

  • v0.0.1 - beta.

Contents

Directives

stat_config

syntax: stat_config [key1= key2= … keyN=]

context: http

Specify global settings for a whole server instance.

Param Required Default Description
host gethostname() host name for all tag
server Yes an engine server IP address
protocol Yes an engine type
port 2003 an engine server port
frequency 60 how often send values to the engine
intervals 1m aggregation intervals, time interval list, vertical bar separator (m - minutes)
params * limit metrics list to track, vertical bar separator
shared 2m shared memory size, increase in case of too small shared memory error
buffer 64k network buffer size, increase in case of too small buffer size error
package 1400 maximum UDP packet size
template template for graph name (default is $prefix.$host.$split.$param_$interval)

Example:

  1. http {
  2.   stat_config
  3.      protocol=influx/udp
  4.      server=127.0.0.1:8089
  5.      frequency=1
  6.      ;
  7. }

Back to contents

stat_default

syntax: stat_default [params=] [if=]

context: http, server

Create measurement point in all nested locations.
You can use “$location” variable which represents the name of the current location with all non-alphanumeric characters replaced with “_.” Leading and trailing “_“ are deleted.

Example:

  1.    stat_default nginx.$location;
  3.    location /foo/ {
  4.    }
  6.    location /bar/ {
  7.    }

Data for /foo/ will be sent to nginx.foo, data for /bar/ - to nginx.bar.
The <params> parameter (1.3.0) specifies list of params to be collected for all nested locations. To add all default params, use *.
The <if> parameter (1.1.0) enables conditional logging. A request will not be logged if the condition evaluates to “0” or an empty string.

Back to contents

stat

syntax: stat [params=] [if=]

context: http, server, location, if

Create measurement point in specific location.

Example:

  1.     location /foo/ {
  2.         stat nginx.foo;
  3.     }

The <params> parameter (1.3.0) specifies list of params to be collected for this location. To add all default params, use *.
The <if> parameter (1.1.0) enables conditional logging. A request will not be logged if the condition evaluates to “0” or an empty string.

Example:

  1.     map $scheme $is_http { http 1; }
  2.     map $scheme $is_https { https 1; }
  3.     # ...
  4.     location /bar/ {
  5.         stat nginx.all.bar;
  6.         stat nginx.http.bar if=$is_http;
  7.         stat nginx.https.bar if=$is_https;
  8.         stat nginx.arg params=rps|request_time;
  9.         stat nginx.ext params=*|rps|request_time;
  10.     }

Back to contents

stat_param

syntax: stat_param name= interval=

context: location

Param Required Description
name Yes path prefix for all graphs
interval Yes* aggregation interval, time intrval value format (m - minutes)
aggregate Yes* aggregation function on values
percentile Yes* percentile level

Aggregate functions

func Description
sum sum of values per interval
persec sum of values per second (sum devided on seconds in interval)
avg average value on interval

Params

Param Units Func Description
request_time ms avg total time spent on serving request
bytes_sent bytes avg http response length
body_bytes_sent bytes avg http response body length
request_length bytes avg http request length
content_time ms avg time spent generating content inside nginx
upstream_time ms avg time spent tailking with upstream
upstream_connect_time ms avg time spent on upstream connect (nginx >= 1.9.1)
upstream_header_time ms avg time spent on upstream header (nginx >= 1.9.1)
rps rps sum total requests number per aggregation interval
keepalive_rps rps sum requests number sent over previously opened keepalive connection
response_2xx_rps rps sum total responses number with 2xx code
response_3xx_rps rps sum total responses number with 3xx code
response_4xx_rps rps sum total responses number with 4xx code
response_5xx_rps rps sum total responses number with 5xx code
response_[0-9]{3}_rps rps sum total responses number with given code
upstream_cache_(miss\ bypass\ expired\ stale\ updating\ revalidated\ hit)_rps rps sum totar responses with a given upstream cache status

Back to contents

Percentiles

To calculate percentile value for any parameter, set percentile level via /. E.g. request_time/50|request_time/90|request_time/99.

Back to contents

How to install

Dynamic module:

  1. $> wget 'http://nginx.org/download/nginx-1.9.11.tar.gz'
  2. $> tar -xzf nginx-1.9.11.tar.gz
  3. $> cd nginx-1.9.11/
  4. $> ./configure --add-dynamic-module=/path/to/nginx-stat-module
  5. $> make
  6. $> make install

Static module:

  1. $> wget 'http://nginx.org/download/nginx-1.9.11.tar.gz'
  2. $> tar -xzf nginx-1.9.11.tar.gz
  3. $> cd nginx-1.9.11/
  4. $> ./configure --add-module=/path/to/nginx-stat-module
  5. $> make
  6. $> make install

Back to contents