nginx

README

nginx_exporter

NGINX (OSS) Exporter for Prometheus

Development

$ make

Usage:
  help                      Show help message
  dox                       Run tests with gotestdox
  test                      Run tests
  vet                       Run go vet
  check                     Run staticcheck analyzer
  cover                     Run unit tests and generate test coverage report
  tidy                      Run go mod tidy

Documentation

Overview

Package nginx is the Nginx (OSS) exporter for Prometheus.

Index

• func Main() int
• type Connections
  • func ParseStats(r io.Reader) (Connections, error)

Functions

func Main

func Main() int

Types

type Connections

type Connections struct {
	// The current number of active client connections including Waiting connections.
	Active int
	// The total number of accepted client connections.
	Accepted int
	// The total number of handled connections.
	Handled int
	// The total number of client requests.
	Requests int
	// The current number of connections where nginx is reading the request header.
	Reading int
	// The current number of connections where nginx is writing the response back to the client.
	Writing int
	// The current number of idle client connections waiting for a request.
	Waiting int
}

Connections represents NGINX OSS connection statistics.

func ParseStats

func ParseStats(r io.Reader) (Connections, error)

ParseStats takes a reader and returns server statistics (connections).