nginxplusreceiver

README

NGINX Plus Receiver

This receiver can fetch stats from a NGINX Plus instance via the ngx_http_api_module module's api endpoint.

Configuration

NGINX Module

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

Receiver Config

The following settings are required:

The following settings are required:

• api_details: Details for the NGINX Plus API endpoint.
  • url: (default: http://localhost:80/api): The URL of the NGINX Plus API endpoint.
  • listen: (default: localhost:80): The listen directive of the NGINX Plus API endpoint.
  • location: (default: /api): The location directive of the NGINX Plus API endpoint.

The following settings are optional:

• collection_interval (default = 10s): This receiver collects metrics on an interval. This value must be a string readable by Golang's time.ParseDuration. 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:
  nginxplus:
    api_details:
      url: "http://localhost:80/api"
      listen: "localhost:80"
      location: "/api"
    collection_interval: 10s

Documentation

Overview

Copyright (c) F5, Inc.

This source code is licensed under the Apache License, Version 2.0 license found in the LICENSE file in the root directory of this source tree.

Copyright (c) F5, Inc.

This source code is licensed under the Apache License, Version 2.0 license found in the LICENSE file in the root directory of this source tree.

Copyright (c) F5, Inc.

This source code is licensed under the Apache License, Version 2.0 license found in the LICENSE file in the root directory of this source tree.

Index

• func NewFactory() receiver.Factory
• type APIDetails
• type Config
  • func (cfg *Config) Validate() error
• type NginxPlusScraper
  • func (nps *NginxPlusScraper) ID() component.ID
  • func (nps *NginxPlusScraper) Scrape(ctx context.Context) (pmetric.Metrics, error)
  • func (nps *NginxPlusScraper) Shutdown(ctx context.Context) error
  • func (nps *NginxPlusScraper) Start(ctx context.Context, _ component.Host) error
• type ResponseStatuses

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type APIDetails

type APIDetails struct {
	URL      string `mapstructure:"url"`
	Listen   string `mapstructure:"listen"`
	Location string `mapstructure:"location"`
	Ca       string `mapstructure:"ca"`
}

type Config

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

func (*Config) Validate

func (cfg *Config) Validate() error

type NginxPlusScraper

type NginxPlusScraper struct {
	// contains filtered or unexported fields
}

func (*NginxPlusScraper) ID

func (nps *NginxPlusScraper) ID() component.ID

func (*NginxPlusScraper) Scrape

func (nps *NginxPlusScraper) Scrape(ctx context.Context) (pmetric.Metrics, error)

func (*NginxPlusScraper) Shutdown

func (nps *NginxPlusScraper) Shutdown(ctx context.Context) error

func (*NginxPlusScraper) Start

func (nps *NginxPlusScraper) Start(ctx context.Context, _ component.Host) error

type ResponseStatuses

type ResponseStatuses struct {
	// contains filtered or unexported fields
}