Skip to content

Remoe check for accesslog formatter #5985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zirain merged 3 commits into from
May 12, 2025
Merged

Remoe check for accesslog formatter #5985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5669038
Remoe check for accesslog formatter
zirain May 10, 2025
5294a12
gen
zirain May 10, 2025
ebadcfe
lint
zirain May 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 11 additions & 95 deletions internal/xds/translator/accesslog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
cel "github.com/envoyproxy/go-control-plane/envoy/extensions/access_loggers/filters/cel/v3"
grpcaccesslog "github.com/envoyproxy/go-control-plane/envoy/extensions/access_loggers/grpc/v3"
otelaccesslog "github.com/envoyproxy/go-control-plane/envoy/extensions/access_loggers/open_telemetry/v3"
celformatter "github.com/envoyproxy/go-control-plane/envoy/extensions/formatter/cel/v3"
metadataformatter "github.com/envoyproxy/go-control-plane/envoy/extensions/formatter/metadata/v3"
reqwithoutqueryformatter "github.com/envoyproxy/go-control-plane/envoy/extensions/formatter/req_without_query/v3"
"github.com/envoyproxy/go-control-plane/pkg/wellknown"
otlpcommonv1 "go.opentelemetry.io/proto/otlp/common/v1"
Expand All @@ -35,8 +33,6 @@
otelAccessLog = "envoy.access_loggers.open_telemetry"

reqWithoutQueryCommandOperator = "%REQ_WITHOUT_QUERY"
metadataCommandOperator = "%METADATA"
celCommandOperator = "%CEL"

tcpGRPCAccessLog = "envoy.access_loggers.tcp_grpc"
celFilter = "envoy.access_loggers.extension_filters.cel"
Expand Down Expand Up @@ -76,45 +72,17 @@
},
}

var (
// reqWithoutQueryFormatter configures additional formatters needed for some of the format strings like "REQ_WITHOUT_QUERY"
reqWithoutQueryFormatter *cfgcore.TypedExtensionConfig

// metadataFormatter configures additional formatters needed for some of the format strings like "METADATA"
// for more information, see https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/formatter/metadata/v3/metadata.proto
metadataFormatter *cfgcore.TypedExtensionConfig

// celFormatter configures additional formatters needed for some of the format strings like "CEL"
// for more information, see https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/formatter/cel/v3/cel.proto
celFormatter *cfgcore.TypedExtensionConfig
)
// reqWithoutQueryFormatter configures additional formatters needed for some of the format strings like "REQ_WITHOUT_QUERY"
var reqWithoutQueryFormatter *cfgcore.TypedExtensionConfig

func init() {
any, err := proto.ToAnyWithValidation(&reqwithoutqueryformatter.ReqWithoutQuery{})
anyCfg, err := proto.ToAnyWithValidation(&reqwithoutqueryformatter.ReqWithoutQuery{})
if err != nil {
panic(err)
}
reqWithoutQueryFormatter = &cfgcore.TypedExtensionConfig{
Name: "envoy.formatter.req_without_query",
TypedConfig: any,
}

any, err = proto.ToAnyWithValidation(&metadataformatter.Metadata{})
if err != nil {
panic(err)
}
metadataFormatter = &cfgcore.TypedExtensionConfig{
Name: "envoy.formatter.metadata",
TypedConfig: any,
}

any, err = proto.ToAnyWithValidation(&celformatter.Cel{})
if err != nil {
panic(err)
}
celFormatter = &cfgcore.TypedExtensionConfig{
Name: "envoy.formatter.cel",
TypedConfig: any,
TypedConfig: anyCfg,
}
}

Expand Down Expand Up @@ -388,7 +356,7 @@
fl := &cel.ExpressionFilter{
Expression: expr,
}
any, err := proto.ToAnyWithValidation(fl)
anyCfg, err := proto.ToAnyWithValidation(fl)
if err != nil {
return nil, err
}
Expand All @@ -397,7 +365,7 @@
FilterSpecifier: &accesslog.AccessLogFilter_ExtensionFilter{
ExtensionFilter: &accesslog.ExtensionFilter{
Name: celFilter,
ConfigType: &accesslog.ExtensionFilter_TypedConfig{TypedConfig: any},
ConfigType: &accesslog.ExtensionFilter_TypedConfig{TypedConfig: anyCfg},
},
},
}, nil
Expand Down Expand Up @@ -441,36 +409,20 @@
formatters = append(formatters, reqWithoutQueryFormatter)
}

if strings.Contains(text, metadataCommandOperator) {
formatters = append(formatters, metadataFormatter)
}

if strings.Contains(text, celCommandOperator) {
formatters = append(formatters, celFormatter)
}

return formatters
}

