NGINX Ingress Controller自定义日志格式配置指南

最新推荐文章于 2025-06-12 17:54:41 发布

伏启嵩Blind

最新推荐文章于 2025-06-12 17:54:41 发布

阅读量409

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/gitblog_01060/article/details/148508849

NGINX Ingress Controller自定义日志格式配置指南

kubernetes-ingress NGINX and NGINX Plus Ingress Controllers for Kubernetes 项目地址: https://gitcode.com/gh_mirrors/ku/kubernetes-ingress

概述

在Kubernetes环境中使用NGINX Ingress Controller时，日志记录是监控和故障排查的重要工具。本文将详细介绍如何通过ConfigMap资源自定义NGINX的日志格式，以及可用的特殊变量。

为什么需要自定义日志格式

默认的NGINX日志格式可能无法满足所有场景的需求，特别是在Kubernetes环境中，我们通常需要记录更多与Kubernetes资源相关的信息。通过自定义日志格式，我们可以：

记录更详细的请求信息
包含Kubernetes特有的资源信息
统一日志格式便于后续分析处理
针对特定场景优化日志内容

配置方法

要自定义NGINX Ingress Controller的日志格式，我们需要创建一个ConfigMap资源。以下是一个完整的配置示例：

kind: ConfigMap
apiVersion: v1
metadata:
  name: nginx-config
  namespace: nginx-ingress
data:
  log-format:  '$remote_addr - $remote_user [$time_local] "$request" $status $grpc_status $body_bytes_sent "$http_referer"  "$http_user_agent" "$http_x_forwarded_for" "$resource_name" "$resource_type" "$resource_namespace" "$service"'

配置说明

ConfigMap位置：必须部署在nginx-ingress命名空间
ConfigMap名称：必须命名为nginx-config
log-format字段：包含自定义的日志格式字符串

可用变量详解

标准NGINX变量

可以使用所有NGINX内置变量，常见的有：

$remote_addr：客户端IP地址
$remote_user：通过HTTP基本认证的用户名
$time_local：本地时间
$request：完整的请求行
$status：响应状态码
$body_bytes_sent：发送给客户端的字节数
$http_referer：请求来源页
$http_user_agent：客户端浏览器信息
$http_x_forwarded_for：X-Forwarded-For头信息

Kubernetes特有变量

NGINX Ingress Controller还提供了一些特有的变量：

$resource_type
处理客户端请求的Kubernetes资源类型，可能是：
- Ingress
- VirtualServer
- VirtualServerRoute
$resource_name
处理请求的Kubernetes资源名称
$resource_namespace
资源所在的命名空间
$service
客户端请求被发送到的服务名称
$grpc_status
gRPC状态码，可能来自：
- 后端返回的HTTP/2 trailer(grpc_status)
- 后端或NGINX设置的HTTP/2 header(grpc_status)