chore: Fix linter findings for unparam and revive.unused-parameter #12150

zak-pawel · 2022-11-03T01:12:39Z

unparam and revive.unused-parameter linters enabled.

Fixes for following findings were made (for default configuration):

agent/tick.go:140:50                                                              unparam      (*UnalignedTicker).start - result 0 (*github.com/influxdata/telegraf/agent.UnalignedTicker) is never used
agent/tick.go:237:48                                                              unparam      (*RollingTicker).start - result 0 (*github.com/influxdata/telegraf/agent.RollingTicker) is never used
cmd/telegraf/main_test.go:30:29                                                   revive       unused-parameter: parameter 'serverErr' seems to be unused, consider removing or renaming it as _
cmd/telegraf/main_test.go:50:46                                                   revive       unused-parameter: parameter 'inFilter' seems to be unused, consider removing or renaming it as _
cmd/telegraf/main_test.go:68:28                                                   revive       unused-parameter: parameter 'address' seems to be unused, consider removing or renaming it as _
config/config.go:1046:82                                                          unparam      (*Config).buildParser - result 1 (error) is always nil
plugins/common/tls/config.go:205:65                                               revive       unused-parameter: parameter 'verifiedChains' seems to be unused, consider removing or renaming it as _
plugins/inputs/amd_rocm_smi/amd_rocm_smi.go:62:45                                 unparam      (*ROCmSMI).pollROCmSMI - result 1 (error) is always nil
plugins/inputs/cloudwatch/cloudwatch.go:320:63                                    unparam      (*CloudWatch).fetchNamespaceMetrics - result 1 (error) is always nil
plugins/inputs/cloudwatch/cloudwatch_test.go:156:76                               revive       unused-parameter: parameter 'params' seems to be unused, consider removing or renaming it as _
plugins/inputs/cloudwatch/cloudwatch_test.go:203:78                               revive       unused-parameter: parameter 'params' seems to be unused, consider removing or renaming it as _
plugins/inputs/cloudwatch_metric_streams/cloudwatch_metric_streams_test.go:72:16  revive       unused-parameter: parameter 'metricStream' seems to be unused, consider removing or renaming it as _
plugins/inputs/cloudwatch_metric_streams/cloudwatch_metric_streams_test.go:72:44  unparam      `createURL` - `rawQuery` always receives `""`
plugins/inputs/procstat/procstat.go:301:121                                       unparam      (*Procstat).updateProcesses - result 0 (error) is always nil
plugins/inputs/sflow/metricencoder.go:11:51                                       unparam      makeMetrics - result 1 (error) is always nil
plugins/outputs/azure_data_explorer/azure_data_explorer_test.go:343:35            revive       unused-parameter: parameter 'ctx' seems to be unused, consider removing or renaming it as _
plugins/outputs/azure_data_explorer/azure_data_explorer_test.go:350:33            revive       unused-parameter: parameter 'ctx' seems to be unused, consider removing or renaming it as _
plugins/outputs/dynatrace/dynatrace_test.go:519:27                                revive       unused-parameter: parameter 'format' seems to be unused, consider removing or renaming it as _
plugins/outputs/groundwork/groundwork.go:213:98                                   unparam      (*Groundwork).parseMetric - result 2 (error) is always nil
plugins/outputs/postgresql/postgresql.go:277:76                                   unparam      (*Postgresql).writeConcurrent - result 0 (error) is always nil
plugins/outputs/postgresql/table_source_test.go:17:22                             revive       unused-parameter: parameter 't' seems to be unused, consider removing or renaming it as _
plugins/parsers/json_v2/parser.go:576:28                                          revive       unused-parameter: parameter 'line' seems to be unused, consider removing or renaming it as _
plugins/parsers/prometheusremotewrite/parser.go:87:33                             revive       unused-parameter: parameter 'config' seems to be unused, consider removing or renaming it as _
plugins/serializers/carbon2/carbon2_test.go:200:24                                unparam      `TestSerializeMetricBool$1` - `t` is unused
tools/custom_builder/config.go:54:70                                              unparam      (*selection).Filter - result 1 (error) is always nil

Moreover, I enabled locally check-exported flag for unparam linter and fixed following findings:

agent/agent.go:27:44                                                          unparam  NewAgent - result 1 (error) is always nil
internal/content_coding.go:138:38                                             unparam  NewGzipEncoder - result 1 (error) is always nil
internal/content_coding.go:166:38                                             unparam  NewZlibEncoder - result 1 (error) is always nil
internal/content_coding.go:212:38                                             unparam  NewGzipDecoder - result 1 (error) is always nil
internal/content_coding.go:243:38                                             unparam  NewZlibDecoder - result 1 (error) is always nil
internal/snmp/translate.go:179:97                                             unparam  `GetIndex` - result `err` is always `nil`
metric/series_grouper.go:45:3                                                 unparam  (*SeriesGrouper).Add - result 0 (error) is always nil
plugins/common/shim/config.go:150:40                                          unparam  DefaultImportedPlugins - result 1 (error) is always nil
plugins/inputs/knx_listener/knx_dummy_interface.go:11:49                      unparam  `NewDummyInterface` - result `err` is always `nil`
plugins/inputs/opcua/read_client.go:146:84                                    unparam  (*ReadClient).StartStreamValues - result 1 (error) is always nil
plugins/inputs/snmp_legacy/snmp_legacy.go:631:12                              unparam  (*Host).HandleResponse - result 1 (error) is always nil
plugins/outputs/postgresql/table_source.go:22:48                              unparam  (*columnList).Add - result 0 (bool) is never used
plugins/parsers/influx/handler.go:41:52                                       unparam  (*MetricHandler).Metric - result 1 (error) is always nil
plugins/serializers/influx/influx.go:127:61                                   unparam  (*Serializer).Write - result 0 (int) is never used
plugins/serializers/prometheus/prometheus.go:49:55                            unparam  NewSerializer - result 1 (error) is always nil
plugins/serializers/prometheusremotewrite/prometheusremotewrite.go:46:55      unparam  NewSerializer - result 1 (error) is always nil
plugins/serializers/registry.go:239:61                                        unparam  NewInfluxSerializerConfig - result 1 (error) is always nil
plugins/serializers/registry.go:257:41                                        unparam  NewInfluxSerializer - result 1 (error) is always nil
plugins/serializers/registry.go:290:42                                        unparam  NewMsgpackSerializer - result 1 (error) is always nil
plugins/serializers/splunkmetric/splunkmetric.go:34:124                       unparam  NewSerializer - result 1 (error) is always nil
plugins/serializers/wavefront/wavefront.go:51:129                             unparam  NewSerializer - result 1 (error) is always nil
testutil/container.go:135:33                                                  unparam  (*Container).Terminate - result 0 (error) is always nil

Unfortunatelly unparam linter is not able to check if function with result ... is always nil problem implements interface (so it must return something), thus following findings weren't fixed and check-exported was not enabled globally:

