nginx

package

v0.52.2 Latest Latest Go to latest Published: Apr 19, 2023 License: GPL-3.0 Imports: 11 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/netdata/go.d.plugin

Links

Open Source Insights

README ¶

NGINX collector

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.

Metrics

All metrics have "nginx." prefix.

Metric	Scope	Dimensions	Units
connections	global	active	connections
connections_status	global	reading, writing, idle	connections
connections_accepted_handled	global	accepted, handled	connections/s
requests	global	requests	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

To troubleshoot issues with the nginx collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].
```
cd /usr/libexec/netdata/plugins.d/
```
Switch to the netdata user.
```
sudo -u netdata -s
```
Run the go.d.plugin to debug the collector:
```
./go.d.plugin -d -m nginx
```

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Charts ¶

type Charts = module.Charts

Charts is an alias for module.Charts

type Config ¶ added in v0.5.0

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL