Skip to content

Commit 77390b6

Browse files
zak-pawelzak-pawel
authored
fix: linter fixes for "import-shadowing: The name '...' shadows an import name" (influxdata#10689)
1 parent ca99481 commit 77390b6

File tree

10 files changed

+74
-74
lines changed

10 files changed

+74
-74
lines changed

‎agent/accumulator.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99

1010
type MetricMaker interface {
1111
LogName() string
12-
MakeMetric(metric telegraf.Metric) telegraf.Metric
12+
MakeMetric(m telegraf.Metric) telegraf.Metric
1313
Log() telegraf.Logger
1414
}
1515

‎agent/agent.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ type Agent struct {
2323
}
2424

2525
// NewAgent returns an Agent for the given Config.
26-
func NewAgent(config *config.Config) (*Agent, error) {
26+
func NewAgent(cfg *config.Config) (*Agent, error) {
2727
a := &Agent{
28-
Config: config,
28+
Config: cfg,
2929
}
3030
return a, nil
3131
}

‎internal/http.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -86,24 +86,24 @@ type ErrorFunc func(rw http.ResponseWriter, code int)
8686

8787
// IPRangeHandler returns a http handler that requires the remote address to be
8888
// in the specified network.
89-
func IPRangeHandler(network []*net.IPNet, onError ErrorFunc) func(h http.Handler) http.Handler {
89+
func IPRangeHandler(networks []*net.IPNet, onError ErrorFunc) func(h http.Handler) http.Handler {
9090
return func(h http.Handler) http.Handler {
9191
return &ipRangeHandler{
92-
network: network,
93-
onError: onError,
94-
next: h,
92+
networks: networks,
93+
onError: onError,
94+
next: h,
9595
}
9696
}
9797
}
9898

9999
type ipRangeHandler struct {
100-
network []*net.IPNet
101-
onError ErrorFunc
102-
next http.Handler
100+
networks []*net.IPNet
101+
onError ErrorFunc
102+
next http.Handler
103103
}
104104

105105
func (h *ipRangeHandler) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
106-
if len(h.network) == 0 {
106+
if len(h.networks) == 0 {
107107
h.next.ServeHTTP(rw, req)
108108
return
109109
}
@@ -120,8 +120,8 @@ func (h *ipRangeHandler) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
120120
return
121121
}
122122

123-
for _, net := range h.network {
124-
if net.Contains(remoteIP) {
123+
for _, network := range h.networks {
124+
if network.Contains(remoteIP) {
125125
h.next.ServeHTTP(rw, req)
126126
return
127127
}

‎logger/logger.go

+17-17
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ type LogConfig struct {
4444
}
4545

4646
type LoggerCreator interface {
47-
CreateLogger(config LogConfig) (io.Writer, error)
47+
CreateLogger(cfg LogConfig) (io.Writer, error)
4848
}
4949

5050
var loggerRegistry map[string]LoggerCreator
@@ -110,23 +110,23 @@ func newTelegrafWriter(w io.Writer, c LogConfig) (io.Writer, error) {
110110
}
111111

112112
// SetupLogging configures the logging output.
113-
func SetupLogging(config LogConfig) {
114-
newLogWriter(config)
113+
func SetupLogging(cfg LogConfig) {
114+
newLogWriter(cfg)
115115
}
116116

117117
type telegrafLogCreator struct {
118118
}
119119

120-
func (t *telegrafLogCreator) CreateLogger(config LogConfig) (io.Writer, error) {
120+
func (t *telegrafLogCreator) CreateLogger(cfg LogConfig) (io.Writer, error) {
121121
var writer, defaultWriter io.Writer
122122
defaultWriter = os.Stderr
123123

124-
switch config.LogTarget {
124+
switch cfg.LogTarget {
125125
case LogTargetFile:
126-
if config.Logfile != "" {
126+
if cfg.Logfile != "" {
127127
var err error
128-
if writer, err = rotate.NewFileWriter(config.Logfile, time.Duration(config.RotationInterval), int64(config.RotationMaxSize), config.RotationMaxArchives); err != nil {
129-
log.Printf("E! Unable to open %s (%s), using stderr", config.Logfile, err)
128+
if writer, err = rotate.NewFileWriter(cfg.Logfile, time.Duration(cfg.RotationInterval), int64(cfg.RotationMaxSize), cfg.RotationMaxArchives); err != nil {
129+
log.Printf("E! Unable to open %s (%s), using stderr", cfg.Logfile, err)
130130
writer = defaultWriter
131131
}
132132
} else {
@@ -135,34 +135,34 @@ func (t *telegrafLogCreator) CreateLogger(config LogConfig) (io.Writer, error) {
135135
case LogTargetStderr, "":
136136
writer = defaultWriter
137137
default:
138-
log.Printf("E! Unsupported logtarget: %s, using stderr", config.LogTarget)
138+
log.Printf("E! Unsupported logtarget: %s, using stderr", cfg.LogTarget)
139139
writer = defaultWriter
140140
}
141141

142-
return newTelegrafWriter(writer, config)
142+
return newTelegrafWriter(writer, cfg)
143143
}
144144

145145
// Keep track what is actually set as a log output, because log package doesn't provide a getter.
146146
// It allows closing previous writer if re-set and have possibility to test what is actually set
147147
var actualLogger io.Writer
148148

149-
func newLogWriter(config LogConfig) io.Writer {
149+
func newLogWriter(cfg LogConfig) io.Writer {
150150
log.SetFlags(0)
151-
if config.Debug {
151+
if cfg.Debug {
152152
wlog.SetLevel(wlog.DEBUG)
153153
}
154-
if config.Quiet {
154+
if cfg.Quiet {
155155
wlog.SetLevel(wlog.ERROR)
156156
}
157-
if !config.Debug && !config.Quiet {
157+
if !cfg.Debug && !cfg.Quiet {
158158
wlog.SetLevel(wlog.INFO)
159159
}
160160
var logWriter io.Writer
161-
if logCreator, ok := loggerRegistry[config.LogTarget]; ok {
162-
logWriter, _ = logCreator.CreateLogger(config)
161+
if logCreator, ok := loggerRegistry[cfg.LogTarget]; ok {
162+
logWriter, _ = logCreator.CreateLogger(cfg)
163163
}
164164
if logWriter == nil {
165-
logWriter, _ = (&telegrafLogCreator{}).CreateLogger(config)
165+
logWriter, _ = (&telegrafLogCreator{}).CreateLogger(cfg)
166166
}
167167

168168
if closer, isCloser := actualLogger.(io.Closer); isCloser {

‎logger/logger_test.go

+18-18
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ func TestWriteLogToFile(t *testing.T) {
1818
assert.NoError(t, err)
1919
defer func() { os.Remove(tmpfile.Name()) }()
2020

21-
config := createBasicLogConfig(tmpfile.Name())
22-
SetupLogging(config)
21+
cfg := createBasicLogConfig(tmpfile.Name())
22+
SetupLogging(cfg)
2323
log.Printf("I! TEST")
2424
log.Printf("D! TEST") // <- should be ignored
2525

@@ -32,9 +32,9 @@ func TestDebugWriteLogToFile(t *testing.T) {
3232
tmpfile, err := os.CreateTemp("", "")
3333
assert.NoError(t, err)
3434
defer func() { os.Remove(tmpfile.Name()) }()
35-
config := createBasicLogConfig(tmpfile.Name())
36-
config.Debug = true
37-
SetupLogging(config)
35+
cfg := createBasicLogConfig(tmpfile.Name())
36+
cfg.Debug = true
37+
SetupLogging(cfg)
3838
log.Printf("D! TEST")
3939

4040
f, err := os.ReadFile(tmpfile.Name())
@@ -46,9 +46,9 @@ func TestErrorWriteLogToFile(t *testing.T) {
4646
tmpfile, err := os.CreateTemp("", "")
4747
assert.NoError(t, err)
4848
defer func() { os.Remove(tmpfile.Name()) }()
49-
config := createBasicLogConfig(tmpfile.Name())
50-
config.Quiet = true
51-
SetupLogging(config)
49+
cfg := createBasicLogConfig(tmpfile.Name())
50+
cfg.Quiet = true
51+
SetupLogging(cfg)
5252
log.Printf("E! TEST")
5353
log.Printf("I! TEST") // <- should be ignored
5454

@@ -61,9 +61,9 @@ func TestAddDefaultLogLevel(t *testing.T) {
6161
tmpfile, err := os.CreateTemp("", "")
6262
assert.NoError(t, err)
6363
defer func() { os.Remove(tmpfile.Name()) }()
64-
config := createBasicLogConfig(tmpfile.Name())
65-
config.Debug = true
66-
SetupLogging(config)
64+
cfg := createBasicLogConfig(tmpfile.Name())
65+
cfg.Debug = true
66+
SetupLogging(cfg)
6767
log.Printf("TEST")
6868

6969
f, err := os.ReadFile(tmpfile.Name())
@@ -75,9 +75,9 @@ func TestWriteToTruncatedFile(t *testing.T) {
7575
tmpfile, err := os.CreateTemp("", "")
7676
assert.NoError(t, err)
7777
defer func() { os.Remove(tmpfile.Name()) }()
78-
config := createBasicLogConfig(tmpfile.Name())
79-
config.Debug = true
80-
SetupLogging(config)
78+
cfg := createBasicLogConfig(tmpfile.Name())
79+
cfg.Debug = true
80+
SetupLogging(cfg)
8181
log.Printf("TEST")
8282

8383
f, err := os.ReadFile(tmpfile.Name())
@@ -114,20 +114,20 @@ func TestWriteToFileInRotation(t *testing.T) {
114114
}
115115

116116
func TestLogTargetSettings(t *testing.T) {
117-
config := LogConfig{
117+
cfg := LogConfig{
118118
LogTarget: "",
119119
Quiet: true,
120120
}
121-
SetupLogging(config)
121+
SetupLogging(cfg)
122122
logger, isTelegrafLogger := actualLogger.(*telegrafLog)
123123
assert.True(t, isTelegrafLogger)
124124
assert.Equal(t, logger.internalWriter, os.Stderr)
125125

126-
config = LogConfig{
126+
cfg = LogConfig{
127127
LogTarget: "stderr",
128128
Quiet: true,
129129
}
130-
SetupLogging(config)
130+
SetupLogging(cfg)
131131
logger, isTelegrafLogger = actualLogger.(*telegrafLog)
132132
assert.True(t, isTelegrafLogger)
133133
assert.Equal(t, logger.internalWriter, os.Stderr)

‎models/log.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ func logName(pluginType, name, alias string) string {
7979
return pluginType + "." + name + "::" + alias
8080
}
8181

82-
func SetLoggerOnPlugin(i interface{}, log telegraf.Logger) {
82+
func SetLoggerOnPlugin(i interface{}, logger telegraf.Logger) {
8383
valI := reflect.ValueOf(i)
8484

8585
if valI.Type().Kind() != reflect.Ptr {
@@ -94,10 +94,10 @@ func SetLoggerOnPlugin(i interface{}, log telegraf.Logger) {
9494
switch field.Type().String() {
9595
case "telegraf.Logger":
9696
if field.CanSet() {
97-
field.Set(reflect.ValueOf(log))
97+
field.Set(reflect.ValueOf(logger))
9898
}
9999
default:
100-
log.Debugf("Plugin %q defines a 'Log' field on its struct of an unexpected type %q. Expected telegraf.Logger",
100+
logger.Debugf("Plugin %q defines a 'Log' field on its struct of an unexpected type %q. Expected telegraf.Logger",
101101
valI.Type().Name(), field.Type().String())
102102
}
103103
}

‎models/running_aggregator.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ func (r *RunningAggregator) UpdateWindow(start, until time.Time) {
108108
r.log.Debugf("Updated aggregation range [%s, %s]", start, until)
109109
}
110110

111-
func (r *RunningAggregator) MakeMetric(metric telegraf.Metric) telegraf.Metric {
111+
func (r *RunningAggregator) MakeMetric(telegrafMetric telegraf.Metric) telegraf.Metric {
112112
m := makemetric(
113-
metric,
113+
telegrafMetric,
114114
r.Config.NameOverride,
115115
r.Config.MeasurementPrefix,
116116
r.Config.MeasurementSuffix,

‎plugins/common/shim/example/cmd/main.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ var err error
2121
//
2222
// However, if you want to do all your config in code, you can like so:
2323
//
24-
// // initialize your plugin with any settngs you want
24+
// // initialize your plugin with any settings you want
2525
// myInput := &mypluginname.MyPlugin{
2626
// DefaultSettingHere: 3,
2727
// }
@@ -40,20 +40,20 @@ func main() {
4040
}
4141

4242
// create the shim. This is what will run your plugins.
43-
shim := shim.New()
43+
shimLayer := shim.New()
4444

4545
// If no config is specified, all imported plugins are loaded.
46-
// otherwise follow what the config asks for.
46+
// otherwise, follow what the config asks for.
4747
// Check for settings from a config toml file,
4848
// (or just use whatever plugins were imported above)
49-
err = shim.LoadConfig(configFile)
49+
err = shimLayer.LoadConfig(configFile)
5050
if err != nil {
5151
fmt.Fprintf(os.Stderr, "Err loading input: %s\n", err)
5252
os.Exit(1)
5353
}
5454

5555
// run a single plugin until stdin closes or we receive a termination signal
56-
if err := shim.Run(*pollInterval); err != nil {
56+
if err := shimLayer.Run(*pollInterval); err != nil {
5757
fmt.Fprintf(os.Stderr, "Err: %s\n", err)
5858
os.Exit(1)
5959
}

‎testutil/metric.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"github.com/google/go-cmp/cmp"
1010
"github.com/google/go-cmp/cmp/cmpopts"
1111
"github.com/influxdata/telegraf"
12-
"github.com/influxdata/telegraf/metric"
12+
telegrafMetric "github.com/influxdata/telegraf/metric"
1313
)
1414

1515
type metricDiff struct {
@@ -177,19 +177,19 @@ func RequireMetricsEqual(t *testing.T, expected, actual []telegraf.Metric, opts
177177
}
178178
}
179179

180-
// Metric creates a new metric or panics on error.
180+
// MustMetric creates a new metric.
181181
func MustMetric(
182182
name string,
183183
tags map[string]string,
184184
fields map[string]interface{},
185185
tm time.Time,
186186
tp ...telegraf.ValueType,
187187
) telegraf.Metric {
188-
m := metric.New(name, tags, fields, tm, tp...)
188+
m := telegrafMetric.New(name, tags, fields, tm, tp...)
189189
return m
190190
}
191191

192192
func FromTestMetric(met *Metric) telegraf.Metric {
193-
m := metric.New(met.Measurement, met.Tags, met.Fields, met.Time, met.Type)
193+
m := telegrafMetric.New(met.Measurement, met.Tags, met.Fields, met.Time, met.Type)
194194
return m
195195
}

0 commit comments

Comments
 (0)