NGINX metrics

Collect metrics from NGINX

status: stable role: daemon role: sidecar delivery: at-least-once acknowledgements: no egress: batch state: stateless
output: metrics

Requirements

Module ngx_http_stub_status_module should be enabled.

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "nginx_metrics",
      "endpoints": [
        "http://localhost:8000/basic_status"
      ]
    }
  }
}
[sources.my_source_id]
type = "nginx_metrics"
endpoints = [ "http://localhost:8000/basic_status" ]

sources:
  my_source_id:
    type: nginx_metrics
    endpoints:
      - http://localhost:8000/basic_status

{
  "sources": {
    "my_source_id": {
      "type": "nginx_metrics",
      "endpoints": [
        "http://localhost:8000/basic_status"
      ],
      "namespace": "nginx",
      "scrape_interval_secs": 15
    }
  }
}
[sources.my_source_id]
type = "nginx_metrics"
endpoints = [ "http://localhost:8000/basic_status" ]
namespace = "nginx"
scrape_interval_secs = 15

sources:
  my_source_id:
    type: nginx_metrics
    endpoints:
      - http://localhost:8000/basic_status
    namespace: nginx
    scrape_interval_secs: 15

auth

optional object

Configuration of the authentication strategy for HTTP requests.

HTTP authentication should be used with HTTPS only, as the authentication credentials are passed as an HTTP header without any additional encryption beyond what is provided by the transport itself.

auth.auth

required object
The AWS authentication configuration.
Relevant when: strategy = "aws"
auth.auth.access_key_id
required string literal
The AWS access key ID.
Examples 
"AKIAIOSFODNN7EXAMPLE"
auth.auth.assume_role
required string literal
The ARN of an IAM role to assume.
Examples 
"arn:aws:iam::123456789098:role/my_role"
auth.auth.credentials_file
required string literal
Path to the credentials file.
Examples 
"/my/aws/credentials"
auth.auth.external_id
optional string literal
The optional unique external ID in conjunction with role to assume.
Examples 
"randomEXAMPLEidString"
auth.auth.imds
optional object
Configuration for authenticating with AWS through IMDS.
auth.auth.imds.connect_timeout_seconds
optional uint
Connect timeout for IMDS.
default: 1(seconds)
auth.auth.imds.max_attempts
optional uint
Number of IMDS retries for fetching tokens and metadata.
default: 4
auth.auth.imds.read_timeout_seconds
optional uint
Read timeout for IMDS.
default: 1(seconds)
auth.auth.load_timeout_secs
optional uint

Timeout for successfully loading any credentials, in seconds.

Relevant when the default credentials chain or assume_role is used.

Examples 
30
auth.auth.profile
optional string literal

The credentials profile to use.

Used to select AWS credentials from a provided credentials file.

Examples 
"develop"
default: default
auth.auth.region
optional string literal

The AWS region to send STS requests to.

If not set, this defaults to the configured region for the service itself.

Examples 
"us-west-2"
auth.auth.secret_access_key
required string literal
The AWS secret access key.
Examples 
"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
auth.auth.session_name
optional string literal

The optional RoleSessionName is a unique session identifier for your assumed role.

Should be unique per principal or reason. If not set, session name will be autogenerated like assume-role-provider-1736428351340

Examples 
"vector-indexer-role"
auth.auth.session_token
optional string literal
The AWS session token. See AWS temporary credentials
Examples 
"AQoDYXdz...AQoDYXdz..."

auth.password

required string literal
The basic authentication password.
Relevant when: strategy = "basic"
Examples 
"${PASSWORD}"
"password"

auth.service

required string literal
The AWS service name to use for signing.
Relevant when: strategy = "aws"

auth.strategy

required string literal enum
The authentication strategy to use.
Enum options
OptionDescription
awsAWS authentication.
basic

Basic authentication.

The username and password are concatenated and encoded via base64.

bearer

Bearer authentication.

The bearer token value (OAuth2, JWT, etc.) is passed as-is.

Examples 
"aws"
"basic"
"bearer"

auth.token

required string literal
The bearer authentication token.
Relevant when: strategy = "bearer"

auth.user

required string literal
The basic authentication username.
Relevant when: strategy = "basic"
Examples 
"${USERNAME}"
"username"

endpoints

required [string]

A list of NGINX instances to scrape.

Each endpoint must be a valid HTTP/HTTPS URI pointing to an NGINX instance that has the ngx_http_stub_status_module module enabled.

Array string literal
Examples 
[
  "http://localhost:8000/basic_status"
]

namespace

optional string literal

Overrides the default namespace for the metrics emitted by the source.

If set to an empty string, no namespace is added to the metrics.

By default, nginx is used.

default: nginx

proxy

optional object

Proxy configuration.

Configure to proxy traffic through an HTTP(S) proxy when making external requests.

Similar to common proxy configuration convention, you can set different proxies to use based on the type of traffic being proxied. You can also set specific hosts that should not be proxied.

proxy.enabled

optional bool
Enables proxying support.
default: true

proxy.http

optional string literal

Proxy endpoint to use when proxying HTTP traffic.

Must be a valid URI string.

Examples 
"http://foo.bar:3128"

