NAME

       prometheus-nginx-exporter - NGINX Prometheus exporter.

SYNOPSIS

       prometheus-nginx-exporter [option...]

DESCRIPTION

       NGINX  Prometheus  exporter  makes  it  possible  to  monitor  NGINX  or  NGINX Plus using
       Prometheus.

       NGINX exposes a handful of metrics via the stub_status page.  NGINX Plus provides a richer
       set of metrics via the API and the monitoring dashboard. NGINX Prometheus exporter fetches
       the metrics from a single NGINX or NGINX  Plus,  converts  the  metrics  into  appropriate
       Prometheus  metrics  types  and finally exposes them via an HTTP server to be collected by
       Prometheus.

OPTIONS

       -nginx.plus
              Start the exporter for NGINX Plus. By default, the exporter is started  for  NGINX.
              The default value can be overwritten by NGINX_PLUS environment variable.

       -nginx.retries uint
              A  number  of  retries  the  exporter  will  make  on start to connect to the NGINX
              stub_status page/NGINX Plus API before exiting with an error. The default value can
              be overwritten by NGINX_RETRIES environment variable.

       -nginx.retry-interval value
              An interval between retries to connect to the NGINX stub_status page/NGINX Plus API
              on start. The default value can be overwritten by NGINX_RETRY_INTERVAL  environment
              variable. (default 5s).

       -nginx.scrape-uri string
              A  URI  or  unix  domain socket path for scraping NGINX or NGINX Plus metrics.  For
              NGINX, the stub_status page must be available through the URI. For  NGINX  Plus  --
              the  API.  The default value can be overwritten by SCRAPE_URI environment variable.
              (default "http://127.0.0.1:8080/stub_status").

       -nginx.ssl-ca-cert string
              Path to the PEM encoded CA certificate  file  used  to  validate  the  servers  SSL
              certificate.  The  default  value  can  be  overwritten  by SSL_CA_CERT environment
              variable.

       -nginx.ssl-client-cert string
              Path to the PEM encoded client certificate file  to  use  when  connecting  to  the
              server.  The  default  value  can  be  overwritten  by  SSL_CLIENT_CERT environment
              variable.

       -nginx.ssl-client-key string
              Path to the PEM encoded client certificate key file to use when connecting  to  the
              server.  The  default  value  can  be  overwritten  by  SSL_CLIENT_KEY  environment
              variable.

       -nginx.ssl-verify
              Perform SSL certificate verification. The  default  value  can  be  overwritten  by
              SSL_VERIFY environment variable. (default true).

       -nginx.timeout value
              A  timeout  for scraping metrics from NGINX or NGINX Plus. The default value can be
              overwritten by TIMEOUT environment variable. (default 5s).

       -prometheus.const-labels value
              A comma separated list of constant labels that will be used in every metric. Format
              is   label1=value1,label2=value2...   The  default  value  can  be  overwritten  by
              CONST_LABELS environment variable.

       -web.listen-address string
              An address or unix domain socket path to listen on for web interface and telemetry.
              The  default  value  can  be  overwritten  by  LISTEN_ADDRESS environment variable.
              (default ":9113").

       -web.secured-metrics
              Expose metrics using https. The default value can be overwritten by SECURED_METRICS
              variable.

       -web.ssl-server-cert string
              Path  to  the  PEM  encoded  certificate for the nginx-exporter metrics server(when
              web.secured-metrics=true). The default value can be overwritten by  SSL_SERVER_CERT
              variable.

SEE ALSO

       nginx(8), prometheus(1)

AUTHOR

       NGINX, Inc.