Skip to content

Commit 1887d5c

Browse files
authored
refactor: replace glog in the nginx package (#6585)
1 parent f034346 commit 1887d5c

File tree

6 files changed

+168
-152
lines changed

6 files changed

+168
-152
lines changed

cmd/nginx-ingress/main.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ func main() {
9696

9797
managerCollector, controllerCollector, registry := createManagerAndControllerCollectors(ctx, constLabels)
9898

99-
nginxManager, useFakeNginxManager := createNginxManager(managerCollector)
99+
nginxManager, useFakeNginxManager := createNginxManager(ctx, managerCollector)
100100

101101
nginxVersion := getNginxVersionInfo(ctx, nginxManager)
102102

@@ -452,14 +452,14 @@ func createTemplateExecutors(ctx context.Context) (*version1.TemplateExecutor, *
452452
return templateExecutor, templateExecutorV2
453453
}
454454

455-
func createNginxManager(managerCollector collectors.ManagerCollector) (nginx.Manager, bool) {
455+
func createNginxManager(ctx context.Context, managerCollector collectors.ManagerCollector) (nginx.Manager, bool) {
456456
useFakeNginxManager := *proxyURL != ""
457457
var nginxManager nginx.Manager
458458
if useFakeNginxManager {
459459
nginxManager = nginx.NewFakeManager("/etc/nginx")
460460
} else {
461461
timeout := time.Duration(*nginxReloadTimeout) * time.Millisecond
462-
nginxManager = nginx.NewLocalManager("/etc/nginx/", *nginxDebug, managerCollector, timeout)
462+
nginxManager = nginx.NewLocalManager(ctx, "/etc/nginx/", *nginxDebug, managerCollector, timeout)
463463
}
464464
return nginxManager, useFakeNginxManager
465465
}

internal/nginx/fake_manager.go

Lines changed: 63 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
package nginx
22

33
import (
4+
"log/slog"
45
"net/http"
56
"os"
67
"path"
78

8-
"github.com/golang/glog"
9+
nl "github.com/nginxinc/kubernetes-ingress/internal/logger"
10+
nic_glog "github.com/nginxinc/kubernetes-ingress/internal/logger/glog"
11+
"github.com/nginxinc/kubernetes-ingress/internal/logger/levels"
912
"github.com/nginxinc/nginx-plus-go-client/client"
1013
)
1114

@@ -14,6 +17,7 @@ type FakeManager struct {
1417
confdPath string
1518
secretsPath string
1619
dhparamFilename string
20+
logger *slog.Logger
1721
}
1822

1923
// NewFakeManager creates a FakeManager.
@@ -22,71 +26,72 @@ func NewFakeManager(confPath string) *FakeManager {
2226
confdPath: path.Join(confPath, "conf.d"),
2327
secretsPath: path.Join(confPath, "secrets"),
2428
dhparamFilename: path.Join(confPath, "secrets", "dhparam.pem"),
29+
logger: slog.New(nic_glog.New(os.Stdout, &nic_glog.Options{Level: levels.LevelInfo})),
2530
}
2631
}
2732

2833
// CreateMainConfig provides a fake implementation of CreateMainConfig.
29-
func (*FakeManager) CreateMainConfig(content []byte) bool {
30-
glog.V(3).Info("Writing main config")
31-
glog.V(3).Info(string(content))
34+
func (fm *FakeManager) CreateMainConfig(content []byte) bool {
35+
nl.Debug(fm.logger, "Writing main config")
36+
nl.Debug(fm.logger, string(content))
3237
return true
3338
}
3439

3540
// CreateConfig provides a fake implementation of CreateConfig.
36-
func (*FakeManager) CreateConfig(name string, content []byte) bool {
37-
glog.V(3).Infof("Writing config %v", name)
38-
glog.V(3).Info(string(content))
41+
func (fm *FakeManager) CreateConfig(name string, content []byte) bool {
42+
nl.Debugf(fm.logger, "Writing config %v", name)
43+
nl.Debug(fm.logger, string(content))
3944
return true
4045
}
4146

4247
// CreateAppProtectResourceFile provides a fake implementation of CreateAppProtectResourceFile
43-
func (*FakeManager) CreateAppProtectResourceFile(name string, content []byte) {
44-
glog.V(3).Infof("Writing Ap Resource File %v", name)
45-
glog.V(3).Info(string(content))
48+
func (fm *FakeManager) CreateAppProtectResourceFile(name string, content []byte) {
49+
nl.Debugf(fm.logger, "Writing Ap Resource File %v", name)
50+
nl.Debug(fm.logger, string(content))
4651
}
4752

4853
// DeleteAppProtectResourceFile provides a fake implementation of DeleteAppProtectResourceFile
49-
func (*FakeManager) DeleteAppProtectResourceFile(name string) {
50-
glog.V(3).Infof("Deleting Ap Resource File %v", name)
54+
func (fm *FakeManager) DeleteAppProtectResourceFile(name string) {
55+
nl.Debugf(fm.logger, "Deleting Ap Resource File %v", name)
5156
}
5257

5358
// ClearAppProtectFolder provides a fake implementation of ClearAppProtectFolder
54-
func (*FakeManager) ClearAppProtectFolder(name string) {
55-
glog.V(3).Infof("Deleting Ap Resource folder %v", name)
59+
func (fm *FakeManager) ClearAppProtectFolder(name string) {
60+
nl.Debugf(fm.logger, "Deleting Ap Resource folder %v", name)
5661
}
5762

5863
// DeleteConfig provides a fake implementation of DeleteConfig.
59-
func (*FakeManager) DeleteConfig(name string) {
60-
glog.V(3).Infof("Deleting config %v", name)
64+
func (fm *FakeManager) DeleteConfig(name string) {
65+
nl.Debugf(fm.logger, "Deleting config %v", name)
6166
}
6267

6368
// CreateStreamConfig provides a fake implementation of CreateStreamConfig.
64-
func (*FakeManager) CreateStreamConfig(name string, content []byte) bool {
65-
glog.V(3).Infof("Writing stream config %v", name)
66-
glog.V(3).Info(string(content))
69+
func (fm *FakeManager) CreateStreamConfig(name string, content []byte) bool {
70+
nl.Debugf(fm.logger, "Writing stream config %v", name)
71+
nl.Debug(fm.logger, string(content))
6772
return true
6873
}
6974

7075
// DeleteStreamConfig provides a fake implementation of DeleteStreamConfig.
71-
func (*FakeManager) DeleteStreamConfig(name string) {
72-
glog.V(3).Infof("Deleting stream config %v", name)
76+
func (fm *FakeManager) DeleteStreamConfig(name string) {
77+
nl.Debugf(fm.logger, "Deleting stream config %v", name)
7378
}
7479

7580
// CreateTLSPassthroughHostsConfig provides a fake implementation of CreateTLSPassthroughHostsConfig.
76-
func (*FakeManager) CreateTLSPassthroughHostsConfig(_ []byte) bool {
77-
glog.V(3).Infof("Writing TLS Passthrough Hosts config file")
81+
func (fm *FakeManager) CreateTLSPassthroughHostsConfig(_ []byte) bool {
82+
nl.Debugf(fm.logger, "Writing TLS Passthrough Hosts config file")
7883
return false
7984
}
8085

8186
// CreateSecret provides a fake implementation of CreateSecret.
8287
func (fm *FakeManager) CreateSecret(name string, _ []byte, _ os.FileMode) string {
83-
glog.V(3).Infof("Writing secret %v", name)
88+
nl.Debugf(fm.logger, "Writing secret %v", name)
8489
return fm.GetFilenameForSecret(name)
8590
}
8691

8792
// DeleteSecret provides a fake implementation of DeleteSecret.
88-
func (*FakeManager) DeleteSecret(name string) {
89-
glog.V(3).Infof("Deleting secret %v", name)
93+
func (fm *FakeManager) DeleteSecret(name string) {
94+
nl.Debugf(fm.logger, "Deleting secret %v", name)
9095
}
9196

9297
// GetFilenameForSecret provides a fake implementation of GetFilenameForSecret.
@@ -96,56 +101,56 @@ func (fm *FakeManager) GetFilenameForSecret(name string) string {
96101

97102
// CreateDHParam provides a fake implementation of CreateDHParam.
98103
func (fm *FakeManager) CreateDHParam(_ string) (string, error) {
99-
glog.V(3).Infof("Writing dhparam file")
104+
nl.Debugf(fm.logger, "Writing dhparam file")
100105
return fm.dhparamFilename, nil
101106
}
102107

103108
// Version provides a fake implementation of Version.
104-
func (*FakeManager) Version() Version {
105-
glog.V(3).Info("Printing nginx version")
109+
func (fm *FakeManager) Version() Version {
110+
nl.Debug(fm.logger, "Printing nginx version")
106111
return NewVersion("nginx version: nginx/1.25.3 (nginx-plus-r31)")
107112
}
108113

109114
// Start provides a fake implementation of Start.
110-
func (*FakeManager) Start(_ chan error) {
111-
glog.V(3).Info("Starting nginx")
115+
func (fm *FakeManager) Start(_ chan error) {
116+
nl.Debug(fm.logger, "Starting nginx")
112117
}
113118

114119
// Reload provides a fake implementation of Reload.
115-
func (*FakeManager) Reload(_ bool) error {
116-
glog.V(3).Infof("Reloading nginx")
120+
func (fm *FakeManager) Reload(_ bool) error {
121+
nl.Debugf(fm.logger, "Reloading nginx")
117122
return nil
118123
}
119124

120125
// Quit provides a fake implementation of Quit.
121-
func (*FakeManager) Quit() {
122-
glog.V(3).Info("Quitting nginx")
126+
func (fm *FakeManager) Quit() {
127+
nl.Debug(fm.logger, "Quitting nginx")
123128
}
124129

125130
// UpdateConfigVersionFile provides a fake implementation of UpdateConfigVersionFile.
126-
func (*FakeManager) UpdateConfigVersionFile(_ bool) {
127-
glog.V(3).Infof("Writing config version")
131+
func (fm *FakeManager) UpdateConfigVersionFile(_ bool) {
132+
nl.Debugf(fm.logger, "Writing config version")
128133
}
129134

130135
// SetPlusClients provides a fake implementation of SetPlusClients.
131136
func (*FakeManager) SetPlusClients(_ *client.NginxClient, _ *http.Client) {
132137
}
133138

134139
// UpdateServersInPlus provides a fake implementation of UpdateServersInPlus.
135-
func (*FakeManager) UpdateServersInPlus(upstream string, servers []string, _ ServerConfig) error {
136-
glog.V(3).Infof("Updating servers of %v: %v", upstream, servers)
140+
func (fm *FakeManager) UpdateServersInPlus(upstream string, servers []string, _ ServerConfig) error {
141+
nl.Debugf(fm.logger, "Updating servers of %v: %v", upstream, servers)
137142
return nil
138143
}
139144

140145
// UpdateStreamServersInPlus provides a fake implementation of UpdateStreamServersInPlus.
141-
func (*FakeManager) UpdateStreamServersInPlus(upstream string, servers []string) error {
142-
glog.V(3).Infof("Updating stream servers of %v: %v", upstream, servers)
146+
func (fm *FakeManager) UpdateStreamServersInPlus(upstream string, servers []string) error {
147+
nl.Debugf(fm.logger, "Updating stream servers of %v: %v", upstream, servers)
143148
return nil
144149
}
145150

146151
// CreateOpenTracingTracerConfig creates a fake implementation of CreateOpenTracingTracerConfig.
147-
func (*FakeManager) CreateOpenTracingTracerConfig(_ string) error {
148-
glog.V(3).Infof("Writing OpenTracing tracer config file")
152+
func (fm *FakeManager) CreateOpenTracingTracerConfig(_ string) error {
153+
nl.Debugf(fm.logger, "Writing OpenTracing tracer config file")
149154

150155
return nil
151156
}
@@ -155,37 +160,37 @@ func (*FakeManager) SetOpenTracing(_ bool) {
155160
}
156161

157162
// AppProtectPluginStart is a fake implementation AppProtectPluginStart
158-
func (*FakeManager) AppProtectPluginStart(_ chan error, _ string) {
159-
glog.V(3).Infof("Starting FakeAppProtectPlugin")
163+
func (fm *FakeManager) AppProtectPluginStart(_ chan error, _ string) {
164+
nl.Debugf(fm.logger, "Starting FakeAppProtectPlugin")
160165
}
161166

162167
// AppProtectPluginQuit is a fake implementation AppProtectPluginQuit
163-
func (*FakeManager) AppProtectPluginQuit() {
164-
glog.V(3).Infof("Quitting FakeAppProtectPlugin")
168+
func (fm *FakeManager) AppProtectPluginQuit() {
169+
nl.Debugf(fm.logger, "Quitting FakeAppProtectPlugin")
165170
}
166171

167172
// AppProtectDosAgentQuit is a fake implementation AppProtectAgentQuit
168-
func (*FakeManager) AppProtectDosAgentQuit() {
169-
glog.V(3).Infof("Quitting FakeAppProtectDosAgent")
173+
func (fm *FakeManager) AppProtectDosAgentQuit() {
174+
nl.Debugf(fm.logger, "Quitting FakeAppProtectDosAgent")
170175
}
171176

172177
// AppProtectDosAgentStart is a fake implementation of AppProtectAgentStart
173-
func (*FakeManager) AppProtectDosAgentStart(_ chan error, _ bool, _ int, _ int, _ int) {
174-
glog.V(3).Infof("Starting FakeAppProtectDosAgent")
178+
func (fm *FakeManager) AppProtectDosAgentStart(_ chan error, _ bool, _ int, _ int, _ int) {
179+
nl.Debugf(fm.logger, "Starting FakeAppProtectDosAgent")
175180
}
176181

177182
// AgentQuit is a fake implementation AppProtectAgentQuit
178-
func (*FakeManager) AgentQuit() {
179-
glog.V(3).Infof("Quitting FakeAgent")
183+
func (fm *FakeManager) AgentQuit() {
184+
nl.Debugf(fm.logger, "Quitting FakeAgent")
180185
}
181186

182187
// AgentStart is a fake implementation of AppProtectAgentStart
183-
func (*FakeManager) AgentStart(_ chan error, _ string) {
184-
glog.V(3).Infof("Starting FakeAgent")
188+
func (fm *FakeManager) AgentStart(_ chan error, _ string) {
189+
nl.Debugf(fm.logger, "Starting FakeAgent")
185190
}
186191

187192
// AgentVersion is a fake implementation of AppProtectAgentStart
188-
func (*FakeManager) AgentVersion() string {
193+
func (fm *FakeManager) AgentVersion() string {
189194
return "v0.00.0-00000000"
190195
}
191196

@@ -196,10 +201,10 @@ func (fm *FakeManager) GetSecretsDir() string {
196201

197202
// UpsertSplitClientsKeyVal is a fake implementation of UpsertSplitClientsKeyVal
198203
func (fm *FakeManager) UpsertSplitClientsKeyVal(_ string, _ string, _ string) {
199-
glog.V(3).Infof("Creating split clients key")
204+
nl.Debugf(fm.logger, "Creating split clients key")
200205
}
201206

202207
// DeleteKeyValStateFiles is a fake implementation of DeleteKeyValStateFiles
203208
func (fm *FakeManager) DeleteKeyValStateFiles(_ string) {
204-
glog.V(3).Infof("Deleting keyval state files")
209+
nl.Debugf(fm.logger, "Deleting keyval state files")
205210
}

0 commit comments

Comments
 (0)