models/running_processor_test.go:50:38                                        unparam  (*MockProcessorToInit).Init - result 0 (error) is always nil
plugins/aggregators/basicstats/basicstats.go:284:29                           unparam  (*BasicStats).Init - result 0 (error) is always nil
plugins/aggregators/derivative/derivative.go:173:29                           unparam  (*Derivative).Init - result 0 (error) is always nil
plugins/aggregators/merge/merge.go:24:24                                      unparam  (*Merge).Init - result 0 (error) is always nil
plugins/common/starlark/metric.go:74:53                                       unparam  (*Metric).Attr - result 1 (error) is always nil
plugins/inputs/aliyuncms/aliyuncms.go:208:49                                  unparam  (*AliyunCMS).Start - result 0 (error) is always nil
plugins/inputs/bind/bind.go:33:23                                             unparam  (*Bind).Init - result 0 (error) is always nil
plugins/inputs/cassandra/cassandra.go:240:51                                  unparam  (*Cassandra).Start - result 0 (error) is always nil
plugins/inputs/cloudwatch_metric_streams/cloudwatch_metric_streams.go:402:44  unparam  (*CloudWatchMetricStreams).Init - result 0 (error) is always nil
plugins/inputs/consul/consul.go:40:25                                         unparam  (*Consul).Init - result 0 (error) is always nil
plugins/inputs/cpu/cpu.go:137:27                                              unparam  (*CPUStats).Init - result 0 (error) is always nil
plugins/inputs/directory_monitor/directory_monitor.go:138:66                  unparam  (*DirectoryMonitor).Start - result 0 (error) is always nil
plugins/inputs/disk/disk.go:33:29                                             unparam  (*DiskStats).Init - result 0 (error) is always nil
plugins/inputs/http_listener_v2/http_listener_v2.go:89:58                     unparam  (*HTTPListenerV2).Start - result 0 (error) is always nil
plugins/inputs/influxdb_listener/influxdb_listener.go:92:35                   unparam  (*InfluxDBListener).Init - result 0 (error) is always nil
plugins/inputs/influxdb_v2_listener/influxdb_v2_listener.go:103:37            unparam  (*InfluxDBV2Listener).Init - result 0 (error) is always nil
plugins/inputs/internet_speed/internet_speed.go:33:33                         unparam  (*InternetSpeed).Init - result 0 (error) is always nil
plugins/inputs/logparser/logparser.go:89:34                                   unparam  (*LogParserPlugin).Init - result 0 (error) is always nil
plugins/inputs/mailchimp/mailchimp.go:30:28                                   unparam  (*MailChimp).Init - result 0 (error) is always nil
plugins/inputs/mem/mem.go:26:28                                               unparam  (*MemStats).Init - result 0 (error) is always nil
plugins/inputs/mock/mock.go:67:23                                             unparam  (*Mock).Init - result 0 (error) is always nil
plugins/inputs/multifile/multifile.go:37:28                                   unparam  (*MultiFile).Init - result 0 (error) is always nil
plugins/inputs/nfsclient/nfsclient.go:318:28                                  unparam  (*NFSClient).Init - result 0 (error) is always nil
plugins/inputs/postgresql/postgresql.go:38:29                                 unparam  (*Postgresql).Init - result 0 (error) is always nil
plugins/inputs/procstat/procstat.go:514:27                                    unparam  (*Procstat).Init - result 0 (error) is always nil
plugins/inputs/sflow/sflow.go:42:24                                           unparam  (*SFlow).Init - result 0 (error) is always nil
plugins/inputs/sqlserver/sqlserver.go:418:28                                  unparam  (*SQLServer).Init - result 0 (error) is always nil
plugins/outputs/exec/exec.go:41:23                                            unparam  (*Exec).Init - result 0 (error) is always nil
plugins/outputs/prometheus_client/v1/collector.go:192:52                      unparam  (*Collector).Add - result 0 (error) is always nil
plugins/outputs/prometheus_client/v2/collector.go:85:52                       unparam  (*Collector).Add - result 0 (error) is always nil
plugins/outputs/warp10/warp10.go:209:25                                       unparam  (*Warp10).Init - result 0 (error) is always nil
plugins/parsers/collectd/parser_test.go:18:50                                 unparam  (*AuthMap).Password - result 1 (error) is always nil
plugins/parsers/dropwizard/parser.go:241:57                                   unparam  (*Parser).InitFromConfig - result 0 (error) is always nil
plugins/parsers/form_urlencoded/parser.go:102:57                              unparam  (*Parser).InitFromConfig - result 0 (error) is always nil
plugins/parsers/nagios/parser.go:324:57                                       unparam  (*Parser).InitFromConfig - result 0 (error) is always nil
plugins/parsers/prometheus/parser.go:211:57                                   unparam  (*Parser).InitFromConfig - result 0 (error) is always nil
plugins/processors/port_name/port_name.go:197:28                              unparam  (*PortName).Init - result 0 (error) is always nil
plugins/serializers/carbon2/carbon2.go:61:65                                  unparam  (*Serializer).Serialize - result 1 (error) is always nil
plugins/serializers/carbon2/carbon2.go:65:73                                  unparam  (*Serializer).SerializeBatch - result 1 (error) is always nil
plugins/serializers/graphite/graphite.go:50:73                                unparam  (*GraphiteSerializer).Serialize - result 1 (error) is always nil
plugins/serializers/splunkmetric/splunkmetric.go:44:65                        unparam  (*serializer).Serialize - result 1 (error) is always nil
plugins/serializers/splunkmetric/splunkmetric.go:48:73                        unparam  (*serializer).SerializeBatch - result 1 (error) is always nil
plugins/serializers/wavefront/wavefront.go:101:69                             unparam  (*WavefrontSerializer).Serialize - result 1 (error) is always nil
plugins/serializers/wavefront/wavefront.go:110:82                             unparam  (*WavefrontSerializer).SerializeBatch - result 1 (error) is always nil

