stream_server_traffic_status_display_format
指令 `stream_server_traffic_status_display_format` 用于设置在 NGINX stream 服务器中显示流量状态的响应格式。
Nginx stream server traffic status module
·
serverlocation
语法stream_server_traffic_status_display_format format;
默认值json
上下文server, location
参数1
说明
指令 stream_server_traffic_status_display_format 是 NGINX stream 服务器流量状态模块的一部分，该模块提供有关 stream 服务器处理流量的统计信息。此指令允许用户指定查询流量状态时返回的响应格式。可用的格式通常包括 JSON 和 HTML。当在 server 或 location 级别设置此指令时，它将决定如何显示指标，便于对负载均衡器和其他 TCP/UDP 服务进行健康检查。
该指令有一个参数，用于定义输出格式。当对流量状态端点发起请求时，NGINX 会从共享内存中检索流量指标并根据指定的参数进行格式化。系统会检查 URI 并确保它是有效的 GET 请求，然后才继续处理。如果指定的格式无法识别或在获取统计信息时发生错误，将向客户端返回相应的错误响应。
正确实现此指令可增强管理员的可观测性，使其能够快速确定 stream 服务器的负载和性能。调整输出格式可以帮助将这些数据集成到各种监控框架或可视化工具中，使其成为有效管理 NGINX 部署的灵活选项。
配置示例
server {
listen 12345;
stream_server_traffic_status on;
stream_server_traffic_status_display_format json;
}⚠
确保设置正确的格式字符串；常见格式包括 'json' 和 'html'。
⚠
请记住，如果在 NGINX 编译期间未包含流量状态模块，则此指令将无法生效。
⚠
检查正确的上下文；此指令只能在 server 或 location 块中使用。