Add metadata to User-Agent header

cmd/grafana-agent/Dockerfile

@@ -47,4 +47,5 @@ COPY cmd/grafana-agent/agent-local-config.yaml /etc/agent/agent.yaml
 
 
 ENTRYPOINT ["/bin/grafana-agent"]
+ENV AGENT_DEPLOY_MODE=docker
 CMD ["--config.file=/etc/agent/agent.yaml", "--metrics.wal-directory=/etc/agent/data"]

component/common/kubernetes/kubernetes.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/go-kit/log"
 	commoncfg "github.com/grafana/agent/component/common/config"
-	"github.com/grafana/agent/pkg/build"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	promconfig "github.com/prometheus/common/config"
 	"k8s.io/client-go/rest"
@@ -79,7 +79,7 @@ func (args *ClientArguments) BuildRESTConfig(l log.Logger) (*rest.Config, error)
 		}
 	}
 
-	cfg.UserAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+	cfg.UserAgent = useragent.Get()
 	cfg.ContentType = "application/vnd.kubernetes.protobuf"
 
 	return cfg, nil

component/common/loki/client/client.go

@@ -13,14 +13,14 @@ import (
 	"time"
 
 	"github.com/go-kit/log"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	"github.com/grafana/dskit/backoff"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/common/config"
 	"github.com/prometheus/common/model"
 
 	"github.com/grafana/agent/component/common/loki"
-	"github.com/grafana/agent/pkg/build"
 	"github.com/grafana/agent/pkg/util"
 	lokiutil "github.com/grafana/loki/pkg/util"
 )
@@ -47,7 +47,7 @@ const (
 
 var Reasons = []string{ReasonGeneric, ReasonRateLimited, ReasonStreamLimited, ReasonLineTooLong}
 
-var UserAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+var userAgent = useragent.Get()
 
 type Metrics struct {
 	encodedBytes                 *prometheus.CounterVec
@@ -419,7 +419,7 @@ func (c *client) send(ctx context.Context, tenantID string, buf []byte) (int, er
 	}
 	req = req.WithContext(ctx)
 	req.Header.Set("Content-Type", contentType)
-	req.Header.Set("User-Agent", UserAgent)
+	req.Header.Set("User-Agent", userAgent)
 
 	// If the tenant ID is not empty promtail is running in multi-tenant mode, so
 	// we should send it to Loki

component/common/loki/client/queue_client.go

@@ -520,7 +520,7 @@ func (c *queueClient) send(ctx context.Context, tenantID string, buf []byte) (in
 	}
 	req = req.WithContext(ctx)
 	req.Header.Set("Content-Type", contentType)
-	req.Header.Set("User-Agent", UserAgent)
+	req.Header.Set("User-Agent", userAgent)
 
 	// If the tenant ID is not empty promtail is running in multi-tenant mode, so
 	// we should send it to Loki

component/loki/source/docker/docker.go

@@ -22,7 +22,7 @@ import (
 	flow_relabel "github.com/grafana/agent/component/common/relabel"
 	"github.com/grafana/agent/component/discovery"
 	dt "github.com/grafana/agent/component/loki/source/docker/internal/dockertarget"
-	"github.com/grafana/agent/pkg/build"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	"github.com/prometheus/common/config"
 	"github.com/prometheus/common/model"
@@ -40,7 +40,7 @@ func init() {
 	})
 }
 
-var userAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+var userAgent = useragent.Get()
 
 const (
 	dockerLabel                = model.MetaLabelPrefix + "docker_"

component/loki/write/write.go

@@ -12,7 +12,6 @@ import (
 	"github.com/grafana/agent/component/common/loki/client"
 	"github.com/grafana/agent/component/common/loki/limit"
 	"github.com/grafana/agent/component/common/loki/wal"
-	"github.com/grafana/agent/pkg/build"
 )
 
 func init() {
@@ -25,8 +24,6 @@ func init() {
 			return New(opts, args.(Arguments))
 		},
 	})
-
-	client.UserAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
 }
 
 // Arguments holds values which are used to configure the loki.write component.

component/prometheus/remotewrite/remote_write.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/go-kit/log"
 	"github.com/grafana/agent/component"
-	"github.com/grafana/agent/pkg/build"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	"github.com/grafana/agent/pkg/metrics/wal"
 	"github.com/prometheus/prometheus/model/timestamp"
