nginxreceiver

README

Nginx Receiver

Status
Stability	beta: metrics
Distributions	contrib
Issues
Code Owners	@djaglowski

This receiver can fetch stats from a Nginx instance using the ngx_http_stub_status_module module's status endpoint.

Details

Configuration

Nginx Module

You must configure NGINX to expose status information by editing the NGINX configuration. Please see ngx_http_stub_status_module for a guide to configuring the NGINX stats module ngx_http_stub_status_module.

Receiver Config

ℹ This receiver is in beta and configuration fields are subject to change.

The following settings are required:

• endpoint (default: http://localhost:80/status): The URL of the nginx status endpoint

The following settings are optional:

• collection_interval (default = 10s): This receiver runs on an interval. Each time it runs, it queries nginx, creates metrics, and sends them to the next consumer. The collection_interval configuration option tells this receiver the duration between runs. This value must be a string readable by Golang's ParseDuration function (example: 1h30m). Valid time units are ns, us (or µs), ms, s, m, h.
• initial_delay (default = 1s): defines how long this receiver waits before starting.

Example:

receivers:
  nginx:
    endpoint: "http://localhost:80/status"
    collection_interval: 10s

The full list of settings exposed for this receiver are documented here with detailed sample configurations here.

Documentation

Index

• func NewFactory() receiver.Factory
• type Config

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for nginx receiver.

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	confighttp.ClientConfig        `mapstructure:",squash"`
	MetricsBuilderConfig           metadata.MetricsBuilderConfig `mapstructure:",squash"`
}