nginxreceiver

README

Nginx Receiver

This receiver can fetch stats from a Nginx instance using a mod_status endpoint.

🚧 This receiver is currently in BETA.

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.

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() component.ReceiverFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a factory for nginx receiver.

Types

type Config

type Config struct {
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	confighttp.HTTPClientSettings           `mapstructure:",squash"`
	Metrics                                 metadata.MetricsSettings `mapstructure:"metrics"`
}