feat(banner): standardize user agent and output

Makefile

@@ -88,8 +88,10 @@ IMAGE_STAGING  = gcr.io/k8s-staging-external-dns/$(BINARY)
 REGISTRY      ?= us.gcr.io/k8s-artifacts-prod/external-dns
 IMAGE         ?= $(REGISTRY)/$(BINARY)
 VERSION       ?= $(shell git describe --tags --always --dirty --match "v*")
+GIT_COMMIT    ?= $(shell git rev-parse --short HEAD)
 BUILD_FLAGS   ?= -v
 LDFLAGS       ?= -X sigs.k8s.io/external-dns/pkg/apis/externaldns.Version=$(VERSION) -w -s
+LDFLAGS       += -X sigs.k8s.io/external-dns/pkg/apis/externaldns.GitCommit=$(GIT_COMMIT)
 ARCH          ?= amd64
 SHELL          = /bin/bash
 IMG_PLATFORM  ?= linux/amd64,linux/arm64,linux/arm/v7

main.go

@@ -108,6 +108,8 @@ func main() {
 		klog.SetLogger(logr.Discard())
 	}
 
+	log.Info(externaldns.Banner())
+
 	ctx, cancel := context.WithCancel(context.Background())
 
 	go serveMetrics(cfg.MetricsAddress)