func accessLogJSONFormatters(json map[string]string) []*cfgcore.TypedExtensionConfig {
reqWithoutQuery, metadata, cel := false, false, false
reqWithoutQuery := false

for _, value := range json {
if reqWithoutQuery && metadata && cel {
if reqWithoutQuery {
break
}

if strings.Contains(value, reqWithoutQueryCommandOperator) {
reqWithoutQuery = true
}

if strings.Contains(value, metadataCommandOperator) {
metadata = true
}

if strings.Contains(value, celCommandOperator) {
cel = true
}
}

formatters := make([]*cfgcore.TypedExtensionConfig, 0, 3)
Expand All @@ -479,64 +431,28 @@
formatters = append(formatters, reqWithoutQueryFormatter)
}

if metadata {
formatters = append(formatters, metadataFormatter)
}

if cel {
formatters = append(formatters, celFormatter)
}

return formatters
}

func accessLogOpenTelemetryFormatters(body string, attributes map[string]string) []*cfgcore.TypedExtensionConfig {
reqWithoutQuery, metadata, cel := false, false, false
var reqWithoutQuery bool

if strings.Contains(body, reqWithoutQueryCommandOperator) {
reqWithoutQuery = true
}

if strings.Contains(body, metadataCommandOperator) {
metadata = true
}

if strings.Contains(body, celCommandOperator) {
cel = true
}

for _, value := range attributes {
if reqWithoutQuery && metadata && cel {
break
}

if !reqWithoutQuery && strings.Contains(value, reqWithoutQueryCommandOperator) {
if strings.Contains(value, reqWithoutQueryCommandOperator) {
reqWithoutQuery = true
}

if !metadata && strings.Contains(value, metadataCommandOperator) {
metadata = true
}

if !cel && strings.Contains(value, celCommandOperator) {
cel = true
break

Check warning on line 447 in internal/xds/translator/accesslog.go

View check run for this annotation

Codecov / codecov/patch

internal/xds/translator/accesslog.go#L447 

Added line #L447 was not covered by tests
}
}

formatters := make([]*cfgcore.TypedExtensionConfig, 0, 3)

if reqWithoutQuery {
formatters = append(formatters, reqWithoutQueryFormatter)
}

if metadata {
formatters = append(formatters, metadataFormatter)
}

if cel {
formatters = append(formatters, celFormatter)
}

return formatters
}

Expand Down
28 changes: 0 additions & 28 deletions internal/xds/translator/testdata/out/xds-ir/accesslog-formatters.listeners.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@
typedConfig:
'@type': type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog
logFormat:
formatters:
- name: envoy.formatter.cel
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.cel.v3.Cel
textFormatSource:
inlineString: |
[%START_TIME%] "%CEL(request.method)% %CEL(request.path)% %CEL(request.protocol)%" %CEL(response.code)% %CEL(response.flags)% %CEL(request.total_size)% %CEL(response.total_size)% %CEL(request.duration)% %CEL(response.headers['X-ENVOY-UPSTREAM-SERVICE-TIME'])% "%CEL(request.headers['X-FORWARDED-FOR'])%" "%CEL(request.useragent)%" "%CEL(request.id)%" "%CEL(request.host)%" "%CEL(upstream.address)%"
Expand All @@ -23,10 +19,6 @@
typedConfig:
'@type': type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog
logFormat:
formatters:
- name: envoy.formatter.metadata
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.metadata.v3.Metadata
jsonFormat:
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
Expand Down Expand Up @@ -92,12 +84,6 @@
- name: envoy.formatter.req_without_query
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.req_without_query.v3.ReqWithoutQuery
- name: envoy.formatter.metadata
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.metadata.v3.Metadata
- name: envoy.formatter.cel
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.cel.v3.Cel
resourceAttributes:
values:
- key: cluster_name
Expand All @@ -117,10 +103,6 @@
typedConfig:
'@type': type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog
logFormat:
formatters:
- name: envoy.formatter.cel
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.cel.v3.Cel
textFormatSource:
inlineString: |
[%START_TIME%] "%CEL(request.method)% %CEL(request.path)% %CEL(request.protocol)%" %CEL(response.code)% %CEL(response.flags)% %CEL(request.total_size)% %CEL(response.total_size)% %CEL(request.duration)% %CEL(response.headers['X-ENVOY-UPSTREAM-SERVICE-TIME'])% "%CEL(request.headers['X-FORWARDED-FOR'])%" "%CEL(request.useragent)%" "%CEL(request.id)%" "%CEL(request.host)%" "%CEL(upstream.address)%"
Expand All @@ -129,10 +111,6 @@
typedConfig:
'@type': type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog
logFormat:
formatters:
- name: envoy.formatter.metadata
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.metadata.v3.Metadata
jsonFormat:
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
Expand Down Expand Up @@ -190,12 +168,6 @@
- name: envoy.formatter.req_without_query
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.req_without_query.v3.ReqWithoutQuery
- name: envoy.formatter.metadata
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.metadata.v3.Metadata
- name: envoy.formatter.cel
typedConfig:
'@type': type.googleapis.com/envoy.extensions.formatter.cel.v3.Cel
resourceAttributes:
values:
- key: cluster_name
Expand Down