Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 5.6 KB

prometheus-nginx-vts.md

File metadata and controls

103 lines (75 loc) · 5.6 KB
Raw

prometheus/nginx-vts

Monitor Type: prometheus/nginx-vts (Source)

Accepts Endpoints: Yes

Multiple Instances Allowed: Yes

Overview

This monitor scrapes Prmoetheus Nginx VTS exporter metrics from a Prometheus exporter and sends them to SignalFx. It is a wrapper around the prometheus-exporter monitor that provides a restricted but expandable set of metrics.

Configuration

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: prometheus/nginx-vts
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
host yes string Host of the exporter
port yes integer Port of the exporter
username no string Basic Auth username to use on each request, if any.
password no string Basic Auth password to use on each request, if any.
useHTTPS no bool If true, the agent will connect to the exporter using HTTPS instead of plain HTTP. (default: false)
skipVerify no bool If useHTTPS is true and this option is also true, the exporter's TLS cert will not be verified. (default: false)
useServiceAccount no bool Use pod service account to authenticate. (default: false)
metricPath no string Path to the metrics endpoint on the exporter server, usually /metrics (the default). (default: /metrics)
sendAllMetrics no bool Send all the metrics that come out of the Prometheus exporter without any filtering. This option has no effect when using the prometheus exporter monitor directly since there is no built-in filtering, only when embedding it in other monitors. (default: false)

Metrics

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

  • nginx_vts_info (gauge)
    Nginx info
  • nginx_vts_main_connections (gauge)
    connections
  • nginx_vts_main_shm_usage_bytes (gauge)
    Shared memory [ngx_http_vhost_traffic_status] info
  • nginx_vts_server_bytes_total (cumulative)
    The request/response bytes
  • nginx_vts_server_cache_total (cumulative)
    The requests cache counter
  • nginx_vts_server_request_duration_seconds (cumulative)
    The histogram of request processing time
  • nginx_vts_server_request_seconds (gauge)
    The average of request processing times in seconds
  • nginx_vts_server_request_seconds_total (cumulative)
    The request processing time in seconds
  • nginx_vts_server_requests_total (cumulative)
    The requests counter
  • nginx_vts_start_time_seconds (gauge)
    Nginx start time
  • nginx_vts_upstream_bytes_total (cumulative)
    The request/response bytes
  • nginx_vts_upstream_request_duration_seconds (cumulative)
    The histogram of request processing time including upstream
  • nginx_vts_upstream_request_seconds (gauge)
    The average of request processing times including upstream in seconds
  • nginx_vts_upstream_request_seconds_total (cumulative)
    The request Processing time including upstream in seconds
  • nginx_vts_upstream_requests_total (cumulative)
    The upstream requests counter
  • nginx_vts_upstream_response_duration_seconds (cumulative)
    The histogram of only upstream response processing time
  • nginx_vts_upstream_response_seconds (gauge)
    The average of only upstream response processing times in seconds
  • nginx_vts_upstream_response_seconds_total (cumulative)
    The only upstream response processing time in seconds

Non-default metrics (version 4.7.0+)

The following information applies to the agent version 4.7.0+ that has enableBuiltInFiltering: true set on the top level of the agent config.

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.

Legacy non-default metrics (version < 4.7.0)

The following information only applies to agent version older than 4.7.0. If you have a newer agent and have set enableBuiltInFiltering: true at the top level of your agent config, see the section above. See upgrade instructions in Old-style whitelist filtering.

If you have a reference to the whitelist.json in your agent's top-level metricsToExclude config option, and you want to emit metrics that are not in that whitelist, then you need to add an item to the top-level metricsToInclude config option to override that whitelist (see Inclusion filtering. Or you can just copy the whitelist.json, modify it, and reference that in metricsToExclude.