nginx

README

NGINX monitoring with Netdata

NGINX is a web server which can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.

This module will monitor one or more NGINX servers, depending on your configuration.

Requirements

• NGINX with configured ngx_http_stub_status_module.

Charts

It produces following charts:

• Active Client Connections Including Waiting Connections in connections
• Active Connections Per Status in connections
• Accepted And Handled Connections in connections/s
• Requests in requests/s

Configuration

Edit the go.d/nginx.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/nginx.conf

Needs only url to server's stub_status. Here is an example for local and remote servers:

jobs:
  - name: local
    url : http://127.0.0.1/stub_status
      
  - name: remote
    url : http://203.0.113.10/stub_status

For all available options please see module configuration file.

Troubleshooting

Check the module debug output. Run the following command as netdata user:

./go.d.plugin -d -m nginx

Documentation

Index

• type Charts
• type Config
• type Dims
• type Nginx
  • func New() *Nginx
  • func (Nginx) Charts() *Charts
  • func (n *Nginx) Check() bool
  • func (Nginx) Cleanup()
  • func (n *Nginx) Collect() map[string]int64
  • func (n *Nginx) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

Config is the Nginx module configuration.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type Nginx

type Nginx struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

Nginx nginx module.

func New

func New() *Nginx

New creates Nginx with default values.

func (Nginx) Charts

func (Nginx) Charts() *Charts

Charts creates Charts.

func (*Nginx) Check

func (n *Nginx) Check() bool

Check makes check.

func (Nginx) Cleanup

func (Nginx) Cleanup()

Cleanup makes cleanup.

func (*Nginx) Collect

func (n *Nginx) Collect() map[string]int64

Collect collects metrics.

func (*Nginx) Init

func (n *Nginx) Init() bool

Init makes initialization.