New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

nginx-ingress-controller

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

This check monitors the kubernetes NGINX Ingress Controller.

Setup

Installation

The nginx-ingress-controller check is included in the Datadog Agent package, so you do not need to install anything else on your server.

Configuration

Metric collection

  1. Edit the nginx_ingress_controller.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your NGINX ingress controller metrics. See the sample nginx_ingress_controller.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Log collection

Gather your logs from NGINX Ingress Controller, including Weave NPC and Weave Kube and send them to Datadog.

Available for Agent >6.0

  1. Collecting logs is disabled by default in the Datadog Agent. Enable it in your daemonset configuration:

      (...)
        env:
          (...)
          - name: DD_LOGS_ENABLED
              value: "true"
          - name: DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL
              value: "true"
      (...)
    
  2. Make sure that the Docker socket is mounted to the Datadog Agent as done in this manifest.

  3. Restart the Agent.

Configuration of the NGINX check (optional)

By default, NGINX metrics are collected by the nginx-ingress-controller check, but for convenience you might want to run the regular nginx check on the ingress controller.

You can achieve this by making the NGINX status page reachable from the Agent. To do this, use the nginx-status-ipv4-whitelist setting on the controller and add Autodiscovery annotations to the controller pod.

For example these annotations, enable both the nginx and nginx-ingress-controller checks and the log collection:

ad.datadoghq.com/nginx-ingress-controller.check_names: '["nginx","nginx_ingress_controller"]'
ad.datadoghq.com/nginx-ingress-controller.init_configs: '[{},{}]'
ad.datadoghq.com/nginx-ingress-controller.instances: '[{"nginx_status_url": "http://%%host%%:%%port%%/nginx_status"},{"prometheus_url": "http://%%host%%:10254/metrics"}]'
ad.datadoghq.com/nginx-ingress-controller.logs: '[{"service": "controller", "source":"nginx-ingress-controller"}]'

Validation

Run the Agent’s status subcommand and look for nginx_ingress_controller under the Checks section.

Data Collected

Metrics

nginx_ingress.nginx.connections.current
(gauge)
Current number of client connections with state
Shown as connection
nginx_ingress.nginx.connections.total
(counter)
Total number of connections with state
Shown as connection
nginx_ingress.nginx.requests.total
(counter)
Total number of client requests
Shown as request
nginx_ingress.nginx.process.count
(gauge)
Number of nginx processes
Shown as process
nginx_ingress.nginx.bytes.read
(counter)
Number of bytes read
Shown as byte
nginx_ingress.nginx.bytes.write
(counter)
Number of bytes written
Shown as byte
nginx_ingress.nginx.cpu.time
(counter)
Cpu usage in seconds
Shown as second
nginx_ingress.nginx.mem.resident
(gauge)
Resident memory size in bytes
Shown as byte
nginx_ingress.nginx.mem.virtual
(gauge)
Virtual memory size in bytes
Shown as byte
nginx_ingress.controller.reload.success
(counter)
Cumulative number of Ingress controller reload operations
nginx_ingress.controller.upstream.latency.count
(gauge)
Count of upstream service latency per Ingress
nginx_ingress.controller.upstream.latency.sum
(gauge)
Sum of upstream service latency per Ingress
Shown as second
nginx_ingress.controller.upstream.latency.quantile
(gauge)
Quantiles of upstream service latency per Ingress
Shown as second
nginx_ingress.controller.requests
(counter)
The total number of client requests
Shown as request
nginx_ingress.controller.cpu.time
(counter)
Cpu usage in seconds
Shown as second
nginx_ingress.controller.mem.resident
(gauge)
Resident memory size in bytes
Shown as byte
nginx_ingress.controller.mem.virtual
(gauge)
Virtual memory size in bytes
Shown as byte

Events

The NGINX Ingress Controller does not include any events.

Service Checks

The NGINX Ingress Controller does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!