docs: Add notes about ingress_upstreaminfo log format for `parse_ng…

…inx_log()` function (#18477)
vectordotdev · Sep 5, 2023 · 5cfb3e4 · 5cfb3e4
1 parent 59dfd67
commit 5cfb3e4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/website/cue/reference/remap/functions/parse_nginx_log.cue b/website/cue/reference/remap/functions/parse_nginx_log.cue
@@ -3,8 +3,9 @@ package metadata
 remap: functions: parse_nginx_log: {
 	category:    "Parse"
 	description: """
-        Parses Nginx access and error log lines. Lines can be in [`combined`](\(urls.nginx_combined)), or [`error`](\(urls.nginx_error)) format.
-        """
+      Parses Nginx access and error log lines. Lines can be in [`combined`](\(urls.nginx_combined)),
+      [`ingress_upstreaminfo`](\(urls.nginx_ingress_upstreaminfo)) or [`error`](\(urls.nginx_error)) format.
+      """
 	notices: [
 		"""
 			Missing information in the log message may be indicated by `-`. These fields are omitted in the result.

diff --git a/website/cue/reference/urls.cue b/website/cue/reference/urls.cue
@@ -376,6 +376,7 @@ urls: {
 	new_transform:                              "\(vector_repo)/issues/new?labels=type%3A+new+feature"
 	nginx:                                      "https://www.nginx.com/"
 	nginx_combined:                             "https://nginx.org/en/docs/http/ngx_http_log_module.html"
+	nginx_ingress_upstreaminfo:                 "https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/log-format/"
 	nginx_error:                                "https://github.com/nginx/nginx/blob/branches/stable-1.18/src/core/ngx_log.c#L102"
 	nginx_stub_status_module:                   "http://nginx.org/en/docs/http/ngx_http_stub_status_module.html"
 	nix:                                        "https://nixos.org/nix/"