@@ -258,7 +260,7 @@ func main() {
 	case "ovh":
 		p, err = ovh.NewOVHProvider(ctx, domainFilter, cfg.OVHEndpoint, cfg.OVHApiRateLimit, cfg.DryRun)
 	case "linode":
-		p, err = linode.NewLinodeProvider(domainFilter, cfg.DryRun, externaldns.Version)
+		p, err = linode.NewLinodeProvider(domainFilter, cfg.DryRun)
 	case "dnsimple":
 		p, err = dnsimple.NewDnsimpleProvider(domainFilter, zoneIDFilter, cfg.DryRun)
 	case "coredns", "skydns":

pkg/apis/externaldns/types.go

@@ -38,9 +38,6 @@ const (
 	passwordMask = "******"
 )
 
-// Version is the current version of the app, generated at build time
-var Version = "unknown"
-
 // Config is a project-wide configuration
 type Config struct {
 	APIServerURL                       string

pkg/apis/externaldns/version.go

@@ -0,0 +1,48 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package externaldns
+
+import (
+	"fmt"
+	"runtime"
+)
+
+const (
+	bannerTemplate = `GitCommitShort=%s, GoVersion=%s, Platform=%s, UserAgent=%s`
+)
+
+var (
+	Version          = "unknown" // Set at the build time via `-ldflags "-X main.Version=<value>"`
+	GitCommit        = "unknown" // Set at the build time via `-ldflags "-X main.GitCommitSHA=<value>"`
+	UserAgentProduct = "ExternalDNS"
+	goVersion        = runtime.Version()
+)
+
+func UserAgent() string {
+	return fmt.Sprintf("%s/%s", UserAgentProduct, Version)
+}
+
+func Banner() string {
+	platform := fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH)
+	return fmt.Sprintf(
+		bannerTemplate,
+		GitCommit,
+		goVersion,
+		platform,
+		UserAgent(),
+	)
+}

pkg/apis/externaldns/version_test.go

@@ -0,0 +1,35 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package externaldns
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestBanner(t *testing.T) {
+	// Set variables to known values
+	Version = "1.0.0"
+	goVersion = "go1.17"
+	GitCommit = "49a0c57c7"
+
+	want := Banner()
+	assert.Contains(t, want, "GoVersion=go1.17")
+	assert.Contains(t, want, "GitCommitShort=49a0c57c7")
+	assert.Contains(t, want, "UserAgent=ExternalDNS/1.0.0")
+}

provider/civo/civo.go

@@ -87,7 +87,7 @@ func NewCivoProvider(domainFilter endpoint.DomainFilter, dryRun bool) (*CivoProv
 	}
 
 	userAgent := &civogo.Component{
-		Name:    "external-dns",
+		Name:    externaldns.UserAgentProduct,
 		Version: externaldns.Version,
 	}
 	civoClient.SetUserAgent(userAgent)

provider/digitalocean/digital_ocean.go

@@ -85,7 +85,7 @@ func NewDigitalOceanProvider(ctx context.Context, domainFilter endpoint.DomainFi
 	oauthClient := oauth2.NewClient(ctx, oauth2.StaticTokenSource(&oauth2.Token{
 		AccessToken: token,
 	}))
-	client, err := godo.New(oauthClient, godo.SetUserAgent("ExternalDNS/"+externaldns.Version))
+	client, err := godo.New(oauthClient, godo.SetUserAgent(externaldns.UserAgent()))
 	if err != nil {
 		return nil, err
 	}

provider/dnsimple/dnsimple.go

@@ -108,7 +108,7 @@ func NewDnsimpleProvider(domainFilter endpoint.DomainFilter, zoneIDFilter provid
 	tc := oauth2.NewClient(context.Background(), ts)
 
 	client := dnsimple.NewClient(tc)
-	client.SetUserAgent(fmt.Sprintf("Kubernetes ExternalDNS/%s", externaldns.Version))
+	client.SetUserAgent(externaldns.UserAgent())
 
 	provider := &dnsimpleProvider{
 		client:       dnsimpleZoneService{service: client.Zones},

provider/godaddy/client.go

@@ -224,7 +224,7 @@ func (c *Client) NewRequest(method, path string, reqBody interface{}) (*http.Req
 	}
 	req.Header.Set("Authorization", fmt.Sprintf("sso-key %s:%s", c.APIKey, c.APISecret))
 	req.Header.Set("Accept", "application/json")
-	req.Header.Set("User-Agent", "ExternalDNS/"+externaldns.Version)
+	req.Header.Set("User-Agent", externaldns.UserAgent())
 
 	// Send the request with requested timeout
 	c.Client.Timeout = c.Timeout

provider/linode/linode.go

@@ -31,6 +31,8 @@ import (
 	"sigs.k8s.io/external-dns/endpoint"
 	"sigs.k8s.io/external-dns/plan"
 	"sigs.k8s.io/external-dns/provider"
+
+	"sigs.k8s.io/external-dns/pkg/apis/externaldns"
 )
 
 // LinodeDomainClient interface to ease testing
@@ -77,7 +79,7 @@ type LinodeChangeDelete struct {
 }
 
 // NewLinodeProvider initializes a new Linode DNS based Provider.
-func NewLinodeProvider(domainFilter endpoint.DomainFilter, dryRun bool, appVersion string) (*LinodeProvider, error) {
+func NewLinodeProvider(domainFilter endpoint.DomainFilter, dryRun bool) (*LinodeProvider, error) {
 	token, ok := os.LookupEnv("LINODE_TOKEN")
 	if !ok {
 		return nil, fmt.Errorf("no token found")
@@ -92,7 +94,7 @@ func NewLinodeProvider(domainFilter endpoint.DomainFilter, dryRun bool, appVersi
 	}
 
 	linodeClient := linodego.NewClient(oauth2Client)
-	linodeClient.SetUserAgent(fmt.Sprintf("ExternalDNS/%s linodego/%s", appVersion, linodego.Version))
+	linodeClient.SetUserAgent(fmt.Sprintf("%s linodego/%s", externaldns.UserAgent(), linodego.Version))
 
 	provider := &LinodeProvider{
 		Client:       &linodeClient,

provider/linode/linode_test.go

@@ -145,11 +145,11 @@ func TestLinodeConvertRecordType(t *testing.T) {
 
 func TestNewLinodeProvider(t *testing.T) {
 	_ = os.Setenv("LINODE_TOKEN", "xxxxxxxxxxxxxxxxx")
-	_, err := NewLinodeProvider(endpoint.NewDomainFilter([]string{"ext-dns-test.zalando.to."}), true, "1.0")
+	_, err := NewLinodeProvider(endpoint.NewDomainFilter([]string{"ext-dns-test.zalando.to."}), true)
 	require.NoError(t, err)
 
 	_ = os.Unsetenv("LINODE_TOKEN")
-	_, err = NewLinodeProvider(endpoint.NewDomainFilter([]string{"ext-dns-test.zalando.to."}), true, "1.0")
+	_, err = NewLinodeProvider(endpoint.NewDomainFilter([]string{"ext-dns-test.zalando.to."}), true)
 	require.Error(t, err)
 }
 

provider/ovh/ovh.go

@@ -108,7 +108,7 @@ func NewOVHProvider(ctx context.Context, domainFilter endpoint.DomainFilter, end
 		return nil, err
 	}
 
-	client.UserAgent = externaldns.Version
+	client.UserAgent = externaldns.UserAgent()
 
 	// TODO: Add Dry Run support
 	if dryRun {

provider/scaleway/scaleway.go

@@ -80,7 +80,7 @@ func NewScalewayProvider(ctx context.Context, domainFilter endpoint.DomainFilter
 	scwClient, err := scw.NewClient(
 		scw.WithProfile(p),
 		scw.WithEnv(),
-		scw.WithUserAgent("ExternalDNS/"+externaldns.Version),
+		scw.WithUserAgent(externaldns.UserAgent()),
 		scw.WithDefaultPageSize(uint32(defaultPageSize)),
 	)
 	if err != nil {