README
¶
Nginx Virtual Host Traffic (VTS) Input Plugin
This plugin gathers Nginx status using external virtual host traffic status module - https://github.com/vozlt/nginx-module-vts. This is an Nginx module that provides access to virtual host status information. It contains the current status such as servers, upstreams, caches. This is similar to the live activity monitoring of Nginx plus. For module configuration details please see its documentation.
Configuration
# Read Nginx virtual host traffic status module information (nginx-module-vts)
[[inputs.nginx_vts]]
## An array of ngx_http_status_module or status URI to gather stats.
urls = ["http://localhost/status"]
## HTTP response timeout (default: 5s)
response_timeout = "5s"
## Optional TLS Config
# tls_ca = "/etc/telegraf/ca.pem"
# tls_cert = "/etc/telegraf/cert.pem"
# tls_key = "/etc/telegraf/key.pem"
## Use TLS but skip chain & host verification
# insecure_skip_verify = false
Metrics
- nginx_vts_connections
- active
- reading
- writing
- waiting
- accepted
- handled
- requests
- nginx_vts_server, nginx_vts_filter
- requests
- request_time
- in_bytes
- out_bytes
- response_1xx_count
- response_2xx_count
- response_3xx_count
- response_4xx_count
- response_5xx_count
- cache_miss
- cache_bypass
- cache_expired
- cache_stale
- cache_updating
- cache_revalidated
- cache_hit
- cache_scarce
- nginx_vts_upstream
- requests
- request_time
- response_time
- in_bytes
- out_bytes
- response_1xx_count
- response_2xx_count
- response_3xx_count
- response_4xx_count
- response_5xx_count
- weight
- max_fails
- fail_timeout
- backup
- down
- nginx_vts_cache
- max_bytes
- used_bytes
- in_bytes
- out_bytes
- miss
- bypass
- expired
- stale
- updating
- revalidated
- hit
- scarce
Tags
- nginx_vts_connections
- source
- port
- nginx_vts_server
- source
- port
- zone
- nginx_vts_filter
- source
- port
- filter_name
- filter_key
- nginx_vts_upstream
- source
- port
- upstream
- upstream_address
- nginx_vts_cache
- source
- port
- zone
Example Output
Using this configuration:
[[inputs.nginx_vts]]
## An array of Nginx status URIs to gather stats.
urls = ["http://localhost/status"]
When run with:
./telegraf -config telegraf.conf -input-filter nginx_vts -test
It produces:
nginx_vts_connections,source=localhost,port=80,host=localhost waiting=30i,accepted=295333i,handled=295333i,requests=6833487i,active=33i,reading=0i,writing=3i 1518341521000000000
nginx_vts_server,zone=example.com,port=80,host=localhost,source=localhost cache_hit=158915i,in_bytes=1935528964i,out_bytes=6531366419i,response_2xx_count=809994i,response_4xx_count=16664i,cache_bypass=0i,cache_stale=0i,cache_revalidated=0i,requests=2187977i,response_1xx_count=0i,response_3xx_count=1360390i,cache_miss=2249i,cache_updating=0i,cache_scarce=0i,request_time=13i,response_5xx_count=929i,cache_expired=0i 1518341521000000000
nginx_vts_server,host=localhost,source=localhost,port=80,zone=* requests=6775284i,in_bytes=5003242389i,out_bytes=36858233827i,cache_expired=318881i,cache_updating=0i,request_time=51i,response_1xx_count=0i,response_2xx_count=4385916i,response_4xx_count=83680i,response_5xx_count=1186i,cache_bypass=0i,cache_revalidated=0i,cache_hit=1972222i,cache_scarce=0i,response_3xx_count=2304502i,cache_miss=408251i,cache_stale=0i 1518341521000000000
nginx_vts_filter,filter_key=FI,filter_name=country,port=80,host=localhost,source=localhost request_time=0i,in_bytes=139701i,response_3xx_count=0i,out_bytes=2644495i,response_1xx_count=0i,cache_expired=0i,cache_scarce=0i,requests=179i,cache_miss=0i,cache_bypass=0i,cache_stale=0i,cache_updating=0i,cache_revalidated=0i,cache_hit=0i,response_2xx_count=177i,response_4xx_count=2i,response_5xx_count=0i 1518341521000000000
nginx_vts_upstream,port=80,host=localhost,upstream=backend_cluster,upstream_address=127.0.0.1:6000,source=localhost fail_timeout=10i,backup=false,request_time=31i,response_5xx_count=1081i,response_2xx_count=1877498i,max_fails=1i,in_bytes=2763336289i,out_bytes=19470265071i,weight=1i,down=false,response_time=31i,response_1xx_count=0i,response_4xx_count=76125i,requests=3379232i,response_3xx_count=1424528i 1518341521000000000
nginx_vts_cache,source=localhost,port=80,host=localhost,zone=example stale=0i,used_bytes=64334336i,miss=394573i,bypass=0i,expired=318788i,updating=0i,revalidated=0i,hit=689883i,scarce=0i,max_bytes=9223372036854775296i,in_bytes=1111161581i,out_bytes=19175548290i 1518341521000000000
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache struct { MaxSize uint64 `json:"maxSize"` UsedSize uint64 `json:"usedSize"` InBytes uint64 `json:"inBytes"` OutBytes uint64 `json:"outBytes"` Responses struct { Miss uint64 `json:"miss"` Bypass uint64 `json:"bypass"` Expired uint64 `json:"expired"` Stale uint64 `json:"stale"` Updating uint64 `json:"updating"` Revalidated uint64 `json:"revalidated"` Hit uint64 `json:"hit"` Scarce uint64 `json:"scarce"` } `json:"responses"` }
type NginxVTS ¶
type NginxVTS struct { Urls []string `toml:"urls"` ResponseTimeout config.Duration `toml:"response_timeout"` tls.ClientConfig // contains filtered or unexported fields }
func (*NginxVTS) SampleConfig ¶
type NginxVTSResponse ¶
type NginxVTSResponse struct { Connections struct { Active uint64 `json:"active"` Reading uint64 `json:"reading"` Writing uint64 `json:"writing"` Waiting uint64 `json:"waiting"` Accepted uint64 `json:"accepted"` Handled uint64 `json:"handled"` Requests uint64 `json:"requests"` } `json:"connections"` ServerZones map[string]Server `json:"serverZones"` FilterZones map[string]map[string]Server `json:"filterZones"` UpstreamZones map[string][]Upstream `json:"upstreamZones"` CacheZones map[string]Cache `json:"cacheZones"` }
type Server ¶
type Server struct { RequestCounter uint64 `json:"requestCounter"` InBytes uint64 `json:"inBytes"` OutBytes uint64 `json:"outBytes"` RequestMsec uint64 `json:"requestMsec"` Responses struct { OneXx uint64 `json:"1xx"` TwoXx uint64 `json:"2xx"` ThreeXx uint64 `json:"3xx"` FourXx uint64 `json:"4xx"` FiveXx uint64 `json:"5xx"` Miss uint64 `json:"miss"` Bypass uint64 `json:"bypass"` Expired uint64 `json:"expired"` Stale uint64 `json:"stale"` Updating uint64 `json:"updating"` Revalidated uint64 `json:"revalidated"` Hit uint64 `json:"hit"` Scarce uint64 `json:"scarce"` } `json:"responses"` }
type Upstream ¶
type Upstream struct { Server string `json:"server"` RequestCounter uint64 `json:"requestCounter"` InBytes uint64 `json:"inBytes"` OutBytes uint64 `json:"outBytes"` Responses struct { OneXx uint64 `json:"1xx"` TwoXx uint64 `json:"2xx"` ThreeXx uint64 `json:"3xx"` FourXx uint64 `json:"4xx"` FiveXx uint64 `json:"5xx"` } `json:"responses"` ResponseMsec uint64 `json:"responseMsec"` RequestMsec uint64 `json:"requestMsec"` Weight uint64 `json:"weight"` MaxFails uint64 `json:"maxFails"` FailTimeout uint64 `json:"failTimeout"` Backup bool `json:"backup"` Down bool `json:"down"` }
Click to show internal directories.
Click to hide internal directories.