zak-pawel · 2022-11-03T01:24:12Z

@LarsStegman you introduced few days ago, in this PR #11786 in plugins/inputs/opcua/read_client.go function which is not used:

// StartStreamValues does nothing for the read client, as it has to actively fetch values. The channel is closed immediately.
func (o *ReadClient) StartStreamValues(_ context.Context) (<-chan telegraf.Metric, error) {
	c := make(chan telegraf.Metric)
	defer close(c)
	return c, nil
}

Was that a mistake? Are you ok with removing it in this PR?
@reimda @Hipska @powersj @srebhan Do you know something in this topic?

zak-pawel · 2022-11-03T01:33:41Z

@powersj You introduced in this PR #11672 in plugins/outputs/postgresql/postgresql.go following function:

func (p *Postgresql) writeConcurrent(tableSources map[string]*TableSource) error {
	for _, tableSource := range tableSources {
		select {
		case p.writeChan <- tableSource:
		case <-p.dbContext.Done():
			return nil
		}
	}
	return nil
}

In this PR I removed return values (it doesn't make sense to return always nil). But I wonder if this function works as it should?
I mean it differs from writeSequential(...)...

LarsStegman · 2022-11-03T05:52:30Z

@LarsStegman you introduced few days ago, in this PR #11786 in plugins/inputs/opcua/read_client.go function which is not used:
// StartStreamValues does nothing for the read client, as it has to actively fetch values. The channel is closed immediately.
func (o *ReadClient) StartStreamValues(_ context.Context) (<-chan telegraf.Metric, error) {
	c := make(chan telegraf.Metric)
	defer close(c)
	return c, nil
}
Was that a mistake? Are you ok with removing it in this PR? @reimda @Hipska @powersj @srebhan Do you know something in this topic?

Yea you can remove it. It is a remainder from when the listener and read plug-in were still combined. I either loaded the listener client or read client which both implemented an interface, but that is not needed anymore now that they are split into separate plugins. Thanks!

# Conflicts: # plugins/inputs/kafka_consumer/kafka_consumer_test.go

powersj · 2022-11-08T15:29:50Z

FYI going to need to deal with conflicts

# Conflicts: # plugins/inputs/cloudwatch/cloudwatch_test.go # plugins/inputs/cloudwatch_metric_streams/cloudwatch_metric_streams_test.go # plugins/inputs/opcua/opcua_test.go # plugins/inputs/opcua_listener/opcua_listener_test.go

telegraf-tiger · 2022-11-08T18:52:08Z

Download PR build artifacts for linux_amd64.tar.gz, darwin_amd64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB	RPM	TAR GZ	ZIP
amd64.deb	aarch64.rpm	darwin_amd64.tar.gz	windows_amd64.zip
arm64.deb	armel.rpm	darwin_arm64.tar.gz	windows_i386.zip
armel.deb	armv6hl.rpm	freebsd_amd64.tar.gz
armhf.deb	i386.rpm	freebsd_armv7.tar.gz
i386.deb	ppc64le.rpm	freebsd_i386.tar.gz
mips.deb	riscv64.rpm	linux_amd64.tar.gz
mipsel.deb	s390x.rpm	linux_arm64.tar.gz
ppc64el.deb	x86_64.rpm	linux_armel.tar.gz
riscv64.deb		linux_armhf.tar.gz
s390x.deb		linux_i386.tar.gz
		linux_mips.tar.gz
		linux_mipsel.tar.gz
		linux_ppc64le.tar.gz
		linux_riscv64.tar.gz
		linux_s390x.tar.gz
		static_linux_amd64.tar.gz

zak-pawel · 2022-11-08T19:02:17Z

@powersj Deal done!

tj--- · 2024-04-04T12:04:21Z

plugins/parsers/influx/parser.go

@@ -100,11 +100,7 @@ func (p *Parser) Parse(input []byte) ([]telegraf.Metric, error) {
 			}
 		}