@@ -35,7 +35,7 @@ import (
 var remoteFlushDeadline = 1 * time.Minute
 
 func init() {
-	remote.UserAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+	remote.UserAgent = useragent.Get()
 
 	component.Register(component.Registration{
 		Name:          "prometheus.remote_write",

component/prometheus/scrape/scrape.go

@@ -12,7 +12,7 @@ import (
 	component_config "github.com/grafana/agent/component/common/config"
 	"github.com/grafana/agent/component/discovery"
 	"github.com/grafana/agent/component/prometheus"
-	"github.com/grafana/agent/pkg/build"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	"github.com/grafana/agent/service/cluster"
 	"github.com/grafana/agent/service/http"
@@ -27,7 +27,7 @@ import (
 )
 
 func init() {
-	scrape.UserAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+	scrape.UserAgent = useragent.Get()
 
 	component.Register(component.Registration{
 		Name:          "prometheus.scrape",

component/pyroscope/scrape/scrape_loop.go

@@ -12,18 +12,17 @@ import (
 
 	"github.com/go-kit/log"
 	"github.com/grafana/agent/component/pyroscope"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	commonconfig "github.com/prometheus/common/config"
 	"github.com/prometheus/prometheus/discovery/targetgroup"
 	"github.com/prometheus/prometheus/util/pool"
 	"golang.org/x/net/context/ctxhttp"
-
-	"github.com/grafana/agent/pkg/build"
 )
 
 var (
 	payloadBuffers  = pool.New(1e3, 1e6, 3, func(sz int) interface{} { return make([]byte, 0, sz) })
-	userAgentHeader = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+	userAgentHeader = useragent.Get()
 )
 
 type scrapePool struct {

component/pyroscope/write/write.go

@@ -3,12 +3,12 @@ package write
 import (
 	"context"
 	"errors"
-	"fmt"
 	"strings"
 	"time"
 
 	"github.com/bufbuild/connect-go"
 	"github.com/grafana/agent/component/pyroscope"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	"github.com/oklog/run"
 	commonconfig "github.com/prometheus/common/config"
@@ -18,15 +18,14 @@ import (
 
 	"github.com/grafana/agent/component"
 	"github.com/grafana/agent/component/common/config"
-	"github.com/grafana/agent/pkg/build"
 	"github.com/grafana/dskit/backoff"
 	pushv1 "github.com/grafana/pyroscope/api/gen/proto/go/push/v1"
 	"github.com/grafana/pyroscope/api/gen/proto/go/push/v1/pushv1connect"
 	typesv1 "github.com/grafana/pyroscope/api/gen/proto/go/types/v1"
 )
 
 var (
-	userAgent        = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+	userAgent        = useragent.Get()
 	DefaultArguments = func() Arguments {
 		return Arguments{}
 	}

component/remote/http/http.go

@@ -13,13 +13,13 @@ import (
 	"github.com/go-kit/log"
 	"github.com/grafana/agent/component"
 	common_config "github.com/grafana/agent/component/common/config"
-	"github.com/grafana/agent/pkg/build"
+	"github.com/grafana/agent/internal/useragent"
 	"github.com/grafana/agent/pkg/flow/logging/level"
 	"github.com/grafana/river/rivertypes"
 	prom_config "github.com/prometheus/common/config"
 )
 
-var userAgent = fmt.Sprintf("GrafanaAgent/%s", build.Version)
+var userAgent = useragent.Get()
 
 func init() {
 	component.Register(component.Registration{

internal/useragent/useragent.go

@@ -0,0 +1,60 @@
+// package useragent provides a consistent way to get a user agent for outbound http requests from Grafana Agent.
+// The default User-Agent is `GrafanaAgent/$VERSION($MODE)`
+// Where version is the build version of the agent and MODE is one of "static" or "flow".
+package useragent
+
+import (
+	"fmt"
+	"os"
+	"runtime"
+	"strings"
+
+	"github.com/grafana/agent/pkg/build"
+)
+
+const (
+	deployModeEnv = "AGENT_DEPLOY_MODE"
+	modeEnv       = "AGENT_MODE"
+)
+
+// settable by tests
+var goos = runtime.GOOS
+
+func Get() string {
+	parenthesis := ""
+	metadata := []string{}
+	if mode := getRunMode(); mode != "" {
+		metadata = append(metadata, mode)
+	}
+	metadata = append(metadata, goos)
+	if op := getDeployMode(); op != "" {
+		metadata = append(metadata, op)
+	}
+	if len(metadata) > 0 {
+		parenthesis = fmt.Sprintf(" (%s)", strings.Join(metadata, "; "))
+	}
+	return fmt.Sprintf("GrafanaAgent/%s%s", build.Version, parenthesis)
+}
+
+// getRunMode attempts to get agent mode, using `unknown` for invalid values.
+func getRunMode() string {
+	key := os.Getenv(modeEnv)
+	switch key {
+	case "flow":
+		return "flow"
+	case "static", "":
+		return "static"
+	default:
+		return "unknown"
+	}
+}
+
+func getDeployMode() string {
+	op := os.Getenv(deployModeEnv)
+	// only return known modes
+	switch op {
+	case "operator", "helm", "docker", "deb", "rpm", "brew":
+		return op
+	}
+	return ""
+}

internal/useragent/useragent_test.go

@@ -0,0 +1,89 @@
+package useragent
+
+import (
+	"testing"
+
+	"github.com/grafana/agent/pkg/build"
+	"github.com/stretchr/testify/require"
+)
+
+func TestUserAgent(t *testing.T) {
+	build.Version = "v1.2.3"
+	tests := []struct {
+		Name       string
+		Mode       string
+		Expected   string
+		DeployMode string
+		GOOS       string
+	}{
+		{
+			Name:     "basic",
+			Mode:     "",
+			Expected: "GrafanaAgent/v1.2.3 (static; linux)",
+			GOOS:     "linux",
+		},
+		{
+			Name:     "flow",
+			Mode:     "flow",
+			Expected: "GrafanaAgent/v1.2.3 (flow; windows)",
+			GOOS:     "windows",
+		},
+		{
+			Name:     "static",
+			Mode:     "static",
+			Expected: "GrafanaAgent/v1.2.3 (static; darwin)",
+			GOOS:     "darwin",
+		},
+		{
+			Name: "unknown",
+			Mode: "blahlahblah",
+			// unknown mode, should not happen. But we will substitute 'unknown' to avoid allowing arbitrary cardinality.
+			Expected: "GrafanaAgent/v1.2.3 (unknown; freebsd)",
+			GOOS:     "freebsd",
+		},
+		{
+			Name:       "operator",
+			Mode:       "static",
+			DeployMode: "operator",
+			Expected:   "GrafanaAgent/v1.2.3 (static; linux; operator)",
+			GOOS:       "linux",
+		},
+		{
+			Name:       "deb",
+			Mode:       "flow",
+			DeployMode: "deb",
+			Expected:   "GrafanaAgent/v1.2.3 (flow; linux; deb)",
+			GOOS:       "linux",
+		},
+		{
+			Name:       "rpm",
+			Mode:       "static",
+			DeployMode: "rpm",
+			Expected:   "GrafanaAgent/v1.2.3 (static; linux; rpm)",
+			GOOS:       "linux",
+		},
+		{
+			Name:       "docker",
+			Mode:       "flow",
+			DeployMode: "docker",
+			Expected:   "GrafanaAgent/v1.2.3 (flow; linux; docker)",
+			GOOS:       "linux",
+		},
+		{
+			Name:       "helm",
+			Mode:       "flow",
+			DeployMode: "helm",
+			Expected:   "GrafanaAgent/v1.2.3 (flow; linux; helm)",
+			GOOS:       "linux",
+		},
+	}
+	for _, tst := range tests {
+		t.Run(tst.Name, func(t *testing.T) {
+			goos = tst.GOOS
+			t.Setenv(deployModeEnv, tst.DeployMode)
+			t.Setenv(modeEnv, tst.Mode)
+			actual := Get()
+			require.Equal(t, tst.Expected, actual)
+		})
+	}
+}

operations/helm/charts/grafana-agent/templates/containers/_agent.yaml

@@ -27,6 +27,8 @@
   env:
     - name: AGENT_MODE
       value: {{ .Values.agent.mode }}
+    - name: AGENT_DEPLOY_MODE
+      value: "helm"
     - name: HOSTNAME
       valueFrom:
         fieldRef:

operations/helm/tests/clustering/grafana-agent/templates/controllers/statefulset.yaml

@@ -41,6 +41,8 @@ spec:
           env:
             - name: AGENT_MODE
               value: flow
+            - name: AGENT_DEPLOY_MODE
+              value: "helm"
             - name: HOSTNAME
               valueFrom:
                 fieldRef:

operations/helm/tests/controller-volumes-extra/grafana-agent/templates/controllers/daemonset.yaml

@@ -36,6 +36,8 @@ spec:
           env:
             - name: AGENT_MODE
               value: flow
+            - name: AGENT_DEPLOY_MODE
+              value: "helm"
             - name: HOSTNAME
               valueFrom:
                 fieldRef:

operations/helm/tests/create-daemonset-hostnetwork/grafana-agent/templates/controllers/daemonset.yaml

@@ -36,6 +36,8 @@ spec:
           env:
             - name: AGENT_MODE
               value: flow
+            - name: AGENT_DEPLOY_MODE
+              value: "helm"
             - name: HOSTNAME
               valueFrom:
                 fieldRef: