Add grpc_status_code as a default access log field

Fixes #4484 Signed-off-by: Rajat Vig <rvig@etsy.com> Co-authored-by: Steve Kriss <stephen.kriss@gmail.com> Signed-off-by: Rajat Vig <rvig@etsy.com>
projectcontour · Dec 15, 2022 · 46b6900 · 46b6900
1 parent 30320aa
commit 46b6900
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 0 deletions.
diff --git a/apis/projectcontour/v1alpha1/accesslog.go b/apis/projectcontour/v1alpha1/accesslog.go
@@ -43,6 +43,7 @@ var DefaultAccessLogJSONFields = AccessLogJSONFields([]string{
 	"user_agent",
 	"x_forwarded_for",
 	"grpc_status",
+	"grpc_status_number",
 })
 
 // DefaultAccessLogType is the default access log format.

diff --git a/apis/projectcontour/v1alpha1/accesslog_test.go b/apis/projectcontour/v1alpha1/accesslog_test.go
@@ -77,6 +77,7 @@ func TestValidateAccessLogJSONFields(t *testing.T) {
 		{"pod=%ENVIRONMENT(ENVOY_POD_NAME)%"},
 		{"dog=pug", "cat=black"},
 		{"grpc_status"},
+		{"grpc_status_number"},
 	}
 
 	for _, c := range successCases {
@@ -118,6 +119,7 @@ func TestAccessLogFormatString(t *testing.T) {
 		"queries %REQ_WITHOUT_QUERY(X-ENVOY-ORIGINAL-PATH?:PATH)% removed\n",
 		"just a string\n",
 		"%GRPC_STATUS%\n",
+		"%GRPC_STATUS_NUMBER%\n",
 		"%METADATA(ROUTE:com.test.my_filter:test_key):20%\n",
 		"%UPSTREAM_PROTOCOL%\n",
 		"%UPSTREAM_PEER_SUBJECT%\n",

diff --git a/changelogs/unreleased/4880-rajatvig-small.md b/changelogs/unreleased/4880-rajatvig-small.md
@@ -0,0 +1 @@
+Add `grpc_status_number` to the default JSON access log fields
diff --git a/cmd/contour/servecontext_test.go b/cmd/contour/servecontext_test.go
@@ -459,6 +459,7 @@ func TestConvertServeContext(t *testing.T) {
 						"user_agent",
 						"x_forwarded_for",
 						"grpc_status",
+						"grpc_status_number",
 					}),
 				},
 				DefaultHTTPVersions: nil,

diff --git a/examples/contour/01-contour-config.yaml b/examples/contour/01-contour-config.yaml
@@ -96,6 +96,7 @@ data:
     #   - "user_agent"
     #   - "x_forwarded_for"
     #   - "grpc_status"
+    #   - "grpc_status_number"
     #
     # default-http-versions:
     # - "HTTP/2"

diff --git a/examples/render/contour-deployment.yaml b/examples/render/contour-deployment.yaml
@@ -129,6 +129,7 @@ data:
     #   - "user_agent"
     #   - "x_forwarded_for"
     #   - "grpc_status"
+    #   - "grpc_status_number"
     #
     # default-http-versions:
     # - "HTTP/2"

diff --git a/examples/render/contour-gateway.yaml b/examples/render/contour-gateway.yaml
@@ -135,6 +135,7 @@ data:
     #   - "user_agent"
     #   - "x_forwarded_for"
     #   - "grpc_status"
+    #   - "grpc_status_number"
     #
     # default-http-versions:
     # - "HTTP/2"

diff --git a/examples/render/contour.yaml b/examples/render/contour.yaml
@@ -129,6 +129,7 @@ data:
     #   - "user_agent"
     #   - "x_forwarded_for"
     #   - "grpc_status"
+    #   - "grpc_status_number"
     #
     # default-http-versions:
     # - "HTTP/2"

diff --git a/pkg/config/parameters_test.go b/pkg/config/parameters_test.go
@@ -72,6 +72,7 @@ json-fields:
     - user_agent
     - x_forwarded_for
     - grpc_status
+    - grpc_status_number
 accesslog-level: info
 timeouts:
     connection-idle-timeout: 60s
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add `grpc_status_number` to the default JSON access log fields