Skip to content
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

Jump to bottom

dino@improve logging #44

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

dino@improve logging #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3bc9d49
Generated with trivialVersion=false
dinofizz Apr 5, 2024
9ee3d3c
Switch to JSON for access logs
dinofizz Apr 30, 2024
3e75be1
Remove unused property
dinofizz May 9, 2024
18ce1fd
Removing unused testdata
dinofizz May 9, 2024
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
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Build the manager binary
FROM golang@sha256:d6df8b2e22c9c87fde828b18e0d0d5707bfe03034a49c0bde72ff5a1f5ebb5fe as builder
FROM golang:1.22.2@sha256:c4fb952e712efd8f787bcd8e53fd66d1d83b7dc26adabc218e9eac1dbf776bdf as builder

WORKDIR /workspace
# Copy the Go Modules manifests
Expand Down
61 changes: 46 additions & 15 deletions controllers/configmap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ package controllers
import (
"context"
"fmt"
//structpb "github.com/golang/protobuf/ptypes/struct"
"google.golang.org/protobuf/types/known/anypb"
"google.golang.org/protobuf/types/known/durationpb"
"hash/fnv"
"strconv"
Expand All @@ -13,16 +15,16 @@ import (
envoycorev3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
envoyendpoint "github.com/envoyproxy/go-control-plane/envoy/config/endpoint/v3"
envoylistener "github.com/envoyproxy/go-control-plane/envoy/config/listener/v3"
filev3 "github.com/envoyproxy/go-control-plane/envoy/extensions/access_loggers/file/v3"
streamv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/access_loggers/stream/v3"
aggregatev3 "github.com/envoyproxy/go-control-plane/envoy/extensions/clusters/aggregate/v3"
tcpproxyv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/network/tcp_proxy/v3"
udpproxyv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/udp/udp_proxy/v3"
"github.com/golang/protobuf/ptypes/wrappers"
"google.golang.org/protobuf/types/known/wrapperspb"

"github.com/golang/protobuf/jsonpb"
"github.com/golang/protobuf/ptypes"
"github.com/golang/protobuf/ptypes/duration"
"github.com/golang/protobuf/ptypes/wrappers"
"google.golang.org/protobuf/types/known/structpb"
"google.golang.org/protobuf/types/known/wrapperspb"
corev1 "k8s.io/api/core/v1"
apierrs "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand All @@ -35,6 +37,34 @@ import (

// +kubebuilder:rbac:namespace=egress-operator-system,groups=core,resources=configmaps,verbs=get;list;watch;create;patch

var (
logFields = &structpb.Struct{
Fields: map[string]*structpb.Value{
"authority": {Kind: &structpb.Value_StringValue{StringValue: "%REQ(:AUTHORITY)%"}},
"bytes_received": {Kind: &structpb.Value_StringValue{StringValue: "%BYTES_RECEIVED%"}},
"bytes_sent": {Kind: &structpb.Value_StringValue{StringValue: "%BYTES_SENT%"}},
"connection_termination_details": {Kind: &structpb.Value_StringValue{StringValue: "%CONNECTION_TERMINATION_DETAILS%"}},
"downstream_local_address": {Kind: &structpb.Value_StringValue{StringValue: "%DOWNSTREAM_LOCAL_ADDRESS%"}},
"downstream_remote_address": {Kind: &structpb.Value_StringValue{StringValue: "%DOWNSTREAM_REMOTE_ADDRESS%"}},
"duration": {Kind: &structpb.Value_StringValue{StringValue: "%DURATION%"}},
"method": {Kind: &structpb.Value_StringValue{StringValue: "%REQ(:METHOD)%"}},
"path": {Kind: &structpb.Value_StringValue{StringValue: "%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%"}},
"protocol": {Kind: &structpb.Value_StringValue{StringValue: "%PROTOCOL%"}},
"requested_server_name": {Kind: &structpb.Value_StringValue{StringValue: "%REQUESTED_SERVER_NAME%"}},
"response_code": {Kind: &structpb.Value_StringValue{StringValue: "%RESPONSE_CODE%"}},
"response_code_details": {Kind: &structpb.Value_StringValue{StringValue: "%RESPONSE_CODE_DETAILS%"}},
"response_flags": {Kind: &structpb.Value_StringValue{StringValue: "%RESPONSE_FLAGS%"}},
"start_time": {Kind: &structpb.Value_StringValue{StringValue: "%START_TIME%"}},
"upstream_cluster": {Kind: &structpb.Value_StringValue{StringValue: "%UPSTREAM_CLUSTER%"}},
"upstream_host": {Kind: &structpb.Value_StringValue{StringValue: "%UPSTREAM_HOST%"}},
"upstream_local_address": {Kind: &structpb.Value_StringValue{StringValue: "%UPSTREAM_LOCAL_ADDRESS%"}},
"upstream_service_time": {Kind: &structpb.Value_StringValue{StringValue: "%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%"}},
"upstream_transport_failure_reason": {Kind: &structpb.Value_StringValue{StringValue: "%UPSTREAM_TRANSPORT_FAILURE_REASON%"}},
"user_agent": {Kind: &structpb.Value_StringValue{StringValue: "%REQ(USER-AGENT)%"}},
},
}
)

func (r *ExternalServiceReconciler) reconcileConfigMap(ctx context.Context, req ctrl.Request, es *egressv1.ExternalService, desired *corev1.ConfigMap) error {
if err := ctrl.SetControllerReference(es, desired, r.Scheme); err != nil {
return err
Expand Down Expand Up @@ -86,9 +116,6 @@ func adminPort(es *egressv1.ExternalService) int32 {
panic("couldn't find a port for admin listener")
}

const accessLogFormat = `[%START_TIME%] %BYTES_RECEIVED% %BYTES_SENT% %DURATION% "%DOWNSTREAM_REMOTE_ADDRESS%" "%UPSTREAM_HOST%" "%UPSTREAM_CLUSTER%"
`

func envoyConfig(es *egressv1.ExternalService) (string, error) {
config := bootstrap.Bootstrap{
Node: &envoycorev3.Node{
Expand Down Expand Up @@ -197,16 +224,20 @@ func envoyConfig(es *egressv1.ExternalService) (string, error) {
var listener *envoylistener.Listener
switch protocol {
case envoycorev3.SocketAddress_TCP:
accessConfig, err := ptypes.MarshalAny(&filev3.FileAccessLog{
AccessLogFormat: &filev3.FileAccessLog_Format{
Format: accessLogFormat,
accessConfig, err := anypb.New(&streamv3.StdoutAccessLog{
AccessLogFormat: &streamv3.StdoutAccessLog_LogFormat{
LogFormat: &envoycorev3.SubstitutionFormatString{
Format: &envoycorev3.SubstitutionFormatString_JsonFormat{
JsonFormat: logFields,
},
OmitEmptyValues: true,
ContentType: "application/json; charset=UTF-8",
},
},
Path: "/dev/stdout",
})

filterConfig, err := ptypes.MarshalAny(&tcpproxyv3.TcpProxy{
filterConfig, err := anypb.New(&tcpproxyv3.TcpProxy{
AccessLog: []*accesslogfilterv3.AccessLog{{
Name: "envoy.file_access_log",
Name: "envoy.stdout_access_log",
ConfigType: &accesslogfilterv3.AccessLog_TypedConfig{TypedConfig: accessConfig},
}},
StatPrefix: "tcp_proxy",
Expand Down Expand Up @@ -236,7 +267,7 @@ func envoyConfig(es *egressv1.ExternalService) (string, error) {
}}}}},
}
case envoycorev3.SocketAddress_UDP:
filterConfig, err := ptypes.MarshalAny(&udpproxyv3.UdpProxyConfig{
filterConfig, err := anypb.New(&udpproxyv3.UdpProxyConfig{
StatPrefix: "udp_proxy",
RouteSpecifier: &udpproxyv3.UdpProxyConfig_Cluster{
Cluster: name,
Expand Down
76 changes: 65 additions & 11 deletions controllers/configmap_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package controllers

import (
bootstrap "github.com/envoyproxy/go-control-plane/envoy/config/bootstrap/v3"
"github.com/google/go-cmp/cmp"
"sigs.k8s.io/yaml"
"testing"

"github.com/google/go-cmp/cmp"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

Expand Down Expand Up @@ -97,12 +99,34 @@ staticResources:
typedConfig:
'@type': type.googleapis.com/envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy
accessLog:
- name: envoy.file_access_log
- name: envoy.stdout_access_log
typedConfig:
'@type': type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog
format: |
[%START_TIME%] %BYTES_RECEIVED% %BYTES_SENT% %DURATION% "%DOWNSTREAM_REMOTE_ADDRESS%" "%UPSTREAM_HOST%" "%UPSTREAM_CLUSTER%"
path: /dev/stdout
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
logFormat:
contentType: application/json; charset=UTF-8
jsonFormat:
authority: '%REQ(:AUTHORITY)%'
bytes_received: '%BYTES_RECEIVED%'
bytes_sent: '%BYTES_SENT%'
connection_termination_details: '%CONNECTION_TERMINATION_DETAILS%'
downstream_local_address: '%DOWNSTREAM_LOCAL_ADDRESS%'
downstream_remote_address: '%DOWNSTREAM_REMOTE_ADDRESS%'
duration: '%DURATION%'
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
protocol: '%PROTOCOL%'
requested_server_name: '%REQUESTED_SERVER_NAME%'
response_code: '%RESPONSE_CODE%'
response_code_details: '%RESPONSE_CODE_DETAILS%'
response_flags: '%RESPONSE_FLAGS%'
start_time: '%START_TIME%'
upstream_cluster: '%UPSTREAM_CLUSTER%'
upstream_host: '%UPSTREAM_HOST%'
upstream_local_address: '%UPSTREAM_LOCAL_ADDRESS%'
upstream_service_time: '%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%'
upstream_transport_failure_reason: '%UPSTREAM_TRANSPORT_FAILURE_REASON%'
user_agent: '%REQ(USER-AGENT)%'
omitEmptyValues: true
cluster: foo_TCP_101
statPrefix: tcp_proxy
name: foo_TCP_101
Expand Down Expand Up @@ -209,12 +233,34 @@ staticResources:
typedConfig:
'@type': type.googleapis.com/envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy
accessLog:
- name: envoy.file_access_log
- name: envoy.stdout_access_log
typedConfig:
'@type': type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog
format: |
[%START_TIME%] %BYTES_RECEIVED% %BYTES_SENT% %DURATION% "%DOWNSTREAM_REMOTE_ADDRESS%" "%UPSTREAM_HOST%" "%UPSTREAM_CLUSTER%"
path: /dev/stdout
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
logFormat:
contentType: application/json; charset=UTF-8
jsonFormat:
authority: '%REQ(:AUTHORITY)%'
bytes_received: '%BYTES_RECEIVED%'
bytes_sent: '%BYTES_SENT%'
connection_termination_details: '%CONNECTION_TERMINATION_DETAILS%'
downstream_local_address: '%DOWNSTREAM_LOCAL_ADDRESS%'
downstream_remote_address: '%DOWNSTREAM_REMOTE_ADDRESS%'
duration: '%DURATION%'
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
protocol: '%PROTOCOL%'
requested_server_name: '%REQUESTED_SERVER_NAME%'
response_code: '%RESPONSE_CODE%'
response_code_details: '%RESPONSE_CODE_DETAILS%'
response_flags: '%RESPONSE_FLAGS%'
start_time: '%START_TIME%'
upstream_cluster: '%UPSTREAM_CLUSTER%'
upstream_host: '%UPSTREAM_HOST%'
upstream_local_address: '%UPSTREAM_LOCAL_ADDRESS%'
upstream_service_time: '%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%'
upstream_transport_failure_reason: '%UPSTREAM_TRANSPORT_FAILURE_REASON%'
user_agent: '%REQ(USER-AGENT)%'
omitEmptyValues: true
cluster: foo_TCP_101
statPrefix: tcp_proxy
name: foo_TCP_101
Expand Down Expand Up @@ -246,7 +292,15 @@ staticResources:
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.args.es.Spec.EnvoyClusterMaxConnections = tt.args.maxConns
got, _ := envoyConfig(tt.args.es)

var x bootstrap.Bootstrap
err := yaml.Unmarshal([]byte(got), &x)
if err != nil {
t.Error()
}
if got, _ := envoyConfig(tt.args.es); got != tt.want {

t.Errorf("envoyConfig() = %v, want %v", got, tt.want)
t.Error(cmp.Diff(got, tt.want))
}
Expand Down
Loading
Loading