vhost_traffic_status_filter_max_node

The `vhost_traffic_status_filter_max_node` directive limits the maximum number of nodes displayed in the virtual host traffic status.

Syntaxvhost_traffic_status_filter_max_node number;
Defaultnone
Contexthttp
Arguments1+

Description

The vhost_traffic_status_filter_max_node directive is used within the NGINX virtual host traffic status module to specify the maximum number of nodes that can be included in the traffic statistics reporting. By setting this directive, administrators can control the volume of data returned when querying the traffic status. This is particularly useful for managing performance and ensuring that the status output remains concise and manageable, especially in environments with numerous upstream nodes.

The parameter for this directive accepts one or more integer values, which define the caps on the number of nodes displayed. If the number of nodes exceeds this limit, the output is truncated, omitting additional nodes from the report. This can be configured per virtual host context, giving granular control over which stats are reported. Note that if you specify a very low limit, it may hinder the diagnostic capabilities of the traffic status module.

The directive should be placed at the http level in the configuration file, ensuring it applies to all virtual hosts defined within that context. Properly tuning this setting is paramount for optimizing performance while maintaining visibility into traffic distribution across nodes.

Config Example

http {
    vhost_traffic_status_filter_max_node 10;
    # Other configurations...
}

Setting the limit too low may cause important data to be excluded from reports.

Ensure that you monitor the filtering effect on your status outputs regularly to avoid missing critical information.

← Back to all directives