-		metric, err := p.handler.Metric()


@powersj I was trying to contrast this change with the Graphite Parser and the socketlistener (which uses the parsers).
The Graphite parser continues to return both errors and metrics. However, the socket_listener ignores the metrics if there are errors found.

Shouldn't the socket_listener try to accept the metrics that it received and also that the influx parser should send back the errors as well?

chore: Fix linter findings for unparam and revive.unused-parameter

e9325f8

telegraf-tiger bot added the chore label Nov 3, 2022

chore: Fix linter findings for unparam and revive.unused-parameter

2252927

zak-pawel added panic issue that results in panics from Telegraf and removed panic issue that results in panics from Telegraf labels Nov 3, 2022

Pawel Zak added 2 commits November 3, 2022 15:45

Merge remote-tracking branch 'upstream/master' into unparam-unused

91126d4

# Conflicts: # plugins/inputs/kafka_consumer/kafka_consumer_test.go

chore: Fix linter findings for unparam and revive.unused-parameter

54d52c9

powersj approved these changes Nov 8, 2022

View reviewed changes

powersj added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Nov 8, 2022

MyaLongmire approved these changes Nov 8, 2022

View reviewed changes

powersj merged commit 6816aef into influxdata:master Nov 8, 2022

tj--- reviewed Apr 4, 2024

View reviewed changes

zak-pawel added the linter label Nov 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Fix linter findings for unparam and revive.unused-parameter #12150

chore: Fix linter findings for unparam and revive.unused-parameter #12150

zak-pawel commented Nov 3, 2022

zak-pawel commented Nov 3, 2022

zak-pawel commented Nov 3, 2022

LarsStegman commented Nov 3, 2022 •

edited

Loading

powersj commented Nov 8, 2022

telegraf-tiger bot commented Nov 8, 2022

Artifact URLs

zak-pawel commented Nov 8, 2022

tj--- Apr 4, 2024

chore: Fix linter findings for unparam and revive.unused-parameter #12150

chore: Fix linter findings for unparam and revive.unused-parameter #12150

Conversation

zak-pawel commented Nov 3, 2022

zak-pawel commented Nov 3, 2022

zak-pawel commented Nov 3, 2022

LarsStegman commented Nov 3, 2022 • edited Loading

powersj commented Nov 8, 2022

telegraf-tiger bot commented Nov 8, 2022

Artifact URLs

zak-pawel commented Nov 8, 2022

tj--- Apr 4, 2024

Choose a reason for hiding this comment

LarsStegman commented Nov 3, 2022 •

edited

Loading