proxy.https

optional string literal

Proxy endpoint to use when proxying HTTPS traffic.

Must be a valid URI string.

Examples 
"http://foo.bar:3128"

proxy.no_proxy

optional [string]

A list of hosts to avoid proxying.

Multiple patterns are allowed:

PatternExample match
Domain namesexample.com matches requests to example.com
Wildcard domains.example.com matches requests to example.com and its subdomains
IP addresses127.0.0.1 matches requests to 127.0.0.1
CIDR blocks192.168.0.0/16 matches requests to any IP addresses in this range
Splat* matches all hosts

scrape_interval_secs

optional uint
The interval between scrapes.
default: 15(seconds)

tls

optional object
TLS configuration.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protocols.

Declare the supported ALPN protocols, which are used during negotiation with a peer. They are prioritized in the order that they are defined.

tls.ca_file

optional string literal

Absolute path to an additional CA certificate file.

The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.

Examples 
"/path/to/certificate_authority.crt"

tls.crt_file

optional string literal

Absolute path to a certificate file used to identify this server.

The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string in PEM format.

If this is set and is not a PKCS#12 archive, key_file must also be set.

Examples 
"/path/to/host_certificate.crt"

tls.key_file

optional string literal

Absolute path to a private key file used to identify this server.

The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.

Examples 
"/path/to/host_certificate.key"

tls.key_pass

optional string literal

Passphrase used to unlock the encrypted key file.

This has no effect unless key_file is set.

Examples 
"${KEY_PASS_ENV_VAR}"
"PassWord1"

tls.server_name

optional string literal

Server name to use when using Server Name Indication (SNI).

Only relevant for outgoing connections.

Examples 
"www.example.com"

tls.verify_certificate

optional bool

Enables certificate verification. For components that create a server, this requires that the client connections have a valid client certificate. For components that initiate requests, this validates that the upstream has a valid certificate.

If enabled, certificates must not be expired and must be issued by a trusted issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and so on, until the verification process reaches a root certificate.

Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.

tls.verify_hostname

optional bool

Enables hostname verification.

If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.

Only relevant for outgoing connections.

Do NOT set this to false unless you understand the risks of not verifying the remote hostname.

Environment variables

HTTPS_PROXY

common optional string literal

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 overridden.

The lowercase variant has priority over the uppercase one.

Examples
http://foo.bar:3128

HTTP_PROXY

common optional string literal

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.

Examples
http://foo.bar:3128

NO_PROXY

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

PatternExample match
Domain namesexample.com matches requests to example.com
Wildcard domains.example.come matches requests to example.com and its subdomains
IP addresses127.0.0.1 matches requests to 127.0.0.1
CIDR blocks192.168.0.0./16 matches requests to any IP addresses in this range
Splat* matches all hosts

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

The lowercase variant has priority over the uppercase one.

Examples
localhost,.example.com,192.168.0.0./16
*

http_proxy

common optional string literal

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.

Examples
http://foo.bar:3128

https_proxy

common optional string literal

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 overridden.

The lowercase variant has priority over the uppercase one.

Examples
http://foo.bar:3128

no_proxy

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

PatternExample match
Domain namesexample.com matches requests to example.com
Wildcard domains.example.come matches requests to example.com and its subdomains
IP addresses127.0.0.1 matches requests to 127.0.0.1
CIDR blocks192.168.0.0./16 matches requests to any IP addresses in this range
Splat* matches all hosts

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

The lowercase variant has priority over the uppercase one.

Examples
localhost,.example.com,192.168.0.0./16
*

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.

Output Types

Metrics

connections_accepted_total

counter
The total number of accepted client connections.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

connections_active

gauge
The current number of active client connections including Waiting connections.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

connections_handled_total

counter
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).
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

connections_reading

gauge
The current number of connections where nginx is reading the request header.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

connections_waiting

gauge
The current number of idle client connections waiting for a request.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

connections_writing

gauge
The current number of connections where nginx is writing the response back to the client.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

http_requests_total

counter
The total number of client requests.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

up

gauge
If the Nginx server is up or not.
endpoint
Nginx endpoint.
host
The hostname of the Nginx server.

Telemetry

Metrics

link

collect_completed_total

counter
The total number of metrics collections completed for this component.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

collect_duration_seconds

histogram
The duration spent collecting of metrics for this component.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

component_discarded_events_total

counter
The number of events dropped by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
intentional
True if the events were discarded intentionally, like a filter transform, or false if due to an error.
pid optional
The process ID of the Vector instance.

component_errors_total

counter
The total number of errors encountered by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
error_type
The type of the error
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.
stage
The stage within the component at which the error occurred.

component_received_bytes_total

counter
The number of raw bytes accepted by this component from source origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_event_bytes_total

counter
The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_count

histogram

A histogram of the number of events passed in each internal batch in Vector’s internal topology.

Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.

component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_sent_event_bytes_total

counter
The total number of event bytes emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

component_sent_events_total

counter
The total number of events emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

source_lag_time_seconds

histogram
The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

How it works

Context

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

Module ngx_http_stub_status_module

The ngx_http_stub_status_module module provides access to basic status information. Basic status information is a simple web page with text data.

State

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