auth

password

strategy

The token to use for bearer authentication

token

user

HTTP/HTTPS endpoint to Nginx server with enabled `ngx_http_stub_status_module` module.

endpoints

The namespace of metrics. Disabled if empty.

namespace

Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.

proxy

enabled

http

https

A list of hosts to avoid proxying. Allowed patterns here include:

Pattern | Example match
:-------|:-------------
Domain names | `example.com` matches requests to `example.com`
Wildcard domains | `.example.com` matches requests to `example.com` and its subdomains
IP addresses | `127.0.0.1` matches requests to 127.0.0.1
[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) blocks | `192.168.0.0./16` matches requests to any IP addresses in this range
Splat | `*` matches all hosts

no_proxy

scrape_interval_secs

Configures the TLS options for incoming connections.

Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an inline CA certificate in PEM format.

ca_file

Absolute path to a certificate file used to identify this connection, in DER or PEM format (X.509) or PKCS#12, or an inline certificate in PEM format. If this is set and is not a PKCS#12 archive, `key_file` must also be set.

crt_file

Enable TLS during connections to the remote.

Absolute path to a private key file used to identify this connection, in DER or PEM format (PKCS#8), or an inline private key in PEM format. If this is set, `crt_file` must also be set.

key_file

Pass phrase used to unlock the encrypted key file. This has no effect unless `key_file` is set.

key_pass

If `true` (the default), Vector will validate the TLS certificate of the remote host.

verify_certificate

If `true` (the default), Vector will validate the configured remote host name against the remote host's TLS certificate. Do NOT set this to `false` unless you understand the risks of not verifying the remote hostname.

verify_hostname

The component type. This is a required field for all components and tells Vector which component to use.

type

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level,
this one will be overriden.

The lowercase variant has priority over the uppercase one.

HTTPS_PROXY

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level,
this one will be overridden.

The lowercase variant has priority over the uppercase one.

HTTP_PROXY

List of hosts to avoid proxying globally.

Allowed patterns here include:
	- Domain names. For example, `example.com` will match requests to to `example.com`
	- Wildcard domains. For example, `.example.com` will match requests to `example.com` and its subdomains
	- IP addresses. For example, `127.0.0.1` will match requests to 127.0.0.1
	- CIDR blocks. For example, `192.168.0.0./16` will match requests to any IP addresses in this range
	- `*` will match all hosts

If another no_proxy value is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

NO_PROXY

http_proxy

https_proxy

Nginx ngx_http_stub_status_module module

[Nginx](https://www.nginx.com/) is an HTTP and reverse proxy server, a mail proxy server, and a generic TCP/UDP proxy server.

Nginx

By default, the `nginx_metrics` source augments events with helpful
context keys.

context

Context

The [ngx_http_stub_status_module]9http://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
module provides access to basic status information. Basic status
information is a simple web page with text data.

mod_status

Module `ngx_http_stub_status_module`

This component is stateless, meaning its behavior is consistent across each input.

state

State

nginx_metrics

The total number of accepted client connections.

connections_accepted_total

The current number of active client connections including `Waiting` connections.

connections_active

The total number of handled connections. Generally, the parameter value is the same as `accepts` unless some resource limits have been reached (for example, the `worker_connections` limit).

connections_handled_total

The current number of connections where nginx is reading the request header.

connections_reading

The current number of idle client connections waiting for a request.

connections_waiting

The current number of connections where nginx is writing the response back to the client.

connections_writing

http_requests_total

The total number of metrics collections completed for this component.

collect_completed_total

The duration spent collecting of metrics for this component.

collect_duration_seconds

The number of events accepted by this component either from tagged
origin like file and uri, or cumulatively from other origins.

events_in_total

The total number of events emitted by this component.

events_out_total

The total number of HTTP request errors for this component.

http_request_errors_total

The total number of errors parsing metrics for this component.

parse_errors_total

A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.

Nginx Metrics

Configuration Options

Required Options

endpoints(required)

type(required)

Advanced Options

scrape_interval_secs(optional)

namespace(optional)

tls(optional)

proxy(optional)

auth(optional)

How it Works

Module `ngx_http_stub_status_module`

State

Context