vod_performance_counters

The `vod_performance_counters` directive enables performance monitoring for the NGINX-based Video on Demand (VOD) module.

Syntaxvod_performance_counters on | off;
Defaultoff
Contexthttp, server, location
Arguments1

Description

The vod_performance_counters directive, when enabled, allows the NGINX VOD Packager module to track and log performance metrics related to the video processing tasks. This includes data about buffering, encoding times, and other statistics that help administrators analyze the performance of their streaming setups. By activating this feature, users can gain insights into potential bottlenecks and optimize their configurations for better playback experiences.

The directive accepts one argument, typically a boolean value (on or off). When set to 'on', the performance counters are collected and made available in NGINX logs or through the status monitoring system. This insight can be crucial for maintaining efficient operations, troubleshooting issues, and understanding user interactions with video content. The flexibility of using this directive in different contexts (http, server, or location) allows for fine-tuning depending on the deployment requirements and specific video serving paths.

Using this directive effectively requires understanding the specific performance metrics that will be monitored and ensuring that the logging level in NGINX is set appropriately to capture these details. Dependencies may also arise depending on the NGINX version and other configurations, so it is essential to refer to the module's documentation for best practices.

Config Example

http {
    vod_performance_counters on;

    server {
        location /vod {
            # other VOD configurations
        }
    }
}

Ensure the NGINX log_format is properly set up to capture performance counters; otherwise, metrics may not appear in the logs.

Be cautious about enabling performance counters in production environments as extensive logging can impact performance.

← Back to all directives