Nginx

·

NGINX collector can take many metrics from NGINX instances, such as the total number of requests, connections, cache and other metrics, and collect the metrics into Guance to help monitor and analyze various abnormal situations of NGINX.

Config¶

Requirements¶

• NGINX version >= 1.8.0; Already tested version:

  • 1.23.2
  • 1.22.1
  • 1.21.6
  • 1.18.0
  • 1.14.2
  • 1.8.0

• NGINX collects the data of http_stub_status_module by default. When the http_stub_status_module is opened, see here, which will report the data of NGINX measurements later.

• If you are using VTS or want to monitor more data, it is recommended to turn on VTS-related data collection by setting the option use_vts to true in nginx.conf. For how to start VTS, see here.

• After VTS function is turned on, the following measurements can be generated:

  • nginx
  • nginx_server_zone
  • nginx_upstream_zone (NGINX needs to configure upstream related configuration)
  • nginx_cache_zone (NGINX needs to configure cache related configuration)

• Take the example of generating the nginx_upstream_zone measurements. An example of NGINX-related configuration is as follows:

    ...
    http {
       ...
       upstream your-upstreamname {
         server upstream-ip:upstream-port;
      }
       server {
       ...
       location / {
       root  html;
       index  index.html index.htm;
       proxy_pass http://yourupstreamname;
     }}}

• After the VTS function has been turned on, it is no longer necessary to collect the data of the http_stub_status_module module, because the data of the VTS module will include the data of the http_stub_status_module module.

• NGINX Plus users can still use the http_stub_status_module to collect basic data. Additionally, http_api_module should be enabled in the NGINX configuration file (Reference) and set status_zone in the server blocks you want to monitor. The configuration example is as follows:

# enable http_api_module
server {
  listen 8080;
  location /api {
     api write=on;
  }
}
# monitor more detailed metrics
server {
  listen 80;
  status_zone <ZONE_NAME>;
  ...
}

• To enable NGINX Plus collection, you need to set the option use_plus_api to true in the nginx.conf file and uncomment the plus_api_url option. (Note: VTS does not support NGINX Plus).

• NGINX Plus can generate the following measurements:

  • nginx_location_zone

Configuration¶

[[inputs.nginx]]
  ## Nginx status URL.
  ## (Default) If not use with VTS, the formula is like this: "http://localhost:80/basic_status".
  ## If using with VTS, the formula is like this: "http://localhost:80/status/format/json".
  url = "http://localhost:80/basic_status"
  # If using Nginx Plus, this formula is like this: "http://localhost:8080/api/<api_version>".
  # Note: Nginx Plus not support VTS and should be used with http_stub_status_module (Default)
  # plus_api_url = "http://localhost:8080/api/9"

  ## Optional Can set ports as [<form>,<to>], Datakit will collect all ports.
  # ports = [80,80]

  ## Optional collection interval, default is 10s
  # interval = "30s"
  use_vts = false
  use_plus_api = false
  ## Optional TLS Config
  # tls_ca = "/xxx/ca.pem"
  # tls_cert = "/xxx/cert.cer"
  # tls_key = "/xxx/key.key"
  ## Use TLS but skip chain & host verification
  insecure_skip_verify = false
  ## HTTP response timeout (default: 5s)
  response_timeout = "20s"

  ## Set true to enable election
  election = true

# [inputs.nginx.log]
  # files = ["/var/log/nginx/access.log","/var/log/nginx/error.log"]
  ## grok pipeline script path
  # pipeline = "nginx.p"
# [inputs.nginx.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"

Metric¶

For all of the following data collections, the global election tags will added automatically, we can add extra tags in [inputs.nginx.tags] if needed:

[inputs.nginx.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

nginx¶

nginx_server_zone¶

nginx_upstream_zone¶

nginx_cache_zone¶

nginx_location_zone¶

collector¶

Custom Object¶

web_server¶

NGINX web server custom object, describing the monitored instance identity, version, uptime, and collector status.

Log¶

To collect NGINX logs, open files in nginx.conf and write to the absolute path of the NGINX log file. For example:

    [[inputs.nginx]]
      ...
      [inputs.nginx.log]
    files = ["/var/log/nginx/access.log","/var/log/nginx/error.log"]

When log collection is turned on, logs with a log source of nginx are generated by default.

Note: DataKit must be installed on the NGINX host to collect NGINX logs.

Log Pipeline Feature Cut Field Description¶

• NGINX error log cutting

Example error log text:

2021/04/21 09:24:04 [alert] 7#7: *168 write() to "/var/log/nginx/access.log" failed (28: No space left on device) while logging request, client: 120.204.196.129, server: localhost, request: "GET / HTTP/1.1", host: "47.98.103.73"

The list of cut fields is as follows:

Example of error log text:

2021/04/29 16:24:38 [emerg] 50102#0: unexpected ";" in /usr/local/etc/nginx/nginx.conf:23

The list of cut fields is as follows:

• NGINX access log cutting

Example of access log text:

127.0.0.1 - - [24/Mar/2021:13:54:19 +0800] "GET /basic_status HTTP/1.1" 200 97 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_1_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.72 Safari/537.36"

The list of cut fields is as follows:

Tracing¶

Requirements¶

• Install nginx (>=1.9.13)

This module only supports the Linux operating system

Install Nginx OpenTracing Plugin¶

The Nginx OpenTracing plugin is an open-source link tracking plugin for OpenTracing, written in C++，It's work for Jaeger、Zipkin、LightStep、Datadog.

• Download the plugin corresponding to the current Nginx version, and use the following command to view the current Nginx version

$ nginx -v
nginx version: nginx/1.18.0 (Ubuntu)

• Extract

tar zxf linux-amd64-nginx-ot16-ngx_http_module.so.tgz -C /usr/lib/nginx/modules

• Install plugin

Add the following information at the top of the nginx.conf file

load_module modules/ngx_http_opentracing_module.so;

Install DDAgent Nginx OpenTracing plugin¶

The DDAgent Nginx OpenTracing plugin is a set of vendor implementations based on Nginx OpenTracing, with different APMs having their own encoding and decoding implementations.

• Download dd-opentracing-cpp,libdd_opentracing.so or linux-amd64-libdd_opentracing_plugin.so.gz

• Configure Nginx

opentracing_load_tracer /etc/nginx/tracer/libdd_opentracing.so /etc/nginx/tracer/dd.json;
opentracing on; # Enable OpenTracing
opentracing_tag http_user_agent $http_user_agent;
opentracing_trace_locations off;
opentracing_propagate_context;
opentracing_operation_name nginx-$host;

opentracing_load_tracer ： load opentracing tracer opentracing_propagate_context; : Indicates that the link context needs to be passed

• Configure DDTrace

dd.json is used to configure ddtrace ，such as：service、agent_host, etc., the content is as follows：

{
  "environment": "test",
  "service": "nginx",
  "operation_name_override": "nginx.handle",
  "agent_host": "localhost",
  "agent_port": 9529
}

• Nginx logging configuration

Inject Trace information into Nginx logs. You can edit as follows:

log_format with_trace_id '$remote_addr - $http_x_forwarded_user [$time_local] "$request" '
                         '$status $body_bytes_sent "$http_referer" '
                         '"$http_user_agent" "$http_x_forwarded_for" '
                         '"$opentracing_context_x_datadog_trace_id" "$opentracing_context_x_datadog_parent_id"';

access_log /var/log/nginx/access-with-trace.log with_trace_id;

Note: The log_format keyword tells Nginx that there is a set of logging rules defined here, The with_trace_id is the rule name and can be modified by yourself. Please use the same name to associate the rules of the log when specifying the log path below The path and file name in access_log can be changed. Usually, the original Nginx is equipped with log rules. We can configure multiple rules and output different log formats to different files, that is, keep the original The access_log rule and path remain unchanged, and a new log rule containing trace information is added, named as a different log file for different logging tools to read.

• Verify whether the plugin is working properly

Execute the following command to verify

$:/etc/nginx# nginx -t
info: DATADOG TRACER CONFIGURATION - {"agent_url":"http://localhost:9529","analytics_enabled":false,"analytics_sample_rate":null,"date":"2023-09-25T14:33:40+0800","enabled":true,"env":"prod","lang":"cpp","lang_version":"201402","operation_name_override":"nginx.handle","report_hostname":false,"sampling_rules":"[]","service":"nginx","version":"v1.3.7"}
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

info: DATADOG TRACER CONFIGURATION Indicates that DDTrace has been successfully loaded 。

Service tracing propagate¶

After Nginx generates link information, it needs to forward the relevant request header information to the backend, which can form a link concatenation operation between Nginx and the backend.

If there is a mismatch between Nginx link information and DDTrace, it is necessary to check if this step is standardized.

The following configuration needs to be added to the location under the corresponding server

location ^~ / {
    ...
    proxy_set_header X-datadog-trace-id $opentracing_context_x_datadog_trace_id;
    proxy_set_header X-datadog-parent-id $opentracing_context_x_datadog_parent_id;
    ...
    }

Load nginx configure¶

Execute the following command to make the Nginx configuration effective:

root@liurui:/etc/nginx/tracer# nginx -s reload
info: DATADOG TRACER CONFIGURATION - {"agent_url":"http://localhost:9529","analytics_enabled":false,"analytics_sample_rate":null,"date":"2023-09-25T11:30:10+0800","enabled":true,"env":"prod","lang":"cpp","lang_version":"201402","operation_name_override":"nginx.handle","report_hostname":false,"sampling_rules":"[]","service":"nginx","version":"v1.3.7"}
root@liurui:/etc/nginx/tracer# 

If the following error occurs:

root@liurui:/etc/nginx/conf.d# nginx -s reload
info: DATADOG TRACER CONFIGURATION - {"agent_url":"http://localhost:9529","analytics_enabled":false,"analytics_sample_rate":null,"date":"2023-09-25T12:28:53+0800","enabled":true,"env":"prod","lang":"cpp","lang_version":"201402","operation_name_override":"nginx.handle","report_hostname":false,"sampling_rules":"[]","service":"nginx","version":"v1.3.7"}
nginx: [warn] could not build optimal proxy_headers_hash, you should increase either proxy_headers_hash_max_size: 512 or proxy_headers_hash_bucket_size: 64; ignoring proxy_headers_hash_bucket_size

The following configuration needs to be added to the http module of nginx.conf:

http {

    ...
    proxy_headers_hash_max_size 1024;
    proxy_headers_hash_bucket_size 128;

    ...
}