vhost_traffic_status_display_sum_key
The 'vhost_traffic_status_display_sum_key' directive is used to control the summary keys displayed in the virtual host traffic status information.
Description
The 'vhost_traffic_status_display_sum_key' directive allows users to specify a single argument that denotes the summary key to be displayed in the traffic status report generated by the NGINX virtual host traffic status module. This directive can be defined within server or location contexts, providing flexibility for displaying traffic data based on different virtual host configurations. The summary keys are essential for presenting aggregate traffic metrics such as requests, bytes sent, or connections established across different virtual hosts on the server.
When the directive is set, it alters the default behavior of the traffic status display, enabling the inclusion or exclusion of specific metrics based on the defined summary key. The specified key must be valid and recognized by the module; otherwise, the directive will not have any effect. This functionality is especially helpful for fine-tuning the monitoring and analytics displayed in scenarios where multiple virtual hosts are managed, allowing administrators to pinpoint performance metrics that are most relevant to them.
Overall, 'vhost_traffic_status_display_sum_key' enhances the granularity of traffic monitoring within NGINX, enabling easier diagnostics and performance tuning for web applications, while also allowing for customizable reporting based on specified key metrics.
Config Example
server {
listen 80;
server_name example.com;
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_sum_key requests;
}
}Ensure that the specified key is valid and supported by the module, otherwise it may not produce any output.
Remember to include the 'vhost_traffic_status_display' directive to activate the display functionality, or else this directive will have no effect.