Include software version in requests in order to collect metrics for the client on brokers

[omersiar]

Hi,

Brokers can track of client versions and their metrics can be collected from JMX. We discovered almost every library set their software version but not the sarama.

https://docs.confluent.io/platform/current/kafka/monitoring.html#clientsoftwarename-clientsoftwareversion

[omersiar]

Maybe related to issue below, since sarama incorporates version.go

golang/go#50603

[omersiar]

If I understand correctly, if boolean returned true it may not reflect the dependent package

franz-go implemented like this:
https://github.com/twmb/franz-go/blob/master/pkg/kgo/config.go#L418-L430

[dnwe]

@omersiar Sarama does send its software name and version to Kafka as long as you are using sarama.Version = V2_4_0_0 or newer in your config and haven't disabled it via https://github.com/IBM/sarama/blob/5f63a84f47c39bf08a1c276f1f6b5f1d754e9fc3/config.go#L485-L489C2

sarama/broker.go

Lines 176 to 201 in 5f63a84

	usingApiVersionsRequests := conf.Version.IsAtLeast(V2_4_0_0) && conf.ApiVersionsRequest
	b.lock.Lock()
	if b.metricRegistry == nil {
	b.metricRegistry = newCleanupRegistry(conf.MetricRegistry)
	}
	go withRecover(func() {
	defer func() {
	b.lock.Unlock()
	// Send an ApiVersionsRequest to identify the client (KIP-511).
	// Ideally Sarama would use the response to control protocol versions,
	// but for now just fire-and-forget just to send
	if usingApiVersionsRequests {
	_, err = b.ApiVersions(&ApiVersionsRequest{
	Version: 3,
	ClientSoftwareName: defaultClientSoftwareName,
	ClientSoftwareVersion: version(),
	})
	if err != nil {
	Logger.Printf("Error while sending ApiVersionsRequest to broker %s: %s\n", b.addr, err)
	}
	}
	}()

[ijuma]

It's suboptimal that this isn't sent by default though. Can we send API versions by default and ignore the error if the broker doesn't understand it?

[github-actions]

Thank you for taking the time to raise this issue. However, it has not had any activity on it in the past 90 days and will be closed in 30 days if no updates occur.
Please check if the main branch has already resolved the issue since it was raised. If you believe the issue is still valid and you would like input from the maintainers then please comment to ask for it to be reviewed.